All Products
Search
Document Center

ENS:DescribeARMServerInstances

Last Updated:Nov 18, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeARMServerInstanceslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServerIdsarrayNo

The IDs of the ARM servers.

stringNo

The ID of the ARM server.

cas-instance****
EnsRegionIdsarrayNo

The IDs of the Edge Node Service (ENS) nodes.

stringNo

The ID of the ENS node.

cn-chengdu-telecom-4
PageNumberintegerNo

The page number. Pages start from page 1.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page. The maximum value is 100.

Default value: 10.

10
MinDatestringNo

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
MaxDatestringNo

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
StatesarrayNo

The operation statuses.

stringNo

The operation status of the server. Valid values:

  • success
  • failed
  • creating
  • releasing
  • rebooting
  • upgrading
success
AICSpecsarrayNo

The container specifications.

stringNo

The container specification.

aic.cf53r.c2.np
ServerSpecsarrayNo

The server specifications.

stringNo

The server specification.

cas.cf53r
NamestringNo

The name of the server.

Server-Name
NamespacestringNo

The namespace.

default
OrderByParamsstringNo

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"}
DescribeAICInstancesbooleanNo

Spcifies whether the result contains the container information. Valid values:

  • true
  • false
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4EC47282-1B74-4534-BD0E-403F3EE64CAF
Serversarray<object>

The information about the servers and the AIC instances.

Serversobject
CreationTimestring

The time when the instance was created.

2022-05-07 11:59:09
ExpiredTimestring

The time when the instance expires.

2027-05-07 11:59:09
AICInstancesarray<object>

The information about the AIC instances.

AICInstancesobject
Frequencylong

The refresh rate of the AIC instance. Unit: Hz.

120
ImageIdstring

The ID of the AIC image.

m-****
InstanceIdstring

The ID of the AIC instance.

aic-instance****
NetworkAttributesobject

The network attributes of the AIC instance.

IpAddressstring

The IP address of the AIC instance.

192.168.XX.XX
NetworkIdstring

The network ID of the AIC instance.

n-*****
VSwitchIdstring

The vSwitch ID of the AIC instance.

vsw-****
SdgDeployInfoobject

The information about the shared data group (SDG) that is deployed on the AIC instance.

SDGIdstring

The ID of the SDG.

sdg-xxxxx
Statusstring

The deployment status of the SDG. Valid values:

  • sdg_deploying
  • failed
  • success
success
Resolutionstring

The resolution of the AIC instance.

1920*1080
Specstring

The specification of the AIC instance.

aic.cf53r.c2.np
Statestring

The operation status of the AIC instance. Valid values:

  • success
  • failed
  • creating
  • releasing
  • rebooting
  • reseting
success
Statusstring

The running status of the AIC instance. Valid values:

  • running
  • pending
  • terminating
running
Namestring

The name of the container.

AIC-Name
LatestActionstring

The operation that was most recently performed.

ServerCreate
EnsRegionIdstring

The ID of the ENS node.

cn-hanghzou-27
ServerIdstring

The ID of the server.

cas-******
SpecNamestring

The server specification.

cas.cf53r
Statestring

The operation status of the server. Valid values:

  • success
  • failed
  • creating
  • releasing
  • rebooting
  • upgrading
success
Statusstring

The running status of the server. Valid values:

  • running
  • stopping
  • down
  • starting
running
Namespacestring

The namespace of the cluster to which the server belongs.

default
Namestring

The name of the server.

Server-Name
PayTypestring

The billing method.

prepay
LatestActionstring

The operation that was most recently performed.

ServerCreate
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

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.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 codeError codeError message
400Parameter.InvalidThe parameter is invalid.Please check your parameters and try it again.
400Interface.Call.ErrorThe interface call error
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-11-14The Error code has changedView Change Details
2023-09-08The Error code has changed. The response structure of the API has changedView Change Details
2023-08-09The Error code has changed. The request parameters of the API has changedView Change Details
2023-05-09The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-03-28The Error code has changedView Change Details
2023-03-23The Error code has changed. The response structure of the API has changedView Change Details