ListClusterMembers - Enterprise Distributed Application Service

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadCluster	Read	Cluster acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}	none	none

Request syntax

GET /pop/v5/resource/cluster_member_list

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the cluster. You can call the ListCluster operation to query the cluster ID. For more information, see ListCluster .	52984524-6d48-4bbd-85f2-a34b0e5b****
CurrentPage	integer	No	The number of the page to return. If you do not specify this parameter, the first page is returned.	1
PageSize	integer	No	The number of ECS instances to return on each page. If you do not specify this parameter, all ECS instances in the specified cluster are returned on one page.	50
EcsList	string	No	The number of ECS instances.	1

Response parameters

Parameter	Type	Description	Example
	object	The content that is returned.
Code	integer	The HTTP status code that is returned.	200
Message	string	The message that is returned.	success
RequestId	string	The ID of the request.	b197-40ab-9155-****
ClusterMemberPage	object	The information about the ECS instances in the cluster.
CurrentPage	integer	The page number of the returned page. If this parameter is not returned, the first page is returned.	1
PageSize	integer	The number of ECS instances returned per page.	10
TotalSize	integer	The total number of pages returned when all ECS instances are returned based on the specified PageSize parameter.	5
ClusterMemberList	object []	The list of ECS instances in the cluster.
Status	integer	The state of the ECS instance. Valid values: 1: The instance is running. 0: The instance is being converted. -1: The instance fails to be converted. -2: The instance is offline.	1
UpdateTime	long	The timestamp when the ECS instance was updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1573281041113
EcuId	string	The unique ID of the elastic compute unit (ECU). You can run the `dmidecode` command on the ECS instance to query the ECU ID.	70ed3f59-b476-49aa-be09-9e6c375d****
EcsId	string	The ID of the ECS instance.	i-2zej4i2jdf3ntwhj****
CreateTime	long	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.	1573281038175
ClusterMemberId	string	The ID of the ECS instance in the cluster.	adb03eeb-3adf-4d7e-afe1-03d1ad45****
ClusterId	string	The ID of the cluster.	52984524-6d48-4bbd-85f2-a34b0e5b****
PrivateIp	string	The private IP address for the ECS instance.	172.16.XX.XX

Examples

Sample success responses

JSONformat

{
  "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.XX.XX"
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2022-11-07

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.