调用DescribeARMServerInstances获取ARM服务器和AIC实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ens:DescribeARMServerInstances | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServerIds | array | 否 | 服务器实例 ID 列表。 | |
string | 否 | 服务器实例 ID 列表。 | cas-instance**** | |
EnsRegionIds | array | 否 | ENS 节点 ID 列表。 | |
string | 否 | ENS 节点 ID 列表。 | cn-chengdu-telecom-4 | |
PageNumber | integer | 否 | 查询列表的页码。起始值为 1。 默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数,最大值为 100 行。 默认值:10。 | 10 |
MinDate | string | 否 | 查询起始时间,格式"2006-01-02";默认无时间限制。 | 2006-01-02 |
MaxDate | string | 否 | 查询终止时间,格式"2006-01-02";默认无时间限制。 | 2006-01-03 |
States | array | 否 | 操作状态列表。 | |
string | 否 | 服务器操作状态。
| success | |
AICSpecs | array | 否 | 容器规格列表。 | |
string | 否 | 容器规格。 | aic.cf53r.c2.np | |
ServerSpecs | array | 否 | 服务器规格列表。 | |
string | 否 | 服务器规格。 | cas.cf53r | |
Name | string | 否 | 服务器名称。 | Server-Name |
Namespace | string | 否 | 命名空间。 | default |
OrderByParams | string | 否 | 查询结果排序方式,可设置按照 ServerIdSort(服务器 ID)、ServerNameSort(服务器名称)、ExpireTimeSort(到期时间)、CreationTimeSort(创建时间)、EnsRegionIdSort(节点 ID)中的一个或者多个结果排序。 取值含义:asc:升序, desc:降序。 | {"ServerIdSort":"desc","ServerNameSort":"desc","ExpireTimeSort":"asc"} |
DescribeAICInstances | boolean | 否 | 查询结果是否包含容器信息,取值:
| true |
返回参数
示例
正常返回示例
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.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
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-09-08 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-08-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-03-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-23 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |