调用DescribeInstances接口查询一台或多台实例的详细信息。

请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。但是参数InstanceIds如果是一个空JSON数组,则视为该过滤器有效,且返回空。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstances

系统规定参数,取值:DescribeInstances

Version String 2017-11-10

版本号。

EnsRegionId String cn-beijing-cmcc

地域ID。

EnsRegionIds String ["cn-suzhou-telecom","cn-chengdu-telecom"]

实例的编号列表。参数为一个带有格式的JSON数组,最多100个ID,用逗号(,)隔开。

InstanceId String i-5iqczfxps7csjrxecaxxxx

实例ID。

InstanceIds String ["i-5iqczfxps7csjrxeca07xxxx", "i-5iqczfxps7csjrxeca07xxxx"]]

实例的编号列表。参数为一个带有格式的JSON数组,最多100个ID,用逗号(,)隔开。

InstanceName String Joshua

实例名称。

ImageId String centos_6_08_64_20G_alibase_20171208

镜像ID。

PageNumber Integer 1

实例状态列表的页码,起始值为1

默认值:1

PageSize String 10

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

默认值:10

Status String Running

实例状态。取值:

  • Running:运行中。
  • Stopped:已停止。
  • Expired:已过期。
OrderByParams String {"InstanceNameSort":"asc","ExpireTimeSort":"asc","CreationTimeSort":"desc"}}

排序参数,JSON格式。

按照实例名称、到期时间、节点ID、创建时间排序,可以组合使用。

EnsServiceId String ens-20190730202316sxxxx

边缘服务ID,可按此ID查询边缘服务下所创建的实例信息。

InstanceResourceType String EnsService

过滤的类型。

EnsInstance:单独购买实例。

EnsService:边缘服务实例。

BuildMachine:镜像构建机。

SearchKey String Joshua

查询的关键字。支持ip、InstanceName、InstanceId等参数。

返回数据

名称 类型 示例值 描述
Code Integer 0

返回的业务码,正常成功为0。

Instances

由InstanceAttributesType组成的数组格式,返回实例的信息。

Instance

由InstanceAttributesType组成的数组格式,返回实例的信息。

Cpu String 2

Vcpu核数。

CreationTime String 2017-12-10T04:04Z

实例创建时间。按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

DataDisk

数据盘返回信息。

DataDisk

数据盘返回信息。

Category String file

file:本地盘;pangu:高效云盘。

DiskId String d-5ip4c2dhmas0vjd5u1rfbj44j

磁盘ID。

DiskName String DiskName

磁盘名称。

Size Integer 51200

磁盘大小,单位MB。

device_type String system

system:本地盘;data:数据盘。

disk_type String pangu

file:本地盘;pangu:高效云盘。

name String name

磁盘名称。

storage Integer 20480

磁盘容量,单位MB。

uuid String d-5itef1wtxj961mbff8xe9smn7

UUID。

Disk Integer 71680

磁盘总大小。

EnsRegionId String cn-hangzhou-telecom

实例所属地域ID。

ExpiredTime String 2017-12-10T04:04Z

过期时间。按照ISO8601标准表示,并需要使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

ImageId String m-xxxx

镜像ID。

InnerIpAddress 10.170.XX.XXX

实例的内网IP地址。

IpAddress

实例的内网IP地址。

InstanceId String i-instanceid1

实例ID。

InstanceName String FinanceJoshua

实例名称。

InstanceResourceType String EnsService

EnsInstance:单独购买实例;EnsService:边缘服务实例;BuildMachine:镜像构建机。

InternetMaxBandwidthIn Integer 40

最大下行带宽。

InternetMaxBandwidthOut Integer 100

最小上行带宽。

Memory Integer 2048

内存大小,单位MB。

OSName String centos 6.8 x86_64

镜像名称。

PrivateIpAddresses

实例私网返回信息。

PrivateIpAddress

实例私网返回信息。

GateWay String 119.147.185.12x

网关。

Ip String 119.147.185.x

ip信息。

Isp String cmcc

运营商信息。

PublicIpAddress 119.147.185.x

公网地址。

IpAddress

公网地址。

PublicIpAddresses

公网返回信息。

PublicIpAddress

公网返回信息。

GateWay String 119.147.185.12x

网关。

Ip String 119.147.185.x

ip信息。

Isp String unicom

运营商信息。

SpecName String ens.sn1.stiny

实例规格代码。

Status String Running

