获取全部服务主体
功能介绍
该接口可以用于获取全部服务主体。
URI
GET /v5/service-principals
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
每页显示的条目数量，范围为1到200条，默认为100条。 最小值：1 最大值：200 缺省值：100 |
|
marker |
否 |
String |
分页标记，长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。 最小长度：4 最大长度：400 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Language |
否 |
String |
选择接口返回的信息的语言，可以为中文（"zh-cn"）或英文（"en-us"），默认为中文。 缺省值：zh-cn |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
service_principals |
Array of ServicePrincipalMetadata objects |
服务主体列表。 |
|
page_info |
PageInfo object |
分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
service_principal |
String |
服务主体，由"service."开头，后跟一个长度为1到56个字符，只包含字母、数字和"-"的字符串。 |
|
service_catalog |
String |
云服务名称。 最小长度：1 最大长度：64 |
|
display_name |
String |
用于显示的服务主体名称。 |
|
description |
String |
服务主体的描述。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
next_marker |
String |
如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。 |
|
current_count |
Integer |
本页返回条目数量。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
请求体异常。 |
错误码
请参见错误码。
