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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeARMServerInstances	系统规定参数。取值：DescribeARMServerInstances。
ServerIds	Array of String	否	cas-instance****	服务器实例ID列表。
EnsRegionIds	Array of String	否	cn-chengdu-telecom-4	ENS节点ID列表。
PageNumber	Integer	否	1	查询列表的页码。起始值为1。默认值：1。
PageSize	Integer	否	10	分页查询时设置的每页行数，最大值为100行。默认值：10。
MinDate	String	否	2006-01-02	查询起始时间，格式"2006-01-02"；默认无时间限制。
MaxDate	String	否	2006-01-03	查询终止时间，格式"2006-01-02"；默认无时间限制。
States	Array of String	否	success	服务器操作状态。 success：成功。 failed：失败。 creating：创建中。 releasing：释放中。 rebooting：重启中。 upgrading：升级中。
AICSpecs	Array of String	否	aic.cf53r.c2.np	容器规格。
ServerSpecs	Array of String	否	cas.cf53r	服务器规格。
Name	String	否	Server-Name	服务器名称。
Namespace	String	否	default	命名空间。
OrderByParams	String	否	{"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"}	查询结果排序方式，可设置按照ServerIdSort（服务器ID）、ServerNameSort（服务器名称）、ExpireTimeSort（到期时间）、CreationTimeSort（创建时间）、EnsRegionIdSort（节点ID）中的一个或者多个结果排序。取值含义：asc：升序， desc：降序。
DescribeAICInstances	Boolean	否	true	查询结果是否包含容器信息，取值： true：包含。 false：不包含。

返回数据

名称	类型	示例值	描述
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	请求ID。
Servers	Array of Servers		由服务器和AIC实例信息组成的数组。
CreationTime	String	2022-05-07 11:59:09	实例创建时间。
ExpiredTime	String	2027-05-07 11:59:09	实例过期时间。
AICInstances	Array of AICInstances		AIC实例信息组成的数组。
Frequency	Long	120	AIC实例刷新率，单位Hz。
ImageId	String	m-****	AIC镜像ID。
InstanceId	String	aic-instance****	AIC实例ID。
NetworkAttributes	Object		网络属性。
IpAddress	String	192.168.1.1	AIC实例IP地址。
NetworkId	String	n-*****	AIC实例网络ID。
VSwitchId	String	vsw-****	AIC实例交换机ID。
SdgDeployInfo	Object		实例上部署的共享数据集（SDG）信息。
SDGId	String	sdg-xxxxx	SDG的ID。
Status	String	success	SDG的部署状态，取值： sdg_deploying：部署中。 failed：部署失败。 success：部署成功。
Resolution	String	1920*1080	AIC实例分辨率。
Spec	String	aic.cf53r.c2.np	AIC实例规格。
State	String	success	AIC实例操作状态。 success：成功。 failed：失败。 creating：创建中。 releasing：释放中。 rebooting：重启中。 reseting：重置中。
Status	String	running	AIC实例运行状态。 running：运行中。 pending：等待中。 terminating：终止中。
Name	String	AIC-Name	容器名称。
LatestAction	String	ServerCreate	最近一次操作。
EnsRegionId	String	cn-hanghzou-27	ENS节点ID。
ServerId	String	cas-******	服务器ID。
SpecName	String	cas.cf53r	服务器规格。
State	String	success	服务器操作状态。 success：成功。 failed：失败。 creating：创建中。 releasing：释放中。 rebooting：重启中。 upgrading：升级中。
Status	String	running	服务器运行状态。 running：运行中。 stopping：停止中。 down：关机。 starting：启动中。
Namespace	String	default	板卡所属集群Namespace名称。
Name	String	Server-Name	服务器名称。
PayType	String	prepay	付费方式。
LatestAction	String	ServerCreate	最近一次操作。
PageNumber	Integer	1	实例列表的页码。
PageSize	Integer	10	输入时设置的每页行数。
TotalCount	Integer	2	查询到的实例总数。

示例

请求示例

http(s)://ens.aliyuncs.com/?Action=DescribeARMServerInstances
&ServerIds=["cas-instance****"]
&EnsRegionIds=["cn-chengdu-telecom-4"]
&PageNumber=1
&PageSize=10
&MinDate=2006-01-02
&MaxDate=2006-01-03
&States=["success"]
&AICSpecs=["aic.cf53r.c2.np"]
&ServerSpecs=["cas.cf53r"]
&Name=Server-Name
&Namespace=default
&OrderByParams={"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"}
&DescribeAICInstances=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeARMServerInstancesResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <Servers>
        <CreationTime>2022-05-07 11:59:09</CreationTime>
        <ExpiredTime>2027-05-07 11:59:09</ExpiredTime>
        <AICInstances>
            <Frequency>120</Frequency>
            <ImageId>m-****</ImageId>
            <InstanceId>aic-instance****</InstanceId>
            <NetworkAttributes>
                <IpAddress>192.168.1.1</IpAddress>
                <NetworkId>n-*****</NetworkId>
                <VSwitchId>vsw-****</VSwitchId>
            </NetworkAttributes>
            <SdgDeployInfo>
                <SDGId>sdg-xxxxx</SDGId>
                <Status>success</Status>
            </SdgDeployInfo>
            <Resolution>1920*1080</Resolution>
            <Spec>aic.cf53r.c2.np</Spec>
            <State>success</State>
            <Status>running</Status>
            <Name>AIC-Name</Name>
            <LatestAction>ServerCreate</LatestAction>
        </AICInstances>
        <EnsRegionId>cn-hanghzou-27</EnsRegionId>
        <ServerId>cas-******</ServerId>
        <SpecName>cas.cf53r</SpecName>
        <State>success</State>
        <Status>running</Status>
        <Namespace>default</Namespace>
        <Name>Server-Name</Name>
        <PayType>prepay</PayType>
        <LatestAction>ServerCreate</LatestAction>
    </Servers>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>2</TotalCount>
</DescribeARMServerInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
}

错误码

HttpCode	错误码	错误信息	描述
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.	没有足够的权限，请联系云账号管理员授予您相应权限。

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