j9九游会登录/ 统一身份认证服务 iam_统一身份认证服务（新版）/ api参考/ / / / 获取全部服务主体 - listserviceprincipalsv5
更新时间：2025-11-28 gmt 08:00
查看pdf

获取全部服务主体 -j9九游会登录

功能介绍

该接口可以用于获取全部服务主体。

调试

您可以在中调试该接口，支持自动认证鉴权。api explorer可以自动生成sdk代码示例，并提供sdk代码示例调试功能。

授权信息

当前api调用无需身份策略权限。

uri

get /v5/service-principals

表1 query参数

参数

是否必选

参数类型

描述

limit

否

integer

每页显示的条目数量，范围为1到200条，默认为100条。

最小值：1

最大值：200

缺省值：100

marker

否

string

分页标记，长度为4到400个字符，只包含字母、数字、" "、"/"、"="、"-"和"_"的字符串。

最小长度：4

最大长度：400

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-language

否

string

选择接口返回的信息的语言，可以为中文（"zh-cn"）或英文（"en-us"），默认为中文。

缺省值：zh-cn

响应参数

状态码：200

表3 响应body参数

参数

参数类型

描述

service_principals

array of serviceprincipalmetadata objects

服务主体列表。

page_info

pageinfo object

分页信息。
表4 serviceprincipalmetadata

参数

参数类型

描述

service_principal

string

服务主体，由"service."开头，后跟一个长度为1到56个字符，只包含字母、数字和"-"的字符串。

service_catalog

string

云服务名称。

最小长度：1

最大长度：64

display_name

string

用于显示的服务主体名称。

description

string

服务主体的描述。
表5 pageinfo

参数

参数类型

描述

next_marker

string

如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。

current_count

integer

本页返回条目数量。

状态码：400

表6 响应body参数

参数

参数类型

描述

error_code

string

错误码。

error_msg

string

错误信息。

请求示例

获取全部服务主体。

get https://{endpoint}/v5/service-principals

响应示例

状态码：200

请求成功。

{
  "service_principals" : [ {
    "service_principal" : "service.xxx",
    "service_catalog" : "xxx",
    "display_name" : "display_name",
    "description" : "description"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

请求成功。

400

请求体异常。

错误码

请参见错误码。

父主题：

相关文档

网站地图