Queries information about ARM servers and Android in Container (AIC) instances.
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:
- For mandatory resource types, indicate with a prefix of * .
- 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 |
|---|---|---|---|---|
| ens:DescribeARMServerInstances | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ServerIds | array | No | The IDs of the ARM servers. | |
| string | No | The ID of the ARM server. | cas-instance**** | |
| EnsRegionIds | array | No | The IDs of the Edge Node Service (ENS) nodes. | |
| string | No | The ID of the ENS node. | cn-chengdu-telecom-4 | |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Maximum value: 100. Default value: 10. | 10 |
| MinDate | string | No | The beginning of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted. | 2006-01-02 |
| MaxDate | string | No | The end of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted. | 2006-01-03 |
| States | array | No | The operation statuses. | |
| string | No | The operation status of the server. Valid values:
| success | |
| AICSpecs | array | No | The container specifications. | |
| string | No | The container specification. | aic.cf53r.c2.np | |
| ServerSpecs | array | No | The server specifications. | |
| string | No | The server specification. | cas.cf53r | |
| Name | string | No | The name of the server. | Server-Name |
| Namespace | string | No | The namespace. | default |
| OrderByParams | string | No | The sorting order of the results to return. Valid values: ServerIdSort, ServerNameSort, ExpireTimeSort, CreationTimeSort, and EnsRegionIdSort. asc: ascending order. desc: descending order. | {"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc","CreationTimeSort":"asc","EnsRegionIdSort":"asc"} |
| DescribeAICInstances | boolean | No | Spcifies whether the result contains the container information. Valid values:
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
"Servers": [
{
"CreationTime": "2022-05-07 11:59:09",
"ExpiredTime": "2027-05-07 11:59:09",
"AICInstances": [
{
"Frequency": 120,
"ImageId": "m-****",
"InstanceId": "aic-instance****",
"NetworkAttributes": {
"IpAddress": "192.168.XX.XX",
"NetworkId": "n-*****",
"VSwitchId": "vsw-****"
},
"SdgDeployInfo": {
"SDGId": "sdg-xxxxx",
"Status": "success"
},
"Resolution": "1920*1080",
"Spec": "aic.cf53r.c2.np",
"State": "success",
"Status": "running",
"Name": "AIC-Name",
"LatestAction": "ServerCreate"
}
],
"EnsRegionId": "cn-hanghzou-27",
"ServerId": "cas-******",
"SpecName": "cas.cf53r",
"State": "success",
"Status": "running",
"Namespace": "default",
"Name": "Server-Name",
"PayType": "prepay",
"LatestAction": "ServerCreate"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Parameter.Invalid | This service has not been activated. | This product service has not been activated |
| 400 | Interface.Call.Error | The interface call error | - |
| 400 | Parameter.Invalid | The parameter is invalid. Please check your parameters and try it again. | The parameter is invalid. |
| 400 | Interface.Call.Failed | %s. | Request failed |
| 400 | NoPermission | Permission denied. | - |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-14 | The Error code has changed | View Change Details |
| 2023-09-08 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-08-09 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-05-09 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-03-28 | The Error code has changed | View Change Details |
| 2023-03-23 | The Error code has changed. The response structure of the API has changed | View Change Details |
