调用DescribeInstances API查询实例详细信息-边缘节点服务 ENS-阿里云-边缘节点服务 ENS(ENS)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeInstances

list

*Instance

acs:ens:*:{#accountId}:instance/{#InstanceId}

无

请求参数

名称	类型	必填	描述	示例值
EnsRegionId	string	否	地域 ID。	cn-beijing-cmcc
InstanceId	string	否	实例 ID。	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	否	节点的编号列表。参数为一个带有格式的 JSON 数组，最多 100 个 ID，英文逗号（,）分隔。	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	否	实例的编号列表。参数为一个带有格式的 JSON 数组，最多 100 个 ID，英文逗号（,）分隔。	["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]
InstanceName	string	否	实例名称。	TestName
ImageId	string	否	镜像 ID。	centos_6_08_64_20G_alibase_****
PageNumber	integer	否	实例状态列表的页码，起始值为 1。默认值：1。	1
PageSize	string	否	分页查询时设置的每页行数，最大值为 100 行。默认值：10。	10
Status	string	否	实例状态。取值： Running：运行中。 Stopped：已停止。 Expired：已过期。	Running
OrderByParams	string	否	排序参数，JSON 格式。按照实例名称、到期时间、节点 ID、创建时间排序，可以组合使用。	{ "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
EnsServiceId	string	否	边缘服务 ID，可按此 ID 查询边缘服务下所创建的实例信息。	ens-20190730202316s****
InstanceResourceType	string	否	过滤的类型。取值： EnsInstance：单独购买实例。 EnsService：边缘服务实例。 BuildMachine：镜像构建机。 EnsPostPaidInstance：单独购买后付费。	EnsService
SearchKey	string	否	查询的关键字。支持 ip、InstanceName、InstanceId 等参数。	Joshua
NetworkId	string	否	网络 ID。	n-2zeuphj08tt7q3brd****
VSwitchId	string	否	交换机 ID。	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	否	安全组 ID。	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	否	内网 IP 地址。	47.100.XX.XX
Tags	array<object>	否	资源标签。此接口暂不支持标签信息返回，可以结合标签目录下的 API 进行组合使用。
	object	否	实例的标签集合。此接口暂不支持标签信息返回，可以结合标签目录下的 API 进行组合使用。
Key	string	否	实例的标签键。N 的取值范围为 1~20。	tag
Value	string	否	实例的标签值。N 的取值范围：1~20。	2
InstanceType	string	否	实例规格。	ens.se1.tiny
ServiceStatus	array	否	实例的业务状态，不代表实例实际的运行状态
	string	否	实例的业务状态，不代表实例实际的运行状态 Expired(到期)。 Arrears(欠费)。	Expired
EipAddresses	array	否
	string	否
VpdId	string	否
VpdVSwitchId	string	否

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回的业务码，正常成功为 0。	0
PageSize	integer	输入时设置的每页行数。	60
PageNumber	integer	实例列表的页码。	1
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	查询到的实例总数。	2
Instances	object
Instance	array<object>	由 InstanceAttributesType 组成的数组格式，返回实例的信息。
	array<object>	Schema of Response
CreationTime	string	实例创建时间。按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-07-26T06:40:43Z
Status	string	状态。取值： Running：运行中。 Expired：已过期。 Stopped：已停止。	Running
SpecName	string	实例规格代码。	ens.sn1.stiny
InstanceTypeFamily	string	实例规格簇。取值： x86_vm：X86 计算 x86_pm：X86 裸机 x86_bmi：X86 裸金属 x86_bm：智能网卡裸金属 pc_bmi：异构裸金属 pc_vm：异构虚机 arm_bmi：ARM 计算	x86_vm
InstanceResourceType	string	实例类型。取值： EnsInstance：单独购买实例。 EnsService：边缘服务实例。 BuildMachine：镜像构建机。 EnsPostPaidInstance：单独购买后付费。	EnsService
HostName	string	实例主机名称。点号（.）和短横线（-）不能作为首尾字符，更不能连续使用。 Windows 实例：字符长度为 2~15，不支持点号（.），不能全是数字。允许大小写英文字母、数字和短横线（-）。其他类型实例（Linux 等）：字符长度为 2~64，支持多个点号（.），点之间为一段，每段允许大小写英文字母、数字和短横线（-）。	testHostName
InstanceId	string	实例 ID。	i-instanc****
InternetMaxBandwidthIn	integer	最大下行带宽，单位：Mbps。	40
InternetMaxBandwidthOut	integer	最小上行带宽，单位：Mbps。	100
EnsRegionId	string	实例所属地域 ID。	cn-hangzhou-telecom
Cpu	string	Vcpu 核数。	2
ExpiredTime	string	过期时间。按照 ISO8601 标准表示，并需要使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2119-07-13T02:38:57Z
InstanceName	string	实例名称。	i-5itef0f28t17bcdw9deu6meub
Disk	integer	磁盘总大小。单位：MiB。	71680
OSName	string	镜像名称。	centos 6.8 x86_64
Memory	integer	内存大小，单位：MB。	2048
ImageId	string	镜像 ID。	m-****
DataDisk	object
DataDisk	array<object>	数据盘返回信息。
	object	Schema of Response
device_type	string	Category 的扩展字段。取值： file：本地盘。 pangu：高效云盘。 local_hdd：本地 HDD。	pangu
disk_type	string	云盘或本地盘类型。取值： system：系统盘。 data：数据盘。	system
Size	integer	磁盘大小，单位：MiB。	51200
DiskName	string	磁盘名称。	DiskName
uuid	string	UUID。	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	磁盘容量，单位：MiB。	20480
DiskId	string	磁盘 ID。	d-5ip4c2dhmas0vjd5u1r****
Category	string	云盘或本地盘种类。取值： file：本地盘。 pangu：高效云盘。 local_hdd：本地 HDD。	file
name	string	磁盘名称。	name
DiskSize	integer	磁盘大小。单位：GiB。	100
EncryptKeyId	string	云盘使用的 KMS 密钥 ID。	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	是否加密云盘。	true
PublicIpAddresses	object
PublicIpAddress	array<object>	公网返回信息。
	object	公网返回信息。
Ip	string	ip 信息。	119.147.xx.xx
GateWay	string	网关。	119.147.xx.xx
Isp	string	运营商信息。	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	实例私网返回信息。
	object
Ip	string	ip 信息。	119.147.xx.xx
GateWay	string	网关。	119.147.xx.xx
Isp	string	运营商信息。	cmcc
SecurityGroupIds	object
SecurityGroupId	array	安全组 ID。
	string	安全组 ID。	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object
IpAddress	array	实例的内网 IP 地址。
	string	实例的内网 IP 地址。	10.170.xx.xx
PublicIpAddress	object
IpAddress	array	公网地址。
	string	公网地址。	119.147.xx.xx
SystemDisk	object	磁盘返回信息。
device_type	string	Category 的扩展字段。取值： file：本地盘。 pangu：高效云盘。 local_hdd：本地 HDD。	pangu
disk_type	string	云盘或本地盘类型。取值： system：系统盘。 data：数据盘。	system
Size	integer	磁盘大小，单位：MiB。	51200
DiskName	string	磁盘名称。	DiskName
uuid	string	UUID。	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	磁盘容量，单位：MiB。	20480
DiskId	string	磁盘 ID。	d-5ip4c2dhmas0rn7rt0p9****
Category	string	云盘或本地盘种类。取值： file：本地盘。 pangu：高效云盘。 local_hdd：本地 HDD。	file
name	string	磁盘名称。	DiskName
NetworkAttributes	object	网络返回信息。
NetworkId	string	网络 ID。	n-2zeuphj08tt7q3brd****
VSwitchId	string	交换机 ID。	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	实例私网返回信息。
	string	实例私网 IP 地址，如果指定了内网地址，则数量只能是 1。该 IP 地址必须为交换机（VSwitchId）网段的空闲地址。	172.17..
Tags	object
Tags	array<object>	实例的标签集合。重要此接口暂时不支持标签信息返回，可结合“标签”目录下的 API 进行组合使用
	object	标签信息。重要此接口暂时不支持标签信息返回，可结合“标签”目录下的 API 进行组合使用
TagValue	string	标签值	value1
TagKey	string	实例的标签键。	key1
AutoReleaseTime	string	自动释放时间。	2023-06-28T14:38:52Z
SpotStrategy	string	抢占式实例策略。	NoSpot
KeyPairName	string	密钥对名称。	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	弹性网卡信息组成的集合。
	array<object>	弹性网卡信息组成的集合。
Type	string	弹性网卡类型。取值范围： Primary：主网卡。 Secondary：辅助网卡。	Primary
MacAddress	string	弹性网卡的 MAC 地址。	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	主私网 IP。	10.XXX.XXX.25
NetworkInterfaceId	string	弹性网卡 ID。	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	PrivateIpSet 组成的集合。
	object	PrivateIpSet 组成的集合。
PrivateIpAddress	string	私网 IP。	192.XXX.XXX.130
Primary	boolean	是否是主私网 IP 地址。可能值： true：主私网 IP。 false：辅助私网 IP。	true
Ipv6Sets	object
Ipv6Set	array<object>	弹性网卡已分配的 IPv6 地址集合。
	object	弹性网卡已分配的 IPv6 地址集合。
Ipv6Address	string	弹性网卡已分配的 IPv6 地址。	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VpdVSwitchId	string
VpdId	string
ServiceStatus	string	实例的业务状态，不代表实例实际的运行状态。	Expired
DeletionProtection	boolean

示例

正常返回示例

JSON格式

{
  "Code": 0,
  "PageSize": 60,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "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": {
          "DataDisk": [
            {
              "device_type": "pangu",
              "disk_type": "system",
              "Size": 51200,
              "DiskName": "DiskName",
              "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
              "storage": 20480,
              "DiskId": "d-5ip4c2dhmas0vjd5u1r****",
              "Category": "file",
              "name": "name",
              "DiskSize": 100,
              "EncryptKeyId": "0e478b7a-4262-4802-b8cb-00d3fxxxxx",
              "Encrypted": true
            }
          ]
        },
        "PublicIpAddresses": {
          "PublicIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "unicom"
            }
          ]
        },
        "PrivateIpAddresses": {
          "PrivateIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "cmcc"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-5kyicq2kfcapxrdds6ta****"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.xx.xx"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "119.147.xx.xx"
          ]
        },
        "SystemDisk": {
          "device_type": "pangu",
          "disk_type": "system",
          "Size": 51200,
          "DiskName": "DiskName",
          "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
          "storage": 20480,
          "DiskId": "d-5ip4c2dhmas0rn7rt0p9****",
          "Category": "file",
          "name": "DiskName"
        },
        "NetworkAttributes": {
          "NetworkId": "n-2zeuphj08tt7q3brd****",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "Tags": {
          "Tags": [
            {
              "TagValue": "value1",
              "TagKey": "key1"
            }
          ]
        },
        "AutoReleaseTime": "2023-06-28T14:38:52Z",
        "SpotStrategy": "NoSpot",
        "KeyPairName": "TestKeyPairName",
        "NetworkInterfaces": {
          "NetworkInterfaces": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:XXX:XXX:60:0a",
              "PrimaryIpAddress": "10.XXX.XXX.25",
              "NetworkInterfaceId": "eni-53afk8a0t5lklbi8m7j8iczdg",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "192.XXX.XXX.130",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6"
                  }
                ]
              },
              "VpdVSwitchId": "",
              "VpdId": ""
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": true
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.	指定的实例ID不存在。
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	接口调用出错。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

变更历史

更多信息，参考变更详情。