DescribeInstances - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

指定されたリクエスト条件に基づいてインスタンスのリストを照会し、インスタンスの詳細情報を返します。

操作説明

始める前に

クラウドアシスタント CLI を使用して API 操作を呼び出す場合、異なるデータタイプのリクエストパラメーターが必須の形式であることを確認してください。詳細については、CLI パラメーター形式を参照してください。

使用上の注意

DryRun リクエストパラメーターを使用してドライランリクエストを送信し、パラメーターと権限付与の有効性を確認します。
結果の最初のページのページングクエリを実行する場合、返すエントリ数を制限するために MaxResults のみをセットします。応答の NextToken 値は、後続のページを照会するための認証情報として使用されます。後続のページのページングクエリを実行する場合、NextToken を前の応答から取得した NextToken 値にセットし、MaxResults をセットして返すエントリ数を制限します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeInstances

list

Instance

acs:ecs:{#regionId}:{#accountId}:instance/*

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

ResourceOwner

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
VpcId	string	任意	仮想プライベートクラウド (VPC) の ID。	v-bp67acfmxazb4p****
VSwitchId	string	任意	vSwitch ID。	vsw-bp67acfmxazb4p****
ZoneId	string	任意	ゾーン ID。	cn-hangzhou-g
InstanceNetworkType	string	任意	インスタンスのネットワークタイプ。有効な値: vpc: VPC。 classic: クラシックネットワーク。クラシックネットワークは非推奨です。詳細については、廃止のお知らせを参照してください。	vpc
SecurityGroupId	string	任意	インスタンスが属するセキュリティグループ。	sg-bp67acfmxazb4p****
InstanceIds	string	任意	インスタンス ID。値は最大 100 個のインスタンス ID で構成される JSON 配列です。ID はコンマ (,) で区切ります。	["i-bp67acfmxazb4p**", "i-bp67acfmxazb4p", … "i-bp67acfmxazb4p**"]
PageNumber	integer	任意	説明このパラメーターは間もなくオフラインになります。ページングクエリ操作を完了するには、NextToken と MaxResults を使用してください。	1
PageSize	integer	任意	説明このパラメーターは間もなくオフラインになります。ページングクエリ操作を完了するには、NextToken と MaxResults を使用してください。	10
NextToken	string	任意	クエリトークン。前の API 呼び出しで返された NextToken 値を設定します。	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	任意	ページングクエリの 1 ページあたりの最大エントリ数。最大値: 100。デフォルト値: このパラメーターを設定しないか、10 より小さい値に設定した場合、デフォルト値は 10 です。このパラメーターを 100 より大きい値に設定した場合、デフォルト値は 100 です。	10
InnerIpAddresses	string	任意	クラシックネットワークタイプのインスタンスの内部ネットワーク IP アドレス。このパラメーターは InstanceNetworkType が classic にセットされている場合に効果があります。値は最大 100 個の IP アドレスで構成される JSON 配列です。IP アドレスはコンマ (,) で区切ります。説明クラシックネットワーク機能はオフラインになりました。詳細については、オフラインのお知らせを参照してください。	["10.1.1.1", "10.1.2.1", … "10.1.10.1"]
PrivateIpAddresses	string	任意	VPC ネットワークタイプのインスタンスのプライベート IP アドレス。このパラメーターは InstanceNetworkType が vpc にセットされている場合に効果があります。値は最大 100 個の IP アドレスで構成される JSON 配列です。IP アドレスはコンマ (,) で区切ります。	["172.16.1.1", "172.16.2.1", … "172.16.10.1"]
PublicIpAddresses	string	任意	インスタンスのパブリック IP アドレス。値は最大 100 個の IP アドレスで構成される JSON 配列です。IP アドレスはコンマ (,) で区切ります。	["42.1.1.", "42.1.2.", … "42.1.10.**"]
EipAddresses	string	任意	インスタンスの EIP。このパラメーターは InstanceNetworkType が vpc にセットされている場合に効果があります。値は最大 100 個の IP アドレスで構成される JSON 配列です。IP アドレスはコンマ (,) で区切ります。	["42.1.1.", "42.1.2.", … "42.1.10.**"]
InstanceChargeType	string	任意	インスタンスの課金メソッド。有効な値: PostPaid: 従量課金。 PrePaid: サブスクリプション。	PostPaid
InternetChargeType	string	任意	パブリック帯域幅の課金メソッド。有効な値: PayByBandwidth: 帯域幅課金。 PayByTraffic: トラフィック課金。説明トラフィック課金モードでは、ピークインバウンドおよびアウトバウンド帯域幅は帯域幅の上限として使用され、保証されません。リソース競合が発生した場合、ピーク帯域幅が制限される場合があります。帯域幅の保証が必要な場合は、帯域幅課金モードを使用してください。	PayByTraffic
InstanceName	string	任意	インスタンス名。ワイルドカード * を使用したあいまい検索がサポートされています。	Test
ImageId	string	任意	イメージ ID	m-bp67acfmxazb4p****
Status	string	任意	インスタンスステータス。有効な値: Pending: 作成中。 Running: 実行中。 Starting: 起動中。 Stopping: 停止中。 Stopped: 停止済み。	Running
LockReason	string	任意	リソースがロックされている理由。有効な値: financial: 支払い遅延によりロック済み。 security: セキュリティ上の理由によりロック済み。 Recycling: スポットインスタンスがリリース待ち。 dedicatedhostfinancial: 専用ホストの支払い遅延により ECS インスタンスがロック済み。 refunded: 返金によりロック済み。	security
Filter.1.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `CreationStartTime` に設定します。`Filter.1.Key` と `Filter.1.Value` の両方を設定して、指定した時間のポイント以降に作成されたリソースをクエリします。	CreationStartTime
Filter.2.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `CreationEndTime` に設定します。`Filter.2.Key` と `Filter.2.Value` の両方を設定して、指定した時間のポイント以前に作成されたリソースをクエリします。	CreationEndTime
Filter.3.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `ExpiredStartTime` に設定します。`Filter.3.Key` と `Filter.3.Value` の両方を設定して、指定した時間のポイント以降に有効期限切れになるリソースをクエリします。	ExpiredStartTime
Filter.4.Key	string	任意	リソースのクエリに使用するフィルターキー。値を `ExpiredEndTime` に設定します。`Filter.4.Key` と `Filter.4.Value` の両方を設定して、指定した時間のポイント以前に有効期限切れになるリソースをクエリします。	ExpiredEndTime
Filter.1.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.1.Key` も指定する必要があります。時間は協定世界時 (UTC)+0 の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2017-12-05T22:40Z
Filter.2.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.2.Key` も指定する必要があります。時間は協定世界時 (UTC)+0 の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2017-12-06T22:40Z
Filter.3.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.3.Key` も指定する必要があります。時間は協定世界時 (UTC)+0 の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2017-12-07T22:40Z
Filter.4.Value	string	任意	リソースのクエリに使用するフィルター値。このパラメーターを指定する場合、`Filter.4.Key` も指定する必要があります。時間は協定世界時 (UTC)+0 の `yyyy-MM-ddTHH:mmZ` 形式で指定します。	2017-12-08T22:40Z
DeviceAvailable	boolean	任意	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	false
IoOptimized	boolean	任意	インスタンスが I/O 最適化されているかどうかを指定します。有効な値: true: インスタンスは I/O 最適化されています。 false: インスタンスは I/O 最適化されていません。	true
NeedSaleCycle	boolean	任意	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	false
InstanceType	string	任意	インスタンスタイプ	ecs.g5.large
InstanceTypeFamily	string	任意	インスタンスファミリー。	ecs.g5
KeyPairName	string	任意	インスタンスが使用する SSH キーペアの名前。	KeyPairNameTest
ResourceGroupId	string	任意	インスタンスが属するリソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1,000 を超えることはできません。説明デフォルトのリソースグループによるフィルターはサポートされていません。	rg-bp67acfmxazb4p****
HpcClusterId	string	任意	インスタンスが属する HPC クラスターの ID。	hpc-bp67acfmxazb4p****
RdmaIpAddresses	string	任意	HPC インスタンスの RDMA IP アドレス。	10.10.10.102
DryRun	boolean	任意	ドライランのみを実行するかどうかを指定します。有効な値: true: ドライランのみを実行します。システムは、無効な AccessKey ペア、権限のない RAM ユーザー、欠落しているパラメーター値など、リクエストの潜在的な問題をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに合格した場合、DryRunOperation エラーコードが返されます。 false: ドライランを実行し、リクエストを送信します。リクエストがドライランに合格した場合、2XX HTTP 状態コードが返され、操作が実行されます。デフォルト値: false。	false
HttpEndpoint	string	任意	インスタンスメタデータのアクセスチャンネルを有効にするかどうかを指定します。有効な値: enabled: 有効。 disabled: 無効。デフォルト値: enabled。説明インスタンスメタデータの詳細については、インスタンスメタデータの概要を参照してください。	enabled
HttpTokens	string	任意	インスタンスメタデータへのアクセスにセキュリティ強化モード (IMDSv2) を強制的に使用するかどうかを指定します。有効な値: optional: セキュリティ強化モードを強制的に使用しません。必須: セキュリティ強化モードを強制的に使用します。この値をセットすると、通常モードではインスタンスメタデータにアクセスできなくなります。デフォルト値: optional。説明インスタンスメタデータのアクセスモードの詳細については、インスタンスメタデータのアクセスモードを参照してください。	optional
HttpPutResponseHopLimit	integer	任意	説明このパラメーターは一般公開されていません。	0
Ipv6Address	array	任意	ネットワークインターフェース (NIC) に割り当てられた IPv6 アドレス。
	string	任意	ネットワークインターフェース (NIC) の IPv6 アドレス。N は複数の IPv6 アドレスをセットできることを示します。N の有効な値: 1～100。	2408:4321:180:1701:94c7:bc38:3bfa:****
Tag	array<object>	任意	タグ。
	object	任意	タグ。
key	string	任意	タグキー。説明互換性を高めるため、代わりに `Tag.N.Key` を使用してください。	keyTest
Key	string	任意	インスタンスのタグキー。N の有効な値: 1～20。単一のタグを使用してリソースをフィルターする場合、そのタグを持つリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付与されたリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources 操作を呼び出してください。	TestKey
Value	string	任意	インスタンスのタグ値。N の有効な値: 1～20。	TestValue
value	string	任意	タグ値。説明互換性を高めるため、代わりに `Tag.N.Value` を使用してください。	valueTest
AdditionalAttributes	array	任意	インスタンスの追加属性のリスト。	META_OPTIONS
	string	任意	追加属性の値。N の有効な値: 1～5。有効な値: META_OPTIONS: インスタンスメタデータ。 DDH_CLUSTER: 専用ホストクラスター。 NETWORK_PRIMARY_ENI_IP: プライマリ ENI のセカンダリ IP アドレス。 PRIVATE_DNS_OPTIONS: プライベートドメイン名情報。 CPU_OPTIONS_TOPOLOGY_TYPE: インスタンスの CPU トポロジータイプ。 CURRENT_OS_NVME_SUPPORTED: 現在のオペレーティングシステムが NVMe プロトコルによるクラウドディスクへのアクセスをサポートしているかどうか。 LOGIN_AS_NON_ROOT: インスタンスが ecs-user ユーザーとしてのログインを許可するように構成されているかどうか。	META_OPTIONS

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	この呼び出しで返されたクエリトークン。	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	照会されたインスタンスの総数。説明 `MaxResults` と `NextToken` パラメーターを使用してページングクエリを行う場合、返される `TotalCount` パラメーター値は意味を持ちません。	1
Instances	object
Instance	array<object>	インスタンスの配列。
	array<object>
CreationTime	string	インスタンスが作成された時刻。時刻はISO 8601 規格に準拠し、yyyy-MM-ddTHH:mmZ 形式です。時刻はUTC+0で表示されます。詳細については、ISO 8601を参照してください。	2017-12-10T04:04Z
SerialNumber	string	インスタンスのシリアル番号。	51d1353b-22bf-4567-a176-8b3e12e4****
Status	string	インスタンスのステータス。	Running
DeploymentSetId	string	デプロイメントセットのID。	ds-bp67acfmxazb4p****
KeyPairName	string	キーペアの名前。	testKeyPairName
SaleCycle	string	説明このパラメータは非推奨であり、意味のあるデータを返しません。	month
SpotStrategy	string	従量課金インスタンスの入札戦略。有効な値： NoSpot：通常の従量課金インスタンス。 SpotWithPriceLimit：ユーザー定義の最大時間単価を持つスポットインスタンス。 SpotAsPriceGo：従量課金価格を上限とする市場価格のスポットインスタンス。	NoSpot
DeviceAvailable	boolean	データクラウドディスクをインスタンスにアタッチできるかどうかを示します。 true：データクラウドディスクをアタッチできます。 false：データクラウドディスクをアタッチできません。	true
LocalStorageCapacity	integer	インスタンスにアタッチされたローカルストレージのストレージ容量。単位：GiB。	1000
Description	string	インスタンスの説明。	testDescription
SpotDuration	integer	スポットインスタンスの保護期間。単位：時間。有効な値： 1：インスタンスが作成された後、Alibaba Cloudは1 時間以内にインスタンスが自動リリースの対象にならないことを保証します。1 時間後、システムは入札価格とマーケットプレイス価格を自動的に比較し、リソースの可用性を確認して、インスタンスを保持するかどうかを決定します。 0：インスタンスが作成された後、Alibaba Cloudはインスタンスが1 時間実行されることを保証しません。システムは入札価格とマーケットプレイス価格を自動的に比較し、リソースの可用性を確認して、インスタンスを保持するかどうかを決定します。 Alibaba Cloudは、インスタンスが取り消される5 分前にECSシステムイベント通知を送信します。スポットインスタンスは秒単位で課金されます。予想されるタスク実行時間に基づいて適切な保護期間を選択してください。説明このパラメータは、SpotStrategyがSpotWithPriceLimitまたはSpotAsPriceGoに設定されている場合にのみ返されます。	1
InstanceNetworkType	string	インスタンスのネットワークタイプ。有効な値： classic：クラシックネットワーク。 vpc：VPC。	vpc
InstanceName	string	インスタンス名	InstanceNameTest
OSNameEn	string	インスタンスのオペレーティングシステムの英語名。	CentOS 7.4 64 bit
HpcClusterId	string	インスタンスが属するHPCクラスターのID。	hpc-bp67acfmxazb4p****
SpotPriceLimit	number	インスタンスの最大時間単価。小数点以下 3 桁までサポートされています。このパラメータは、SpotStrategyがSpotWithPriceLimitに設定されている場合に有効です。	0.98
Memory	integer	メモリサイズ。単位：MiB。	16384
OSName	string	インスタンスのオペレーティングシステムの名前。	CentOS 7.4 64 位
DeploymentSetGroupNo	integer	分散デプロイ用のデプロイメントセットにインスタンスがアタッチされている場合の、デプロイメントセット内のECSインスタンスのグループ番号。	1
ImageId	string	インスタンスが実行しているイメージのID。	m-bp67acfmxazb4p****
VlanId	string	インスタンスのVLAN ID。説明このパラメータは非推奨になる予定です。互換性を高めるために、他のパラメータを使用してください。	10
ClusterId	string	インスタンスが属するクラスターのID。説明このパラメータは非推奨になる予定です。互換性を高めるために、他のパラメータを使用してください。	c-bp67acfmxazb4p****
ClockOptions	object
PtpStatus	string
GPUSpec	string	インスタンスタイプのGPUタイプ。	NVIDIA V100
AutoReleaseTime	string	従量課金インスタンスの自動リリース時刻。	2017-12-10T04:04Z
DeletionProtection	boolean	インスタンスのリリース保護属性。ECSコンソールまたはDeleteInstance 操作の呼び出しによりインスタンスをリリースできるかどうかを指定します。 true：リリース保護が有効。 false：リリース保護が無効。説明この属性は従量課金インスタンスにのみ適用されます。手動リリース操作のみを制限でき、システムによるリリースには影響しません。	false
StoppedMode	string	インスタンスが停止した後も課金が継続されるかどうかを示します。有効な値： KeepCharging：インスタンスは停止後も課金が継続されます。コンピューティングリソースなどのリソースはインスタンスに保持されます。 StopCharging：インスタンスは停止後に課金されません。vCPU、メモリ、パブリックIPアドレスなどのリソースがリリースされます。インスタンスを再起動できるかどうかは、現在のリージョンのリソースの可用性に依存します。 Not-applicable：インスタンスは節約モードをサポートしていません。	KeepCharging
GPUAmount	integer	インスタンスタイプのGPU 数。	4
HostName	string	インスタンスのホスト名。	testHostName
InstanceId	string	インスタンスID。	i-bp67acfmxazb4p****
InternetMaxBandwidthOut	integer	パブリックネットワークの最大送信帯域幅。単位：Mbit/s。	5
InternetMaxBandwidthIn	integer	パブリックネットワークの最大受信帯域幅。単位：Mbit/s。	50
InstanceType	string	インスタンスタイプ。	ecs.g5.large
InstanceChargeType	string	インスタンスの課金方式。有効な値： PrePaid：サブスクリプション。 PostPaid：従量課金。	PostPaid
RegionId	string	インスタンスのリージョンID。	cn-hangzhou
IoOptimized	boolean	インスタンスがI/O 最適化されているかどうかを示します。 true：インスタンスはI/O 最適化されています。 false：インスタンスはI/O 最適化されていません。	true
StartTime	string	インスタンスの最新の起動時刻。時刻はISO 8601 規格に準拠し、yyyy-MM-ddTHH:mmZ 形式です。時刻はUTC+0で表示されます。詳細については、ISO 8601を参照してください。	2017-12-10T04:04Z
Cpu	integer	vCPUの数。	8
LocalStorageAmount	integer	インスタンスにアタッチされたローカルストレージデバイスの数。	2
ExpiredTime	string	有効期限。時刻はISO 8601 規格に準拠し、yyyy-MM-ddTHH:mmZ 形式です。時刻はUTC+0で表示されます。詳細については、ISO 8601を参照してください。	2017-12-10T04:04Z
ResourceGroupId	string	インスタンスが属するリソースグループのID。	rg-bp67acfmxazb4p****
InternetChargeType	string	ネットワーク使用量の課金方式。有効な値： PayByBandwidth：帯域幅課金。 PayByTraffic：トラフィック課金。	PayByTraffic
ZoneId	string	インスタンスのゾーンID。	cn-hangzhou-g
Recyclable	boolean	インスタンスをリサイクルできるかどうかを示します。	false
ISP	string	説明このパラメータは招待プレビュー中であり、一般には公開されていません。	null
CreditSpecification	string	バースト可能インスタンスのパフォーマンスモード。有効な値： Standard：標準モード。インスタンスのパフォーマンスの詳細については、バースト可能インスタンスの概要のパフォーマンス制約モードセクションを参照してください。 Unlimited：無制限モード。インスタンスのパフォーマンスの詳細については、バースト可能インスタンスの概要の無制限モードセクションを参照してください。	Standard
InstanceTypeFamily	string	インスタンスファミリー。	ecs.g5
OSType	string	インスタンスのオペレーティングシステムタイプ。有効な値： windows。 linux。	linux
NetworkInterfaces	object
NetworkInterface	array<object>	インスタンスにアタッチされたElastic Network Interface（ENI）およびネットワークインターフェースコントローラー（NIC）のコレクション。
	array<object>	インスタンスにアタッチされたElastic Network Interface（ENI）およびネットワークインターフェースコントローラー（NIC）のコレクション。
Type	string	ネットワークインターフェースコントローラー（NIC）のタイプ。有効な値： Primary：プライマリENI。 Secondary：セカンダリENI。	Primary
MacAddress	string	ネットワークインターフェースコントローラー（NIC）のMACアドレス。	00:16:3e:32:b4:**
PrimaryIpAddress	string	ネットワークインターフェースコントローラー（NIC）のプライマリプライベートIPアドレス。	172.17..*
NetworkInterfaceId	string	ネットワークインターフェースコントローラー（NIC）のID。	eni-2zeh9atclduxvf1z****
PrivateIpSets	object
PrivateIpSet	array<object>	PrivateIpSetエントリのコレクション。
	object
PrivateIpAddress	string	インスタンスのプライベートIPアドレス。	172.17..
Primary	boolean	IPアドレスがプライマリプライベートIPアドレスかどうかを示します。有効な値： true：IPアドレスはプライマリプライベートIPアドレスです。 false：IPアドレスはプライマリプライベートIPアドレスではありません。	true
PrivateDnsName	string	インスタンスのプライベートドメイン名。説明このパラメータは、HostnameTypeがIpBasedまたはInstanceIdBasedに設定されている場合にのみ返されます。固定形式のプライベートドメイン名が返されます。	dnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv6アドレスのコレクション。このパラメータは、AdditionalAttributes.NリクエストパラメータがNETWORK_PRIMARY_ENI_IPに設定されている場合にのみ返されます。
	object
Ipv6Address	string	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv6アドレス。	2408:4321:180:1701:94c7:bc38:3bfa:***
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv4プレフィックスのコレクション。このパラメータは、AdditionalAttributes.NリクエストパラメータがNETWORK_PRIMARY_ENI_IPに設定されている場合にのみ返されます。
	object
Ipv4Prefix	string	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv4プレフィックス。	192.168../28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv6プレフィックスのコレクション。このパラメータは、AdditionalAttributes.NリクエストパラメータがNETWORK_PRIMARY_ENI_IPに設定されている場合にのみ返されます。
	object
Ipv6Prefix	string	ネットワークインターフェースコントローラー（NIC）に割り当てられたIPv6プレフィックス。	2001:1111::::/80
OperationLocks	object
LockReason	array<object>	インスタンスがロックされている理由。
	object
LockMsg	string	インスタンスのロックの説明。	The specified instance is locked due to financial reason.
LockReason	string	ロックタイプ。有効な値： financial：支払い遅延によりロック。 security：セキュリティ上の理由によりロック。 Recycling：スポットインスタンスはリリース保留中。 dedicatedhostfinancial：専有ホストの支払い遅延によりECSインスタンスがロック。 refunded：返金によりロック。	Recycling
Tags	object
Tag	array<object>	インスタンスのタグのコレクション。
	object
TagValue	string	インスタンスのタグ値。	TestValue
TagKey	string	インスタンスのタグキー。	TestKey
RdmaIpAddress	object
IpAddress	array	HPCインスタンスのRDMA IPアドレスのリスト。
	string	HPCインスタンスのRDMA IPアドレス。	10.10.10.102
SecurityGroupIds	object
SecurityGroupId	array	インスタンスが属するセキュリティグループIDのリスト。
	string	セキュリティグループID。	sg-bp67acfmxazb4p****
PublicIpAddress	object
IpAddress	array	インスタンスのパブリックIPアドレスのリスト。
	string	インスタンスのパブリックIPアドレス。	121.40..
InnerIpAddress	object
IpAddress	array	ネットワークタイプがクラシックネットワークのインスタンスの内部ネットワークIPアドレスのリスト。
	string	ネットワークタイプがクラシックネットワークのインスタンスの内部ネットワークIPアドレス。	10.170..
VpcAttributes	object	VPC 属性。
VpcId	string	仮想プライベートクラウド（VPC）のID。	vpc-2zeuphj08tt7q3brd****
NatIpAddress	string	VPCタイプのクラウドサービス間のネットワーク接続に使用されるクラウドサービスのIPアドレス。	172.17..
VSwitchId	string	vSwitch ID。	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	プライベートIPアドレスのリスト。
	string	プライベートIPアドレス。	172.17..
EipAddress	object	インスタンスにバインドされたEIPの情報。
IsSupportUnassociate	boolean	EIPをインスタンスから関連付け解除できるかどうかを示します。	true
InternetChargeType	string	EIPの課金方式。 PayByBandwidth：帯域幅課金。 PayByTraffic：トラフィック課金。	PayByTraffic
IpAddress	string	EIP。	42.112..
Bandwidth	integer	EIPのパブリック帯域幅上限。単位：Mbit/s。	5
AllocationId	string	EIPのID。	eip-2ze88m67qx5z****
HibernationOptions	object	説明このパラメータは招待プレビュー中であり、一般には公開されていません。
Configured	boolean	説明このパラメータは招待プレビュー中であり、一般には公開されていません。	false
DedicatedHostAttribute	object	ホスト属性。専有ホストクラスターID（DedicatedHostClusterId）、専有ホストID（DedicatedHostId）、および専有ホスト名（DedicatedHostName）で構成されます。
DedicatedHostId	string	専有ホストのID。	dh-bp67acfmxazb4p****
DedicatedHostName	string	専有ホストの名前。	testDedicatedHostName
DedicatedHostClusterId	string	専有ホストクラスターのID。	dc-bp67acfmxazb4h****
EcsCapacityReservationAttr	object	Elastic Compute Service（ECS）のキャパシティリザベーション関連パラメータ。
CapacityReservationPreference	string	キャパシティリザベーションの設定。	cr-bp67acfmxazb4p****
CapacityReservationId	string	キャパシティリザベーションのID。	cr-bp67acfmxazb4p****
DedicatedInstanceAttribute	object	専有ホスト上のインスタンスの属性。
Affinity	string	専有ホスト上のインスタンスが専有ホストに関連付けられているかどうかを示します。有効な値： default：インスタンスは専有ホストに関連付けられていません。節約モードのインスタンスが再起動されると、インスタンスは自動デプロイプール内の別の専有ホストに配置される場合があります。 host：インスタンスは専有ホストに関連付けられています。節約モードのインスタンスが再起動されると、インスタンスは元の専有ホストに残ります。	default
Tenancy	string	インスタンスのホストタイプが専有ホストかどうかを示します。有効な値： default：インスタンスのホストタイプは専有ホストではありません。 host：インスタンスのホストタイプは専有ホストです。	default
CpuOptions	object	CPUの設定詳細。
Numa	string	説明このパラメータは非推奨です。	null
CoreCount	integer	物理 CPUコアの数。	2
ThreadsPerCore	integer	CPUコアあたりのスレッド数。	2
TopologyType	string	インスタンスのCPUトポロジータイプ。有効な値： ContinuousCoreToHTMapping：HTディスクリートモード。 DiscreteCoreToHTMapping：HTコンティニュアスモード。	DiscreteCoreToHTMapping
EnableVISST	boolean
TurboMode	string
EnableVRDT	boolean
NestedVirtualization	string	ネストされた仮想化が有効かどうかを示します。	enabled
MetadataOptions	object	メタデータオプションのコレクション。
HttpEndpoint	string	インスタンスメタデータのアクセスチャネルが有効かどうかを示します。有効な値： enabled：有効。 disabled：無効。	enabled
HttpPutResponseHopLimit	integer	説明このパラメータは一般には公開されていません。	0
HttpTokens	string	インスタンスメタデータへのアクセスにセキュリティ強化モード（IMDSv2）が強制的に使用されているかどうかを示します。有効な値： optional：強制的に使用されていない。 required：強制的に使用されている。	optional
InstanceMetadataTags	string
ImageOptions	object	イメージ関連の属性情報。
LoginAsNonRoot	boolean	イメージを使用するインスタンスがecs-userユーザーとしてのログオンをサポートしているかどうかを示します。有効な値： true：サポートされています。 false：サポートされていません。	false
CurrentOSNVMeSupported	boolean	現在のオペレーティングシステムがNVMeプロトコルでクラウドディスクへのアクセスをサポートしているかどうかを示します。有効な値： true：サポートされています。 false：サポートされていません。説明このパラメータは、AdditionalAttributesリクエストパラメータにCURRENT_OS_NVME_SUPPORTEDが含まれている場合にのみ返されます。	true
SpotInterruptionBehavior	string	プラットフォームが中断を開始した場合のスポットインスタンスの中断モード。有効な値： Terminate：リリース。 Stop：節約モード。	Terminate
PrivateDnsNameOptions	object	インスタンスのプライベートドメイン名設定情報のコレクション。プライベートドメイン名解決の詳細については、ECSプライベートドメイン名解決を参照してください。説明このパラメータは、`AdditionalAttributes`リクエストパラメータに`PRIVATE_DNS_OPTIONS`が含まれている場合にのみ返されます。
EnableInstanceIdDnsARecord	boolean	インスタンスIDベースのドメイン名からIPv4への名前解決が有効かどうかを示します。有効な値： true：有効。 false：無効。デフォルト値：false。	false
EnableInstanceIdDnsAAAARecord	boolean	インスタンスIDベースのドメイン名からIPv6への名前解決が有効かどうかを示します。有効な値： true：有効。 false：無効。デフォルト値：false。	false
EnableIpDnsARecord	boolean	IPベースのドメイン名からIPv4への名前解決が有効かどうかを示します。有効な値： true：有効。 false：無効。デフォルト値：false。	true
EnableIpDnsPtrRecord	boolean	IPv4からIPベースのドメイン名への名前解決が有効かどうかを示します。有効な値： true：有効。 false：無効。デフォルト値：false。	true
HostnameType	string	ホスト名のタイプ。有効な値： Custom：カスタム。 IpBased：IPベースのホスト名。 InstanceIdBased：インスタンスIDベースのホスト名。デフォルト値：Custom。	Custom
AdditionalInfo	object	説明このパラメータは招待プレビュー中であり、一般には公開されていません。
EnableHighDensityMode	boolean	説明このパラメータは招待プレビュー中であり、一般には公開されていません。	true
NodeSerialNumber	string
EnableNVS	boolean

例

成功レスポンス

JSONJSON

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2017-12-10T04:04Z",
        "SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e4****",
        "Status": "Running",
        "DeploymentSetId": "ds-bp67acfmxazb4p****",
        "KeyPairName": "testKeyPairName",
        "SaleCycle": "month",
        "SpotStrategy": "NoSpot",
        "DeviceAvailable": true,
        "LocalStorageCapacity": 1000,
        "Description": "testDescription",
        "SpotDuration": 1,
        "InstanceNetworkType": "vpc",
        "InstanceName": "InstanceNameTest",
        "OSNameEn": "CentOS  7.4 64 bit",
        "HpcClusterId": "hpc-bp67acfmxazb4p****",
        "SpotPriceLimit": 0.98,
        "Memory": 16384,
        "OSName": "CentOS  7.4 64 位",
        "DeploymentSetGroupNo": 1,
        "ImageId": "m-bp67acfmxazb4p****",
        "VlanId": "10",
        "ClusterId": "c-bp67acfmxazb4p****",
        "ClockOptions": {
          "PtpStatus": ""
        },
        "GPUSpec": "NVIDIA V100",
        "AutoReleaseTime": "2017-12-10T04:04Z",
        "DeletionProtection": false,
        "StoppedMode": "KeepCharging",
        "GPUAmount": 4,
        "HostName": "testHostName",
        "InstanceId": "i-bp67acfmxazb4p****",
        "InternetMaxBandwidthOut": 5,
        "InternetMaxBandwidthIn": 50,
        "InstanceType": "ecs.g5.large",
        "InstanceChargeType": "PostPaid",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "StartTime": "2017-12-10T04:04Z",
        "Cpu": 8,
        "LocalStorageAmount": 2,
        "ExpiredTime": "2017-12-10T04:04Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "InternetChargeType": "PayByTraffic",
        "ZoneId": "cn-hangzhou-g",
        "Recyclable": false,
        "ISP": "null",
        "CreditSpecification": "Standard",
        "InstanceTypeFamily": "ecs.g5",
        "OSType": "linux",
        "NetworkInterfaces": {
          "NetworkInterface": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:3e:32:b4:**",
              "PrimaryIpAddress": "172.17.**.***",
              "NetworkInterfaceId": "eni-2zeh9atclduxvf1z****",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "172.17.**.**",
                    "Primary": true,
                    "PrivateDnsName": "dnsTestName"
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:***"
                  }
                ]
              },
              "Ipv4PrefixSets": {
                "Ipv4PrefixSet": [
                  {
                    "Ipv4Prefix": "192.168.*.*/28"
                  }
                ]
              },
              "Ipv6PrefixSets": {
                "Ipv6PrefixSet": [
                  {
                    "Ipv6Prefix": "2001:1111:*:*::/80"
                  }
                ]
              }
            }
          ]
        },
        "OperationLocks": {
          "LockReason": [
            {
              "LockMsg": "The specified instance is locked due to financial reason.",
              "LockReason": "Recycling"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "RdmaIpAddress": {
          "IpAddress": [
            "10.10.10.102"
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-bp67acfmxazb4p****"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "121.40.**.**"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.**.**"
          ]
        },
        "VpcAttributes": {
          "VpcId": "vpc-2zeuphj08tt7q3brd****",
          "NatIpAddress": "172.17.**.**",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "EipAddress": {
          "IsSupportUnassociate": true,
          "InternetChargeType": "PayByTraffic",
          "IpAddress": "42.112.**.**",
          "Bandwidth": 5,
          "AllocationId": "eip-2ze88m67qx5z****"
        },
        "HibernationOptions": {
          "Configured": false
        },
        "DedicatedHostAttribute": {
          "DedicatedHostId": "dh-bp67acfmxazb4p****",
          "DedicatedHostName": "testDedicatedHostName",
          "DedicatedHostClusterId": "dc-bp67acfmxazb4h****"
        },
        "EcsCapacityReservationAttr": {
          "CapacityReservationPreference": "cr-bp67acfmxazb4p****",
          "CapacityReservationId": "cr-bp67acfmxazb4p****"
        },
        "DedicatedInstanceAttribute": {
          "Affinity": "default",
          "Tenancy": "default"
        },
        "CpuOptions": {
          "Numa": "null",
          "CoreCount": 2,
          "ThreadsPerCore": 2,
          "TopologyType": "DiscreteCoreToHTMapping",
          "EnableVISST": false,
          "TurboMode": "",
          "EnableVRDT": false,
          "NestedVirtualization": "enabled"
        },
        "MetadataOptions": {
          "HttpEndpoint": "enabled",
          "HttpPutResponseHopLimit": 0,
          "HttpTokens": "optional",
          "InstanceMetadataTags": ""
        },
        "ImageOptions": {
          "LoginAsNonRoot": false,
          "CurrentOSNVMeSupported": true
        },
        "SpotInterruptionBehavior": "Terminate",
        "PrivateDnsNameOptions": {
          "EnableInstanceIdDnsARecord": false,
          "EnableInstanceIdDnsAAAARecord": false,
          "EnableIpDnsARecord": true,
          "EnableIpDnsPtrRecord": true,
          "HostnameType": "Custom"
        },
        "AdditionalInfo": {
          "EnableHighDensityMode": true,
          "NodeSerialNumber": ""
        },
        "EnableNVS": false
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.
400	InvalidTagCount	The specified tags are beyond the permitted range.
400	InvalidHpcClusterId.NotFound	The specified HpcClusterId is not found.
400	InvalidHpcClusterId.Creating	The specified HpcClusterId is creating.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
400	Throttling.PageNumberLimited	Request throttled. Please use NextToken instead of PageNumber for pagination.
404	InvalidInstanceChargeType.NotFound	The InstanceChargeType does not exist in our records.
404	InvalidInternetChargeType.ValueNotSupported	The specified InternetChargeType is not valid.
404	InvalidLockReason.NotFound	The specified LockReason is not found.
404	InvalidFilterKey.NotFound	Invalid filter.%s.
404	InvalidFilterValue	Invalid filter.%s.
404	InvalidNetworkType.NotFound	The specified InstanceNetworkType is not found.
404	InvalidStatus.NotFound	The specified Status is not found.

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

変更履歴

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