状态:

  • Running:运行中。
  • Expired:已过期。
  • Stopped:已停止。
SystemDisk

系统盘返回信息。

Category String file

磁盘类型。

  • file:本地盘。
  • pangu:高效云盘。
DiskId String d-5ip4c2dhmas0rn7rt0p96qnc3

磁盘ID。

DiskName String DiskName

磁盘名称。

Size Integer 20480

磁盘大小,单位MB。

device_type String file

磁盘类型。

  • file:本地盘。
  • pangu:高效云盘。
disk_type String system

system:本地盘;data:数据盘。

name String DiskName

磁盘名称。

storage Integer 20480

磁盘容量,单位MB。

uuid String d-5ip4c2dhmas0rn7rt0p96qnc3

UUID。

PageNumber Integer 10

实例列表的页码。

PageSize Integer 10

输入时设置的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

TotalCount Integer 6

查询到的实例总数。

示例

请求示例

https://ens.aliyuncs.com?Action=DescribeInstances
&<公共请求参数>

正常返回示例

XML 格式

<DescribeInstancesResponse>
  <PageNumber>1</PageNumber>
  <TotalCount>1</TotalCount>
  <PageSize>1</PageSize>
  <RequestId>F5ADB608-EC11-4C3D-9D85-4025035AFADC</RequestId>
  <Instances>
        <Instance>
              <InnerIpAddress>
                    <IpAddress>192.168.0.44</IpAddress>
              </InnerIpAddress>
              <ImageId>centos_7_04_64_20G_alibase_20171211</ImageId>
              <SystemDisk>
                    <Category>pangu</Category>
                    <disk_type>system</disk_type>
                    <DiskName></DiskName>
                    <DiskId>d-5x</DiskId>
                    <Size>20480</Size>
              </SystemDisk>
              <InstanceId>i-x</InstanceId>
              <InternetMaxBandwidthIn>0</InternetMaxBandwidthIn>
              <OSName>centos 7.4 x86_64</OSName>
              <Disk>40960</Disk>
              <PublicIpAddress>
                    <IpAddress>42.123.118.43</IpAddress>
              </PublicIpAddress>
              <DataDisk>
                    <DataDisk>
                          <Category>pangu</Category>
                          <DiskName></DiskName>
                          <DiskId>d-x</DiskId>
                          <Size>20480</Size>
                          <storage>20480</storage>
                    </DataDisk>
              </DataDisk>
              <CreationTime>2019-01-11T09:27:36Z</CreationTime>
              <Status>Running</Status>
              <Cpu>1</Cpu>
              <Memory>2048</Memory>
              <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
              <SpecName>ens.xx.stiny</SpecName>
              <EnsRegionId>cn-xx-telecom</EnsRegionId>
              <ExpiredTime>2019-02-10T08:55:45Z</ExpiredTime>
              <InstanceName></InstanceName>
        </Instance>
  </Instances>
  <Code>0</Code>
</DescribeInstancesResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":1,
	"RequestId":"F5ADB608-EC11-4C3D-9D85-4025035AFADC",
	"Instances":{
		"Instance":[
			{
				"InnerIpAddress":{
					"IpAddress":[
						"192.xxx"
					]
				},
				"ImageId":"centos_7_04_64_20G_alibase_20171211",
				"SystemDisk":{
					"Category":"pangu",
					"disk_type":"system",
					"DiskName":"",
					"DiskId":"d-5x",
					"Size":20480
				},
				"InstanceId":"i-x",
				"InternetMaxBandwidthIn":0,
				"OSName":"centos 7.4 x86_64",
				"Disk":40960,
				"PublicIpAddress":{
					"IpAddress":[
						"42.123.118.43"
					]
				},
				"DataDisk":{
					"DataDisk":[
						{
							"Category":"pangu",
							"DiskName":"",
							"DiskId":"d-x",
							"storage":20480,
							"Size":20480
						}
					]
				},
				"CreationTime":"2019-01-11T09:27:36Z",
				"Status":"Running",
				"Cpu":1,
				"Memory":2048,
				"InternetMaxBandwidthOut":0,
				"EnsRegionId":"cn-xx-telecom",
				"SpecName":"ens.xx.stiny",
				"ExpiredTime":"2019-02-10T08:55:45Z",
				"InstanceName":""
			}
		]
	},
	"Code":0
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission Permission denied. 没有足够的权限,请联系云账号管理员授予您相应权限。

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