调用DescribeInstances查询一台或多台实例的详细信息。
请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数InstanceIds如果是一个空JSON数组,则视为该过滤器有效,且返回空。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstances |
系统规定参数,取值:DescribeInstances。 |
Version | String | 是 | 2017-11-10 |
版本号。 |
EnsRegionId | String | 否 | cn-beijing-cmcc |
地域ID。 |
InstanceId | String | 否 | i-5iqczfxps7csjrxeca**** |
实例ID。 |
EnsRegionIds | String | 否 | ["cn-suzhou-telecom","cn-chengdu-telecom"] |
节点的编号列表。参数为一个带有格式的JSON数组,最多100个ID,用逗号(,)隔开。 |
InstanceIds | String | 否 | ["i-5iqczfxps7csjrxeca07****", "i-5iqczfxps7csjrxeca07****"]] |
实例的编号列表。参数为一个带有格式的JSON数组,最多100个ID,用逗号(,)隔开。 |
InstanceName | String | 否 | TestName |
实例名称。 |
ImageId | String | 否 | centos_6_08_64_20G_alibase_**** |
镜像ID。 |
PageNumber | Integer | 否 | 1 |
实例状态列表的页码,起始值为1。 默认值:1。 |
PageSize | String | 否 | 10 |
分页查询时设置的每页行数,最大值为100行。 默认值:10。 |
Status | String | 否 | Running |
实例状态。
|
OrderByParams | String | 否 | {"InstanceNameSort":"asc","ExpireTimeSort":"asc","CreationTimeSort":"desc"}} |
排序参数,JSON格式。 按照实例名称、到期时间、节点ID、创建时间排序,可以组合使用。 |
EnsServiceId | String | 否 | ens-20190730202316s**** |
边缘服务ID,可按此ID查询边缘服务下所创建的实例信息。 |
InstanceResourceType | String | 否 | EnsService |
过滤的类型。
|
SearchKey | String | 否 | Joshua |
查询的关键字。支持ip、InstanceName、InstanceId等参数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 0 |
返回的业务码,正常成功为0。 |
Instances | Array |
由InstanceAttributesType组成的数组格式,返回实例的信息。 |
|
Instance | |||
Cpu | String | 2 |
Vcpu核数。 |
CreationTime | String | 2019-12-13T03:04:31Z |
实例创建时间。按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
DataDisk | Array |
数据盘返回信息。 |
|
DataDisk | |||
Category | String | file |
云盘或本地盘种类。
|
DiskId | String | d-5ip4c2dhmas0vjd5u1r**** |
磁盘ID。 |
DiskName | String | DiskName |
磁盘名称。 |
Size | Integer | 51200 |
磁盘大小,单位:MB。 |
device_type | String | system |
Category的扩展字段。
|
disk_type | String | pangu |
云盘或本地盘类型、
|
name | String | name |
磁盘名称。 |
storage | Integer | 20480 |
磁盘容量,单位:MB。 |
uuid | String | d-5itef1wtxj961mbff8xe9**** |
UUID。 |
Disk | Integer | 71680 |
磁盘总大小。 |
EnsRegionId | String | cn-hangzhou-telecom |
实例所属地域ID。 |
ExpiredTime | String | 2017-12-10T04:04:00Z |
过期时间。按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
ImageId | String | m-**** |
镜像ID。 |
InnerIpAddress | List | 10.170.xx.xx |
实例的内网IP地址。 |
InstanceId | String | i-instanc**** |
实例ID。 |
InstanceName | String | Finance**** |
实例名称。 |
InstanceResourceType | String | EnsService |
实例类型。
|
InternetMaxBandwidthIn | Integer | 40 |
最大下行带宽,单位:Mbps。 |
InternetMaxBandwidthOut | Integer | 100 |
最小上行带宽,单位:Mbps。 |
Memory | Integer | 2048 |
内存大小,单位:MB。 |
OSName | String | centos 6.8 x86_64 |
镜像名称。 |
PrivateIpAddresses | Array |
实例私网返回信息。 |
|
PrivateIpAddress | |||
GateWay | String | 119.147.xx.xx |
网关。 |
Ip | String | 119.147.xx.xx |
ip信息。 |
Isp | String | cmcc |
运营商信息。 |
PublicIpAddress | List | 119.147.xx.xx |
公网地址。 |
PublicIpAddresses | Array |
公网返回信息。 |
|
PublicIpAddress | |||
GateWay | String | 119.147.xx.xx |
网关。 |
Ip | String | 119.147.xx.xx |
ip信息。 |
Isp | String | unicom |
运营商信息。 |
SecurityGroupIds | List | sg-5kyicq2kfcapxrdds6ta**** |
安全组ID。 |
SpecName | String | ens.sn1.stiny |
实例规格代码。 |
Status | String | Running |
状态。
|
SystemDisk | Struct |
系统盘返回信息。 |
|
Category | String | file |
云盘或本地盘种类。
|
DiskId | String | d-5ip4c2dhmas0rn7rt0p9**** |
磁盘ID。 |
DiskName | String | DiskName |
磁盘名称。 |
Size | Integer | 20480 |
磁盘大小,单位MB。 |
device_type | String | file |
云盘或本地盘种类。
|
disk_type | String | system |
云盘或本地盘类型、
|
name | String | DiskName |
磁盘名称。 |
storage | Integer | 20480 |
磁盘容量,单位:MB。 |
uuid | String | d-5ip4c2dhmas0rn7rt0p96**** |
UUID。 |
PageNumber | Integer | 10 |
实例列表的页码。 |
PageSize | Integer | 10 |
输入时设置的每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
TotalCount | Integer | 6 |
查询到的实例总数。 |
示例
请求示例
https://ens.aliyuncs.com?Action=DescribeInstances
&Version=2017-11-10
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInstancesResponse>
<Instances>
<Instance>
<Status>Running</Status>
<PrivateIpAddresses>
<PrivateIpAddress>
<GateWay></GateWay>
<Ip>10.0.xx.xx</Ip>
<Isp>telecom</Isp>
</PrivateIpAddress>
</PrivateIpAddresses>
<InstanceId>i-5l4re50zpy1ecu8uy4pa0****</InstanceId>
<Memory>8192</Memory>
<Cpu>4</Cpu>
<SpecName>ens.sn1.small</SpecName>
<OSName>centos 7.4 x86_64</OSName>
<SecurityGroupIds>
</SecurityGroupIds>
<InstanceName></InstanceName>
<PublicIpAddress>
<IpAddress>110.185.xx.xx</IpAddress>
</PublicIpAddress>
<SystemDisk>
<Category>pangu</Category>
<Size>30720</Size>
<disk_type>system</disk_type>
<name></name>
<device_type>pangu</device_type>
<storage>30720</storage>
<DiskName></DiskName>
<uuid>d-5l4re63k5i9c46riy75****</uuid>
<DiskId>d-5l4re63k5i9c46riy75****</DiskId>
</SystemDisk>
<InnerIpAddress>
<IpAddress>10.0.xx.xx</IpAddress>
</InnerIpAddress>
<DataDisk>
<DataDisk>
<Category>pangu</Category>
<Size>51200</Size>
<disk_type>data</disk_type>
<name></name>
<device_type>pangu</device_type>
<storage>51200</storage>
<DiskName></DiskName>
<uuid>d-5l4re63k5i9c82wwz88****</uuid>
<DiskId>d-5l4re63k5i9c82wwz881****</DiskId>
</DataDisk>
</DataDisk>
<InternetMaxBandwidthOut>1500</InternetMaxBandwidthOut>
<InternetMaxBandwidthIn>0</InternetMaxBandwidthIn>
<ExpiredTime>2020-04-04T16:00:00Z</ExpiredTime>
<CreationTime>2020-03-04T01:56:26Z</CreationTime>
<ImageId>centos_7_04_64_20G_alibase_20171211</ImageId>
<PublicIpAddresses>
<PublicIpAddress>
<GateWay></GateWay>
<Ip>110.185.xx.xx</Ip>
<Isp>telecom</Isp>
</PublicIpAddress>
</PublicIpAddresses>
<EnsRegionId>cn-chengdu-telecom-4</EnsRegionId>
<Disk>81920</Disk>
<InstanceResourceType>EnsInstance</InstanceResourceType>
</Instance>
</Instances>
<TotalCount>1</TotalCount>
<RequestId>92577D88-9E1A-4B6E-9541-D380AD7D4B36</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Code>0</Code>
</DescribeInstancesResponse>
JSON
格式
{
"Instances": {
"Instance": [
{
"Status": "Running",
"PrivateIpAddresses": {
"PrivateIpAddress": [
{
"GateWay": "",
"Ip": "10.0.xx.xx",
"Isp": "telecom"
}
]
},
"InstanceId": "i-5l4re50zpy1ecu8uy4pa0****",
"Memory": 8192,
"Cpu": 4,
"SpecName": "ens.sn1.small",
"OSName": "centos 7.4 x86_64",
"SecurityGroupIds": {
"SecurityGroupId": []
},
"InstanceName": "",
"PublicIpAddress": {
"IpAddress": [
"110.185.xx.xx"
]
},
"SystemDisk": {
"Category": "pangu",
"Size": 30720,
"disk_type": "system",
"name": "",
"device_type": "pangu",
"storage": 30720,
"DiskName": "",
"uuid": "d-5l4re63k5i9c46riy75****",
"DiskId": "d-5l4re63k5i9c46riy75****"
},
"InnerIpAddress": {
"IpAddress": [
"10.0.xx.xx"
]
},
"DataDisk": {
"DataDisk": [
{
"Category": "pangu",
"Size": 51200,
"disk_type": "data",
"name": "",
"device_type": "pangu",
"storage": 51200,
"DiskName": "",
"uuid": "d-5l4re63k5i9c82wwz88****",
"DiskId": "d-5l4re63k5i9c82wwz881****"
}
]
},
"InternetMaxBandwidthOut": 1500,
"InternetMaxBandwidthIn": 0,
"ExpiredTime": "2020-04-04T16:00:00Z",
"CreationTime": "2020-03-04T01:56:26Z",
"ImageId": "centos_7_04_64_20G_alibase_20171211",
"PublicIpAddresses": {
"PublicIpAddress": [
{
"GateWay": "",
"Ip": "110.185.xx.xx",
"Isp": "telecom"
}
]
},
"EnsRegionId": "cn-chengdu-telecom-4",
"Disk": 81920,
"InstanceResourceType": "EnsInstance"
}
]
},
"TotalCount": 1,
"RequestId": "92577D88-9E1A-4B6E-9541-D380AD7D4B36",
"PageSize": 10,
"PageNumber": 1,
"Code": 0
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交