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

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Version String 2017-11-10

版本号。

Action String DescribeInstances

系统规定参数。取值:DescribeInstances

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

实例状态。取值:

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

排序参数,JSON格式。

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

EnsServiceId String ens-20190730202316s****

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

InstanceResourceType String EnsService

过滤的类型。取值:

  • EnsInstance:单独购买实例。
  • EnsService:边缘服务实例。
  • BuildMachine:镜像构建机。
  • EnsPostPaidInstance:单独购买后付费。
SearchKey String Joshua

查询的关键字。支持ipInstanceNameInstanceId等参数。

NetworkId String n-2zeuphj08tt7q3brd****

网络ID。

VSwitchId String vsw-2zeh0r1pabwtg6wcs****

交换机ID。

SecurityGroupId String sg-5kyicq2kfcapxrdds6tar7jqb

安全组ID。

返回数据

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

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

PageSize Integer 60

输入时设置的每页行数。

PageNumber Integer 1

实例列表的页码。

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

请求ID。

TotalCount Integer 2

查询到的实例总数。

Instances Array of Instance

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

Instance
CreationTime String 2019-07-26T06:40:43Z

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

Status String Running

状态。取值:

  • Running:运行中。
  • Expired:已过期。
  • Stopped:已停止。
SpecName String ens.sn1.stiny

实例规格代码。

InstanceResourceType String EnsService

实例类型。取值:

  • EnsInstance:单独购买实例。
  • EnsService:边缘服务实例。
  • BuildMachine:镜像构建机。
  • EnsPostPaidInstance:单独购买后付费。
HostName String testHostName

实例主机名称。

  • 点号(.)和短横线(-)不能作为首尾字符,更不能连续使用。
  • Windows实例:字符长度为2~15,不支持点号(.),不能全是数字。允许大小写英文字母、数字和短横线(-)。
  • 其他类型实例(Linux等):字符长度为2~64,支持多个点号(.),点之间为一段,每段允许大小写英文字母、数字和短横线(-)。
InstanceId String i-instanc****

实例ID。

InternetMaxBandwidthIn Integer 40

最大下行带宽,单位:Mbps。

InternetMaxBandwidthOut Integer 100

最小上行带宽,单位:Mbps。

EnsRegionId String cn-hangzhou-telecom

实例所属地域ID。

Cpu String 2

Vcpu核数。

ExpiredTime String 2119-07-13T02:38:57Z

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

InstanceName String i-5itef0f28t17bcdw9deu6meub

实例名称。

Disk Integer 71680

磁盘总大小。

Memory Integer 2048

内存大小,单位:MB。

OSName String centos 6.8 x86_64

镜像名称。

ImageId String m-****

镜像ID。

DataDisk Array of DataDisk

数据盘返回信息。

DataDisk
device_type String pangu

Category的扩展字段。取值:

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

云盘或本地盘类型。取值:

sytetem:系统盘。

data:数据盘。

Size Integer 51200

磁盘大小,单位:MB。

DiskName String DiskName

磁盘名称。

uuid String d-5itef1wtxj961mbff8xe9****

UUID。

storage Integer 20480

磁盘容量,单位:MB。

DiskId String d-5ip4c2dhmas0vjd5u1r****

磁盘ID。

Category String file

云盘或本地盘种类。取值:

  • file:本地盘。
  • pangu:高效云盘。
  • local_hdd:本地HDD。
name String name

磁盘名称。

PublicIpAddresses Array of PublicIpAddress

公网返回信息。

PublicIpAddress
Ip String 119.147.xx.xx

ip信息。

GateWay String 119.147.xx.xx

网关。

Isp String unicom

运营商信息。

PrivateIpAddresses Array of PrivateIpAddress

实例私网返回信息。

PrivateIpAddress
Ip String 119.147.xx.xx

ip信息。

GateWay String 119.147.xx.xx

网关。

Isp String cmcc

运营商信息。

SecurityGroupIds Array of String sg-5kyicq2kfcapxrdds6ta****

安全组ID。

InnerIpAddress Array of String 10.170.xx.xx

