产品解决方案文档与社区权益中心定价云市场合作伙伴支持与服务了解阿里云
备案控制台登录/注册
首页 边缘节点服务ENS 开发参考 API参考 实例 DescribeInstances

DescribeInstances

更新时间: 2023-10-23 13:58:49

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

  • API调用频率：800次/秒。
  • 单用户调用频率：100次/秒。
  • 请求参数的作用类似于一个过滤器，过滤器为逻辑与（AND）关系。如果某一参数为空，则过滤器不起作用。但是参数InstanceIds如果是一个空JSON数组，则视为该过滤器有效，且返回空。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
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

查询的关键字。支持ip、InstanceName、InstanceId等参数。
NetworkId String 否 n-2zeuphj08tt7q3brd****

网络ID。
VSwitchId String 否 vsw-2zeh0r1pabwtg6wcs****

交换机ID。
SecurityGroupId String 否 sg-5kyicq2kfcapxrdds6tar7jqb

安全组ID。
IntranetIp String 否 47.100.XX.XX

内网IP地址。

返回数据

名称

类型

示例值

描述
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

实例规格代码。
InstanceTypeFamily String x86_vm

实例规格簇。取值：

  • x86_vm：X86计算
  • x86_pm：X86裸机
  • x86_bmi：X86裸金属
  • x86_bm：智能网卡裸金属
  • pc_bmi：异构裸金属
  • pc_vm：异构虚机
  • arm_bmi：ARM计
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

磁盘总大小。单位：MiB。
OSName String centos 6.8 x86_64

镜像名称。
Memory Integer 2048

内存大小，单位：MB。
ImageId String m-****

镜像ID。
DataDisk Array of DataDisk

数据盘返回信息。
DataDisk
device_type String pangu

Category的扩展字段。取值：

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

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

system：系统盘。

data：数据盘。
Size Integer 51200

磁盘大小，单位：MiB。
DiskName String DiskName

磁盘名称。
uuid String d-5itef1wtxj961mbff8xe9****

UUID。
storage Integer 20480

磁盘容量，单位：MiB。
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

磁盘返回信息。
device_type String pangu

Category的扩展字段。取值：

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

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

  • system：系统盘。
  • data：数据盘。
Size Integer 51200

磁盘大小，单位：MiB。
DiskName String DiskName

磁盘名称。
uuid String d-5ip4c2dhmas0rn7rt0p96****

UUID。
storage Integer 20480

磁盘容量，单位：MiB。
DiskId String d-5ip4c2dhmas0rn7rt0p9****

磁盘ID。
Category String file

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

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

磁盘名称。
NetworkAttributes Object

网络返回信息。
NetworkId String n-2zeuphj08tt7q3brd****

网络ID。
VSwitchId String vsw-2zeh0r1pabwtg6wcs****

交换机ID。
PrivateIpAddress Array of String 172.17.**.**

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

示例

请求示例

