文档首页/ IAM 身份中心/ API参考/ API/ 实例管理/ 列出实例
更新时间：2024-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

列出实例

功能介绍

查询IAM身份中心的实例列表。

URI

GET /v1/instances

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每个请求返回的最大结果数。

最小值：1

最大值：100

缺省值：100

marker

否

String

分页标记。

最小长度：24

最大长度：24

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

最大长度：2048

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

instances

Array of objects

IAM身份中心实例信息列表。

page_info

Object

包含分页信息的对象。
表4 instances

参数

参数类型

描述

identity_store_id

String

关联到IAM身份中心实例的身份源的全局唯一标识符（ID）。

最小长度：1

最大长度：64

instance_id

String

IAM身份中心实例的全局唯一标识符（ID）。

最小长度：20

最大长度：20

alias

String

用户为身份源标识符定义的别名。

instance_urn

String

实例的统一资源名称（URN）。
表5 page_info

参数

参数类型

描述

next_marker

String

如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求唯一标识。

状态码： 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求唯一标识。

请求示例

查询IAM身份中心的实例列表。

GET https://{hostname}/v1/instances

响应示例

状态码： 200

Successful

{
  "instances" : [ {
    "identity_store_id" : "d-a00aaaa33f",
    "alias" : "new-store-id-123",
    "instance_id" : "ins-bd8baaaaaaaade60"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理

相关文档