实例的内网IP地址。

PublicIpAddress Array of String 119.147.xx.xx

公网地址。

SystemDisk Object

Schema of Response

device_type String pangu

Category的扩展字段。取值:

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

云盘或本地盘类型。取值:

  • sytetem:系统盘。
  • data:数据盘。
Size Integer 51200

磁盘大小,单位:MB。

DiskName String DiskName

磁盘名称。

uuid String d-5ip4c2dhmas0rn7rt0p96****

UUID。

storage Integer 20480

磁盘容量,单位:MB。

DiskId String d-5ip4c2dhmas0rn7rt0p9****

磁盘ID。

Category String file

云盘或本地盘种类。取值:

  • file:本地盘。
  • pangu:高效云盘。
  • local_hdd:本地HDD。
name String DiskName

磁盘名称。

NetworkAttributes Object

Schema of Response

NetworkId String n-2zeuphj08tt7q3brd****

网络ID。

VSwitchId String vsw-2zeh0r1pabwtg6wcs****

交换机ID。

PrivateIpAddress Array of String 172.17.**.**

实例私网IP地址,如果指定了内网地址,则数量只能是1。该IP地址必须为交换机(VSwitchId)网段的空闲地址。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeInstancesResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <PageSize>60</PageSize>
    <RequestId>8A77B1C9-E7C1-4858-91D0-38AC46304FED</RequestId>
    <Instances>
        <Instance>
            <InnerIpAddress>
                <IpAddress>192.168.0.2</IpAddress>
            </InnerIpAddress>
            <ImageId>centos_6_08_64_20G_alibase_20171208</ImageId>
            <SecurityGroupIds>
                <SecurityGroupId>sg-5kyicq2kfcapxrdds6tar7jqb</SecurityGroupId>
            </SecurityGroupIds>
            <SystemDisk>
                <Category>file</Category>
                <device_type>file</device_type>
                <name/>
                <disk_type>system</disk_type>
                <DiskName/>
                <uuid>d-5ip4c2dhmas0rn7rt0p96qnc3</uuid>
                <DiskId>d-5ip4c2dhmas0rn7rt0p96qnc3</DiskId>
                <Size>20480</Size>
                <storage>20480</storage>
            </SystemDisk>
            <InstanceId>i-5ip4c0oa51ryofiwfxmqvk2w3</InstanceId>
            <InternetMaxBandwidthIn>0</InternetMaxBandwidthIn>
            <OSName>centos 6.8 x86_64</OSName>
            <Disk>71680</Disk>
            <InstanceResourceType>EnsInstance</InstanceResourceType>
            <PublicIpAddress>
                <IpAddress>223.71.81.129</IpAddress>
            </PublicIpAddress>
            <DataDisk>
                <DataDisk>
                    <Category>file</Category>
                    <device_type>file</device_type>
                    <name/>
                    <disk_type>data</disk_type>
                    <DiskName/>
                    <uuid>d-5ip4c2dhmas0vjd5u1rfbj44j</uuid>
                    <DiskId>d-5ip4c2dhmas0vjd5u1rfbj44j</DiskId>
                    <Size>51200</Size>
                    <storage>51200</storage>
                </DataDisk>
            </DataDisk>
            <NetworkAttributes>
                <PrivateIpAddress>
                    <IpAddress>172.17.**.**</IpAddress>
                </PrivateIpAddress>
                <NetworkId>n-2zeuphj08tt7q3brd****</NetworkId>
                <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
            </NetworkAttributes>
            <CreationTime>2019-07-26T06:40:43Z</CreationTime>
            <Status>Running</Status>
            <Cpu>1</Cpu>
            <Memory>2048</Memory>
            <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
            <PrivateIpAddresses>
                <PrivateIpAddress>
                    <GateWay>119.147.185.125</GateWay>
                    <Ip>119.147.185.1</Ip>
                    <Isp>unicom</Isp>
                </PrivateIpAddress>
            </PrivateIpAddresses>
            <SpecName>ens.sn1.stiny</SpecName>
            <EnsRegionId>cn-beijing-cmcc</EnsRegionId>
            <ExpiredTime>2019-08-26T16:00:00Z</ExpiredTime>
            <PublicIpAddresses>
                <PublicIpAddress>
                    <GateWay>119.147.185.125</GateWay>
                    <Ip>119.147.185.2</Ip>
                    <Isp>unicom</Isp>
                </PublicIpAddress>
            </PublicIpAddresses>
            <InstanceName/>
        </Instance>
        <Instance>
            <InnerIpAddress>
                <IpAddress>10.0.15.2</IpAddress>
            </InnerIpAddress>
            <ImageId>centos_6_08_64_20G_alibase_20171208</ImageId>
            <SystemDisk>
                <Category>pangu</Category>
                <device_type>pangu</device_type>
                <name/>
                <disk_type>system</disk_type>
                <DiskName/>
                <uuid>d-5itef1wtxj961mbff8xe9smn7</uuid>
                <DiskId>d-5itef1wtxj961mbff8xe9smn7</DiskId>
                <Size>20480</Size>
                <storage>20480</storage>
            </SystemDisk>
            <InstanceId>i-5itef0f28t17bcdw9deu6meub</InstanceId>
            <InternetMaxBandwidthIn>0</InternetMaxBandwidthIn>
            <OSName>centos 6.8 x86_64</OSName>
            <Disk>61440</Disk>
            <InstanceResourceType>EnsService</InstanceResourceType>
            <PublicIpAddress>
                <IpAddress>139.215.139.54</IpAddress>
            </PublicIpAddress>
            <DataDisk>
                <DataDisk>
                    <Category>pangu</Category>
                    <device_type>pangu</device_type>
                    <name/>
                    <disk_type>data</disk_type>
                    <DiskName/>
                    <uuid>d-5itef1wtxj96darlic3wo610j</uuid>
                    <DiskId>d-5itef1wtxj96darlic3wo610j</DiskId>
                    <Size>40960</Size>
                    <storage>40960</storage>
                </DataDisk>
            </DataDisk>
            <NetworkAttributes>
                <PrivateIpAddress>
                    <IpAddress>172.17.**.**</IpAddress>
                </PrivateIpAddress>
                <NetworkId>n-2zeuphj08tt7q3brd****</NetworkId>
                <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
            </NetworkAttributes>
            <CreationTime>2019-08-06T02:38:58Z</CreationTime>
            <Status>Running</Status>
            <Cpu>1</Cpu>
            <Memory>2048</Memory>
            <InternetMaxBandwidthOut>40</InternetMaxBandwidthOut>
            <SpecName>ens.sn1.stiny</SpecName>
            <EnsRegionId>cn-changchun-unicom</EnsRegionId>
            <ExpiredTime>2119-07-13T02:38:57Z</ExpiredTime>
            <InstanceName>i-5itef0f28t17bcdw9deu6meub</InstanceName>
        </Instance>
    </Instances>
    <Code>0</Code>
