Queries a list of instances in a dedicated resource group.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| eas:ListResourceInstances | get | *Resource acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId} |
| none |
Request syntax
GET /api/v2/resources/{ClusterId}/{ResourceId}/instances HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ClusterId | string | Yes | The ID of the region to which the resource group belongs. | cn-shanghai |
| ResourceId | string | Yes | The ID of the resource group. For more information about how to query the ID of a resource group, see ListResources . | iot |
| ChargeType | string | No | The billing method of the instance. Valid values:
| PrePaid |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Default value: 100. | 20 |
| InstanceName | string | No | The instance name. | e-xxxx*** |
| InstanceId | string | No | The instance ID. For more information about how to query the instance ID, see ListResourceInstances . | i-bp1jd6x3uotsv**** |
| InstanceIP | string | No | The IP address of the instance. | 10.224.xx.xx |
| Filter | string | No | The keyword used to query instances. Instances can be queried by instance ID or instance IP address. | 10.224.xx.xx |
| InstanceStatus | string | No | The instance state. Valid values:
| Ready |
| Sort | string | No | The field that you use to sort the query results. Valid values:
| CreateTime |
| Order | string | No | The sorting order. Valid values:
| desc |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "40325405-579C-4D82****",
"Instances": [
{
"InstanceId": "eas-i-1800z74n30kao****",
"InstanceName": "eas01122713204*****",
"InstanceIp": "11.227.XX.XX",
"InstanceStatus": "Ready",
"InstanceCpuCount": 4,
"InstanceGpuCount": 0,
"InstanceMemory": "8192M",
"InstanceSystemDiskSize": 200,
"InstanceGpuMemory": "0G",
"InstanceUsedCpu": 2.4,
"InstanceUsedGpu": 0,
"InstanceUsedMemory": "1000M",
"InstanceType": "ecs.s6-c1m2.xlarge",
"CreateTime": "2020-07-05T22:51:32Z",
"ChargeType": "PrePaid",
"ExpiredTime": "2020-08-05T22:51:32Z",
"AutoRenewal": false,
"Arch": "arm64",
"Region": "cn-hangzhou",
"Zone": "cn-hangzhou-b",
"ResourceId": "eas-r-xxxxx",
"InstanceTenantIp": "192.168.xx.xx",
"InstanceUsedGpuMemory": "470M"
}
],
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 2
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-05-06 | The request parameters of the API has changed | View Change Details |
| 2022-11-29 | The request parameters of the API has changed | View Change Details |