文档

DescribeARMServerInstances - 获取ARM服务器和AIC实例信息

更新时间:
一键部署

调用DescribeARMServerInstances获取ARM服务器和AIC实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeARMServerInstancesRead
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
ServerIdsarray

服务器实例 ID 列表。

string

服务器实例 ID 列表。

cas-instance****
EnsRegionIdsarray

ENS 节点 ID 列表。

string

ENS 节点 ID 列表。

cn-chengdu-telecom-4
PageNumberinteger

查询列表的页码。起始值为 1

默认值:1

1
PageSizeinteger

分页查询时设置的每页行数,最大值为 100 行。

默认值:10

10
MinDatestring

查询起始时间,格式"2006-01-02";默认无时间限制。

2006-01-02
MaxDatestring

查询终止时间,格式"2006-01-02";默认无时间限制。

2006-01-03
Statesarray

操作状态列表。

string

服务器操作状态。

  • success:成功。

  • failed:失败。

  • creating:创建中。

  • releasing:释放中。

  • rebooting:重启中。

  • upgrading:升级中。

success
AICSpecsarray

容器规格列表。

string

容器规格。

aic.cf53r.c2.np
ServerSpecsarray

服务器规格列表。

string

服务器规格。

cas.cf53r
Namestring

服务器名称。

Server-Name
Namespacestring

命名空间。

default
OrderByParamsstring

查询结果排序方式,可设置按照 ServerIdSort(服务器 ID)、ServerNameSort(服务器名称)、ExpireTimeSort(到期时间)、CreationTimeSort(创建时间)、EnsRegionIdSort(节点 ID)中的一个或者多个结果排序。

取值含义:asc:升序, desc:降序。

{"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"}
DescribeAICInstancesboolean

查询结果是否包含容器信息,取值:

  • true:包含。

  • false:不包含。

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

4EC47282-1B74-4534-BD0E-403F3EE64CAF
Serversobject []

由服务器和 AIC 实例信息组成的数组。

CreationTimestring

实例创建时间。

2022-05-07 11:59:09
ExpiredTimestring

实例过期时间。

2027-05-07 11:59:09
AICInstancesobject []

AIC 实例信息组成的数组。

Frequencylong

AIC 实例刷新率,单位 Hz。

120
ImageIdstring

AIC 镜像 ID。

m-****
InstanceIdstring

AIC 实例 ID。

aic-instance****
NetworkAttributesobject

网络属性。

IpAddressstring

AIC 实例 IP 地址。

192.168.1.1
NetworkIdstring

AIC 实例网络 ID。

n-*****
VSwitchIdstring

AIC 实例交换机 ID。

vsw-****
SdgDeployInfoobject

实例上部署的共享数据集(SDG)信息。

SDGIdstring

SDG 的 ID。

sdg-xxxxx
Statusstring

SDG 的部署状态,取值:

  • sdg_deploying:部署中。

  • failed:部署失败。

  • success:部署成功。

success
Resolutionstring

AIC 实例分辨率。

1920*1080
Specstring

AIC 实例规格。

aic.cf53r.c2.np
Statestring

AIC 实例操作状态。

  • success:成功。
  • failed:失败。
  • creating:创建中。
  • releasing:释放中。
  • rebooting:重启中。
  • reseting:重置中。
success
Statusstring

AIC 实例运行状态。

  • running:运行中。
  • pending:等待中。
  • terminating:终止中。
running
Namestring

容器名称。

AIC-Name
LatestActionstring

最近一次操作。

ServerCreate
EnsRegionIdstring

ENS 节点 ID。

cn-hanghzou-27
ServerIdstring

服务器 ID。

cas-******
SpecNamestring

服务器规格。

cas.cf53r
Statestring

服务器操作状态。

  • success:成功。
  • failed:失败。
  • creating:创建中。
  • releasing:释放中。
  • rebooting:重启中。
  • upgrading:升级中。
success
Statusstring

服务器运行状态。

  • running:运行中。
  • stopping:停止中。
  • down:关机。
  • starting:启动中。
running
Namespacestring

板卡所属集群 Namespace 名称。

default
Namestring

服务器名称。

Server-Name
PayTypestring

付费方式。

prepay
LatestActionstring

最近一次操作。

ServerCreate
PageNumberinteger

实例列表的页码。

1
PageSizeinteger

输入时设置的每页行数。

10
TotalCountinteger

查询到的实例总数。

2

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
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.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-08-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    删除入参:LatestAction
2023-05-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:MinDate
    新增入参:MaxDate
    新增入参:States
    新增入参:AICSpecs
    新增入参:ServerSpecs
    新增入参:Name
    新增入参:Namespace
    新增入参:OrderByParams
    新增入参:DescribeAICInstances
    新增入参:LatestAction
出参OpenAPI 返回结构发生变更
2023-03-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-03-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