http(s)://ens.aliyuncs.com/?Action=DescribeInstances
&EnsRegionId=cn-beijing-cmcc
&InstanceId=i-5iqczfxps7csjrxeca****
&EnsRegionIds=["cn-suzhou-telecom","cn-chengdu-telecom"]
&InstanceIds=["i-5iqczfxps7csjrxeca07****", "i-5iqczfxps7csjrxeca07****"]
&InstanceName=TestName
&ImageId=centos_6_08_64_20G_alibase_****
&PageNumber=1
&PageSize=10
&Status=Running
&OrderByParams={"InstanceNameSort":"asc","ExpireTimeSort":"asc","CreationTimeSort":"desc"}
&EnsServiceId=ens-20190730202316s****
&InstanceResourceType=EnsService
&SearchKey=Joshua
&NetworkId=n-2zeuphj08tt7q3brd****
&VSwitchId=vsw-2zeh0r1pabwtg6wcs****
&SecurityGroupId=sg-5kyicq2kfcapxrdds6tar7jqb
&IntranetIp=47.100.XX.XX
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstancesResponse>
    <Code>0</Code>
    <PageSize>60</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>2</TotalCount>
    <Instances>
        <CreationTime>2019-07-26T06:40:43Z</CreationTime>
        <Status>Running</Status>
        <SpecName>ens.sn1.stiny</SpecName>
        <InstanceTypeFamily>x86_vm</InstanceTypeFamily>
        <InstanceResourceType>EnsService</InstanceResourceType>
        <HostName>testHostName</HostName>
        <InstanceId>i-instanc****</InstanceId>
        <InternetMaxBandwidthIn>40</InternetMaxBandwidthIn>
        <InternetMaxBandwidthOut>100</InternetMaxBandwidthOut>
        <EnsRegionId>cn-hangzhou-telecom</EnsRegionId>
        <Cpu>2</Cpu>
        <ExpiredTime>2119-07-13T02:38:57Z</ExpiredTime>
        <InstanceName>i-5itef0f28t17bcdw9deu6meub</InstanceName>
        <Disk>71680</Disk>
        <OSName>centos 6.8 x86_64</OSName>
        <Memory>2048</Memory>
        <ImageId>m-****</ImageId>
        <DataDisk>
            <device_type>pangu</device_type>
            <disk_type>system</disk_type>
            <Size>51200</Size>
            <DiskName>DiskName</DiskName>
            <uuid>d-5itef1wtxj961mbff8xe9****</uuid>
            <storage>20480</storage>
            <DiskId>d-5ip4c2dhmas0vjd5u1r****</DiskId>
            <Category>file</Category>
            <name>name</name>
        </DataDisk>
        <PublicIpAddresses>
            <Ip>119.147.xx.xx</Ip>
            <GateWay>119.147.xx.xx</GateWay>
            <Isp>unicom</Isp>
        </PublicIpAddresses>
        <PrivateIpAddresses>
            <Ip>119.147.xx.xx</Ip>
            <GateWay>119.147.xx.xx</GateWay>
            <Isp>cmcc</Isp>
        </PrivateIpAddresses>
        <SecurityGroupIds>sg-5kyicq2kfcapxrdds6ta****</SecurityGroupIds>
        <InnerIpAddress>10.170.xx.xx</InnerIpAddress>
        <PublicIpAddress>119.147.xx.xx</PublicIpAddress>
        <SystemDisk>
            <device_type>pangu</device_type>
            <disk_type>system</disk_type>
            <Size>51200</Size>
            <DiskName>DiskName</DiskName>
            <uuid>d-5ip4c2dhmas0rn7rt0p96****</uuid>
            <storage>20480</storage>
            <DiskId>d-5ip4c2dhmas0rn7rt0p9****</DiskId>
            <Category>file</Category>
            <name>DiskName</name>
        </SystemDisk>
        <NetworkAttributes>
            <NetworkId>n-2zeuphj08tt7q3brd****</NetworkId>
            <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
        </NetworkAttributes>
    </Instances>
</DescribeInstancesResponse>

JSON格式

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

