DescribeARMServerInstances API reference - ENS

Obtain information about ARM servers and AIC instances.

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

ens:DescribeARMServerInstances

list

*All Resource

*

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 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
Tags	array<object>	No	List of tags
	object	No
Key	string	No	tag key	key-1
Value	string	No	tag value	value-1
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"}
DescribeAICInstances	boolean	No	Spcifies whether the result contains the container information. Valid values: true false	true

Response elements

Element	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.
	array<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.
	array<object>
Frequency	integer	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.XX.XX
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
Tags	array<object>	Tag collection.
	object	Tag.
Key	string	Tag key.	key-1
Value	string	Tag value.	value-1
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

Success response

JSON format

{
  "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",
      "Tags": [
        {
          "Key": "key-1",
          "Value": "value-1"
        }
      ]
    }
  ],
  "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	Interface.Call.Failed	%s.	Request failed
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.