</DescribeInstancesResponse>

JSON格式

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

{
  "PageNumber" : 1,
  "TotalCount" : 2,
  "PageSize" : 60,
  "RequestId" : "8A77B1C9-E7C1-4858-91D0-38AC46304FED",
  "Instances" : {
    "Instance" : [ {
      "InnerIpAddress" : {
        "IpAddress" : [ "192.168.0.2" ]
      },
      "ImageId" : "centos_6_08_64_20G_alibase_20171208",
      "SecurityGroupIds" : {
        "SecurityGroupId" : [ "sg-5kyicq2kfcapxrdds6tar7jqb" ]
      },
      "SystemDisk" : {
        "Category" : "file",
        "device_type" : "file",
        "name" : "",
        "disk_type" : "system",
        "DiskName" : "",
        "uuid" : "d-5ip4c2dhmas0rn7rt0p96qnc3",
        "DiskId" : "d-5ip4c2dhmas0rn7rt0p96qnc3",
        "Size" : 20480,
        "storage" : 20480
      },
      "InstanceId" : "i-5ip4c0oa51ryofiwfxmqvk2w3",
      "InternetMaxBandwidthIn" : 0,
      "OSName" : "centos 6.8 x86_64",
      "Disk" : 71680,
      "InstanceResourceType" : "EnsInstance",
      "PublicIpAddress" : {
        "IpAddress" : [ "223.71.81.129" ]
      },
      "DataDisk" : {
        "DataDisk" : [ {
          "Category" : "file",
          "device_type" : "file",
          "name" : "",
          "disk_type" : "data",
          "DiskName" : "",
          "uuid" : "d-5ip4c2dhmas0vjd5u1rfbj44j",
          "DiskId" : "d-5ip4c2dhmas0vjd5u1rfbj44j",
          "Size" : 51200,
          "storage" : 51200
        } ]
      },
      "NetworkAttributes" : {
        "PrivateIpAddress" : {
          "IpAddress" : [ "172.17.**.**" ]
        },
        "NetworkId" : "n-2zeuphj08tt7q3brd****",
        "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****"
      },
      "CreationTime" : "2019-07-26T06:40:43Z",
      "Status" : "Running",
      "Cpu" : 1,
      "Memory" : 2048,
      "InternetMaxBandwidthOut" : 0,
      "PrivateIpAddresses" : {
        "PrivateIpAddress" : [ {
          "GateWay" : "119.147.185.125",
          "Ip" : "119.147.185.1",
          "Isp" : "unicom"
        } ]
      },
      "SpecName" : "ens.sn1.stiny",
      "EnsRegionId" : "cn-beijing-cmcc",
      "ExpiredTime" : "2019-08-26T16:00:00Z",
      "PublicIpAddresses" : {
        "PublicIpAddress" : [ {
          "GateWay" : "119.147.185.125",
          "Ip" : "119.147.185.2",
          "Isp" : "unicom"
        } ]
      },
      "InstanceName" : ""
    }, {
      "InnerIpAddress" : {
        "IpAddress" : [ "10.0.15.2" ]
      },
      "ImageId" : "centos_6_08_64_20G_alibase_20171208",
      "SystemDisk" : {
        "Category" : "pangu",
        "device_type" : "pangu",
        "name" : "",
        "disk_type" : "system",
        "DiskName" : "",
        "uuid" : "d-5itef1wtxj961mbff8xe9smn7",
        "DiskId" : "d-5itef1wtxj961mbff8xe9smn7",
        "Size" : 20480,
        "storage" : 20480
      },
      "InstanceId" : "i-5itef0f28t17bcdw9deu6meub",
      "InternetMaxBandwidthIn" : 0,
      "OSName" : "centos 6.8 x86_64",
      "Disk" : 61440,
      "InstanceResourceType" : "EnsService",
      "PublicIpAddress" : {
        "IpAddress" : [ "139.215.139.54" ]
      },
      "DataDisk" : {
        "DataDisk" : [ {
          "Category" : "pangu",
          "device_type" : "pangu",
          "name" : "",
          "disk_type" : "data",
          "DiskName" : "",
          "uuid" : "d-5itef1wtxj96darlic3wo610j",
          "DiskId" : "d-5itef1wtxj96darlic3wo610j",
          "Size" : 40960,
          "storage" : 40960
        } ]
      },
      "NetworkAttributes" : {
        "PrivateIpAddress" : {
          "IpAddress" : [ "172.17.**.**" ]
        },
        "NetworkId" : "n-2zeuphj08tt7q3brd****",
        "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****"
      },
      "CreationTime" : "2019-08-06T02:38:58Z",
      "Status" : "Running",
      "Cpu" : 1,
      "Memory" : 2048,
      "InternetMaxBandwidthOut" : 40,
      "SpecName" : "ens.sn1.stiny",
      "EnsRegionId" : "cn-changchun-unicom",
      "ExpiredTime" : "2119-07-13T02:38:57Z",
      "InstanceName" : "i-5itef0f28t17bcdw9deu6meub"
    } ]
  },
  "Code" : 0
}

错误码

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

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