調用DescribeInstances介面查詢執行個體詳細資料-邊緣節點服務 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	否	網路識別碼。	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	否

返回參數

名稱	類型	描述	樣本值
	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 金鑰識別碼。	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	網路識別碼。	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
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"
                  }
                ]
              }
            }
          ]
        },
        "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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。