DescribeARMServerInstances - ENS - Alibaba Cloud Documentation Center

Queries information about ARM servers and Android in Container (AIC) instances.

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
ens:DescribeARMServerInstances	get	All Resources *	none	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 per page. The maximum value is 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 failed creating releasing rebooting upgrading	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 false	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
Servers	array<object>	The information about the servers and the AIC instances.
	object
CreationTime	string	The time when the instance was created.	2022-05-07 11:59:09
ExpiredTime	string	The time when the instance expires.	2027-05-07 11:59:09
AICInstances	array<object>	The information about the AIC instances.
	object
Frequency	long	The refresh rate of the AIC instance. Unit: Hz.	120
ImageId	string	The ID of the AIC image.	m-****
InstanceId	string	The ID of the AIC instance.	aic-instance****
NetworkAttributes	object	The network attributes of the AIC instance.
IpAddress	string	The IP address of the AIC instance.	192.168.1.1
NetworkId	string	The network ID of the AIC instance.	n-*****
VSwitchId	string	The vSwitch ID of the AIC instance.	vsw-****
SdgDeployInfo	object	The information about the shared data group (SDG) that is deployed on the AIC instance.
SDGId	string	The ID of the SDG.	sdg-xxxxx
Status	string	The deployment status of the SDG. Valid values: sdg_deploying failed success	success
Resolution	string	The resolution of the AIC instance.	1920*1080
Spec	string	The specification of the AIC instance.	aic.cf53r.c2.np
State	string	The operation status of the AIC instance. Valid values: success failed creating releasing rebooting reseting	success
Status	string	The running status of the AIC instance. Valid values: running pending terminating	running
Name	string	The name of the container.	AIC-Name
LatestAction	string	The operation that was most recently performed.	ServerCreate
EnsRegionId	string	The ID of the ENS node.	cn-hanghzou-27
ServerId	string	The ID of the server.	cas-******
SpecName	string	The server specification.	cas.cf53r
State	string	The operation status of the server. Valid values: success failed creating releasing rebooting upgrading	success
Status	string	The running status of the server. Valid values: running stopping down starting	running
Namespace	string	The namespace of the cluster to which the server belongs.	default
Name	string	The name of the server.	Server-Name
PayType	string	The billing method.	prepay
LatestAction	string	The operation that was most recently performed.	ServerCreate
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	2

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.1.1",
            "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
400	Parameter.Invalid	The parameter is invalid.Please check your parameters and try it again.
400	Interface.Call.Error	The interface call error
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
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