{
  "Code" : 0,
  "PageSize" : 60,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 2,
  "Instances" : [ {
    "CreationTime" : "2019-07-26T06:40:43Z",
    "Status" : "Running",
    "SpecName" : "ens.sn1.stiny",
    "InstanceTypeFamily" : "x86_vm",
    "InstanceResourceType" : "EnsService",
    "HostName" : "testHostName",
    "InstanceId" : "i-instanc****",
    "InternetMaxBandwidthIn" : 40,
    "InternetMaxBandwidthOut" : 100,
    "EnsRegionId" : "cn-hangzhou-telecom",
    "Cpu" : "2",
    "ExpiredTime" : "2119-07-13T02:38:57Z",
    "InstanceName" : "i-5itef0f28t17bcdw9deu6meub",
    "Disk" : 71680,
    "OSName" : "centos 6.8 x86_64",
    "Memory" : 2048,
    "ImageId" : "m-****",
    "DataDisk" : [ {
      "device_type" : "pangu",
      "disk_type" : "system",
      "Size" : 51200,
      "DiskName" : "DiskName",
      "uuid" : "d-5itef1wtxj961mbff8xe9****",
      "storage" : 20480,
      "DiskId" : "d-5ip4c2dhmas0vjd5u1r****",
      "Category" : "file",
      "name" : "name"
    } ],
    "PublicIpAddresses" : [ {
      "Ip" : "119.147.xx.xx",
      "GateWay" : "119.147.xx.xx",
      "Isp" : "unicom"
    } ],
    "PrivateIpAddresses" : [ {
      "Ip" : "119.147.xx.xx",
      "GateWay" : "119.147.xx.xx",
      "Isp" : "cmcc"
    } ],
    "SecurityGroupIds" : [ "sg-5kyicq2kfcapxrdds6ta****" ],
    "InnerIpAddress" : [ "10.170.xx.xx" ],
    "PublicIpAddress" : [ "119.147.xx.xx" ],
    "SystemDisk" : {
      "device_type" : "pangu",
      "disk_type" : "system",
      "Size" : 51200,
      "DiskName" : "DiskName",
      "uuid" : "d-5ip4c2dhmas0rn7rt0p96****",
      "storage" : 20480,
      "DiskId" : "d-5ip4c2dhmas0rn7rt0p9****",
      "Category" : "file",
      "name" : "DiskName"
    },
    "NetworkAttributes" : {
      "NetworkId" : "n-2zeuphj08tt7q3brd****",
      "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****",
      "PrivateIpAddress" : [ "172.17.**.**" ]
    }
  } ]
}

错误码

HttpCode

错误码

错误信息

描述
400 NoPermission Permission denied. 没有足够的权限，请联系云账号管理员授予您相应权限。
400 CallInterface Call Interface Happen Error. 接口调用出错。

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

阿里云首页 边缘节点服务ENS 相关技术圈
为什么选择阿里云什么是云计算全球基础设施技术领先稳定可靠安全合规分析师报告
产品和定价全部产品免费试用产品动态产品定价价格计算器云上成本管理
解决方案技术解决方案行业解决方案
文档与社区文档开发者社区天池大赛培训与认证
权益中心免费试用高校计划企业扶持计划推荐返现计划
支持与服务基础服务企业增值服务迁云服务官网公告系统状态信任中心
关注阿里云
关注阿里云公众号或下载阿里云APP，关注云资讯，随时随地运维管控云服务
阿里云APP阿里云微信
售前咨询：95187-1
售后服务：400-80-13260
法律声明及隐私权政策Cookies政策廉正举报安全举报联系我们加入我们
阿里巴巴集团淘宝网天猫全球速卖通阿里巴巴国际交易市场1688阿里妈妈飞猪阿里云计算AliOS万网高德UC友盟优酷钉钉支付宝达摩院淘宝海外阿里云盘饿了么
© 2009-2023 Aliyun.com 版权所有 增值电信业务经营许可证： 浙B2-20080101 域名注册服务机构许可： 浙D3-20210002 京D3-20220015
浙公网安备 33010602009975号浙B2-20080101-4
关注我们：
新浪微博
联系我们
© 2009-2023 Aliyun.com 版权所有<br/>增值电信业务经营许可证： <a href="http://beian.miit.gov.cn/" target="_blank">浙B2-20080101</a> <br/>域名注册服务机构许可： <a href="https://domain.miit.gov.cn/域名注册服务机构/互联网域名/阿里云计算有限公司 " target="_blank">浙D3-20210002</a> <a href="https://domain.miit.gov.cn/域名注册服务机构/互联网域名/阿里巴巴云计算北京有限公司 " target="_blank">京D3-20220015</a>