文档

ListClusterMembers - 获取ECS实例列表

更新时间:

获取ECS实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
edas:ReadClusterRead
  • Cluster
    acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}

请求语法

GET /pop/v5/resource/cluster_member_list

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。可以调用 ListCluster 来获取,具体操作,请参见 ListCluster

52984524-6d48-4bbd-85f2-a34b0e5b****
CurrentPageinteger

分页查询时,当前显示的页面数,不设置的情况下默认显示第 1 页。

1
PageSizeinteger

分页查询时,若不设置,则显示该集群的所有 ECS 列表;若设置,则按照设置的 pagesize 来分页显示 ECS 列表。

50
EcsListstring

ECS 列表实例数。

1

返回参数

名称类型描述示例值
object

接口响应。

Codeinteger

接口状态码。

200
Messagestring

返回信息。

success
RequestIdstring

唯一请求 ID。

b197-40ab-9155-****
ClusterMemberPageobject

集群中包含的 ECS 实例页面。

CurrentPageinteger

分页查询时,当前显示的页面数,不设置的情况下默认显示第 1 页。

1
PageSizeinteger

所有实例分页显示的页面数。

10
TotalSizeinteger

所有的 ECS 实例按照 PageSize 的大小进行分页显示时,总的显示页数。

5
ClusterMemberListobject []

集群中包含的实例列表。

Statusinteger

实例状态:

  • 1:表示运行中。
  • 0:表示转化中。
  • -1:表示转化失败。
  • -2:表示离线。
1
UpdateTimelong

更新时间的时间戳。

1573281041113
EcuIdstring

这台 ECU 的唯一标示 ID,可以通过在 ECS 上执行dmidecode获取。

70ed3f59-b476-49aa-be09-9e6c375d****
EcsIdstring

ECS ID。

i-2zej4i2jdf3ntwhj****
CreateTimelong

创建时间的时间戳。

1573281038175
ClusterMemberIdstring

实例集群 ID。

adb03eeb-3adf-4d7e-afe1-03d1ad45****
ClusterIdstring

集群 ID。

52984524-6d48-4bbd-85f2-a34b0e5b****
PrivateIpstring

ECS 私网 IP

172.16.XXX.XXX

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "ClusterMemberPage": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalSize": 5,
    "ClusterMemberList": {
      "ClusterMember": [
        {
          "Status": 1,
          "UpdateTime": 1573281041113,
          "EcuId": "70ed3f59-b476-49aa-be09-9e6c375d****",
          "EcsId": "i-2zej4i2jdf3ntwhj****",
          "CreateTime": 1573281038175,
          "ClusterMemberId": "adb03eeb-3adf-4d7e-afe1-03d1ad45****",
          "ClusterId": "52984524-6d48-4bbd-85f2-a34b0e5b****",
          "PrivateIp": "172.16.XXX.XXX"
        }
      ]
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