DescribeInstances でインスタンスの詳細をクエリ - ENS - Alibaba Cloud - ENS

1 つ以上のインスタンスの詳細を取得します。

操作説明

API 呼び出しレート：800 リクエスト/秒。
単一ユーザーの API 呼び出しレート：100 リクエスト/秒。
リクエストパラメーターはフィルターとして機能し、論理 AND で結合されます。指定されていないパラメーターは無視されます。ただし、InstanceIds の空の JSON 配列は有効なフィルターであり、空の結果セットを返します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeInstances

list

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	リージョン ID。	cn-beijing-cmcc
InstanceId	string	任意	インスタンス ID。	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	任意	ノード ID の JSON 配列。最大 100 個の ID を指定できます。	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	任意	インスタンス ID の 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。このパラメーターを指定すると、エッジサービス用に作成されたインスタンスのみが返されます。	ens-20190730202316s****
InstanceResourceType	string	任意	リソースタイプ。有効な値： EnsInstance：サブスクリプションインスタンス。 EnsService：エッジサービスインスタンス。 BuildMachine：イメージビルドマシン。 EnsPostPaidInstance：従量課金インスタンス。	EnsService
SearchKey	string	任意	クエリのキーワード。このパラメーターを使用して、ip、InstanceName、または InstanceId でインスタンスを検索できます。	Joshua
NetworkId	string	任意	ネットワーク ID。	n-2zeuphj08tt7q3brd****
VSwitchId	string	任意	vSwitch の ID。	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	任意	セキュリティグループの ID。	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	任意	プライベート IP アドレス。	47.100.XX.XX
Tags	array<object>	任意	リソースのタグ。このパラメーターは返されません。タグサービスの操作を呼び出すことができます。
	object	任意	インスタンスのタグ。このパラメーターは返されません。タグサービスの操作を呼び出すことができます。
Key	string	任意	インスタンスのタグ N のキー。N の有効な値：1～20。	tag
Value	string	任意	インスタンスのタグ N の値。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	1 ページあたりのエントリ数。	60
PageNumber	integer	返された結果のページ番号。	1
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	クエリに一致するインスタンスの総数。	2
Instances	object
Instance	array<object>	インスタンスの詳細を含む `InstanceAttributesType` オブジェクトの配列。
	array<object>	インスタンスの詳細。
CreationTime	string	インスタンスが作成された時間。時間は協定世界時 (UTC) で、ISO 8601 形式：`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`：スマート NIC ベアメタル `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	最大パブリックインバウンド帯域幅。単位：Mbit/s。	40
InternetMaxBandwidthOut	integer	最大パブリックアウトバウンド帯域幅。単位：Mbit/s。	100
EnsRegionId	string	インスタンスのリージョン ID。	cn-hangzhou-telecom
Cpu	string	vCPU コア数。	2
ExpiredTime	string	有効期限。時間は協定世界時 (UTC) で、ISO 8601 形式：`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	データディスクの詳細。
device_type	string	ディスクカテゴリ。有効な値： 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>	パブリック IP アドレスに関する情報。
	object	パブリック IP アドレスに関する情報。
Ip	string	IP アドレス。	119.147.xx.xx
GateWay	string	ゲートウェイ。	119.147.xx.xx
Isp	string	ISP。	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	インスタンスのプライベート IP アドレスに関する情報。
	object
Ip	string	IP アドレス。	119.147.xx.xx
GateWay	string	ゲートウェイ。	119.147.xx.xx
Isp	string	ISP。	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	パブリック IP アドレス。
	string	パブリック IP アドレス。	119.147.xx.xx
SystemDisk	object	システムディスクの詳細。
device_type	string	ディスクカテゴリ。有効な値： 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	VSwitch の ID。	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	インスタンスのプライベート IP アドレスに関する情報。
	string	インスタンスのプライベート IP アドレス。1 つのプライベート IP アドレスのみ指定できます。IP アドレスは、指定された VSwitch (`VSwitchId`) の CIDR ブロック内の利用可能なアドレスである必要があります。	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 アドレスがプライマリプライベート IP アドレスであるかどうかを示します。有効な値： `true`：IP アドレスはプライマリプライベート IP アドレスです。 `false`：IP アドレスはセカンダリプライベート 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

例

成功レスポンス

JSONJSON

{
  "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": false
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。