Queries Elastic Compute Service (ECS) instances in a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only the common request header. For more information, see the topic about common request parameters.

Request syntax

GET /pop/v5/resource/cluster_member_list HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
ClusterId String Query Yes 52984524-6d48-4bbd-85f2-a34b0e5b****

The ID of the cluster. You can call the ListCluster operation to query the cluster ID. For more information, see ListCluster.

CurrentPage Integer Query No 1

The number of the page to return. If you do not specify this parameter, the first page is returned.

PageSize Integer Query No 50

The number of ECS instances to return on each page. If you do not specify this parameter, all ECS instances in the cluster are returned on one page.

EcsList String Query No 1

The number of ECS instance lists.

Response parameters

Parameter Type Example Description
ClusterMemberPage Struct

The information about the ECS instances in the cluster.

ClusterMemberList Array of ClusterMember

The list of ECS instances in the cluster.

ClusterMember
ClusterId String 52984524-6d48-4bbd-85f2-a34b0e5b****

The ID of the cluster.

ClusterMemberId String adb03eeb-3adf-4d7e-afe1-03d1ad45****

The ID of the ECS instance in the cluster.

CreateTime Long 1573281038175

The timestamp when the ECS instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

EcsId String i-2zej4i2jdf3ntwhj****

The ID of the ECS instance.

EcuId String 70ed3f59-b476-49aa-be09-9e6c375d****

The unique ID of the elastic compute unit (ECU). You can run the dmidecode command on the ECS instance to query the ECU ID.

Status Integer 1

The status of the ECS instance.

  • 1: The instance is running.
  • 0: The instance is being converted.
  • -1: The conversion failed.
  • -2: The instance is offline.
UpdateTime Long 1573281041113

The timestamp when the ECS instance was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

CurrentPage Integer 1

The page number of the returned page. If this parameter is not returned, the first page is returned.

PageSize Integer 10

The number of ECS instances returned per page.

TotalSize Integer 5

The total number of pages returned when all ECS instances are returned based on the specified PageSize parameter.

Code Integer 200

The HTTP status code.

Message String success

The returned message that indicates whether the request is successful.

RequestId String b197-40ab-9155-****

The unique ID of the request.

Examples

Sample requests

GET /pop/v5/resource/cluster_member_list HTTP/1.1
Common request header
{
"ClusterId": "52984524-6d48-4bbd-85f2-a34b0e5b****"
}

Sample success responses

XML format

<ListClusterMembersResponse>
  <Message>success</Message>
  <RequestId>b197-40ab-9155-****</RequestId>
  <ClusterMemberPage>
        <ClusterMemberList>
              <ClusterMember>
                    <Status>1</Status>
                    <ClusterId>52984524-6d48-4bbd-85f2-a34b0e5b****</ClusterId>
                    <CreateTime>1573281038175</CreateTime>
                    <UpdateTime>1573281041113</UpdateTime>
                    <EcuId>70ed3f59-b476-49aa-be09-9e6c375d****</EcuId>
                    <ClusterMemberId>adb03eeb-3adf-4d7e-afe1-03d1ad45****</ClusterMemberId>
                    <EcsId>i-2zej4i2jdf3ntwhj****</EcsId>
              </ClusterMember>
        </ClusterMemberList>
        <PageSize>10</PageSize>
        <CurrentPage>1</CurrentPage>
        <TotalSize>5</TotalSize>
  </ClusterMemberPage>
  <Code>200</Code>
</ListClusterMembersResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.