ListClusterMembers - Enterprise Distributed Application Service

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

edas:ReadCluster

get

*Cluster

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}

None

Request syntax

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

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 elements

Element	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
ClusterMember	array<object>	The list of ECS instances in the cluster.
	object	The information about 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	integer	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	integer	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.XXX.XXX

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.