获取全部服务主体 - ListServicePrincipalsV5

功能介绍

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

调试

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

授权信息

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

URI

GET /v5/service-principals

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：每页显示的条目数量。约束限制：不涉及。取值范围：取值范围为[1,200]。默认取值：默认为100。
marker	否	String	参数解释：服务内部自动生成的分页标记，用于标记本次请求的起始位置，可从上一次分页请求响应体的next_marker获得。约束限制：长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Language	否	String	参数解释：选择接口返回的信息的语言。约束限制：不涉及。取值范围：中文（"zh-cn"）或英文（"en-us"）。默认取值：默认为中文（"zh-cn"）。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
service_principals	Array of service_principals objects	参数解释：服务主体列表。取值范围：不涉及。
page_info	page_info object	参数解释：分页信息。取值范围：不涉及。

表4 service_principals
参数	参数类型	描述
service_principal	String	参数解释：服务主体。取值范围：不涉及。
service_catalog	String	参数解释：云服务名称。取值范围：不涉及。
display_name	String	参数解释：用于显示的服务主体名称。取值范围：不涉及。
description	String	参数解释：服务主体的描述。取值范围：不涉及。

表5 page_info
参数	参数类型	描述
next_marker	String	参数解释：下一次分页调用的起始位置标记，由服务自动生成。取值范围：不涉及。
current_count	Integer	参数解释：本页返回条目数量。取值范围：不涉及。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码，请参见错误码。取值范围：格式为PAP5.XXXX，例如 PAP5.0012。
error_msg	String	参数解释：错误信息，请参见错误信息。取值范围：不涉及。
request_id	String	参数解释： API 请求的唯一标识，用于排查接口调用异常。取值范围：不涉及。

请求示例

获取全部服务主体。

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
  }
}