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

インスタンス。

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

インスタンス。

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

ResourceOwner

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
VpcId	string	任意	Virtual Private Cloud (VPC) の ID。	v-bp67acfmxazb4p****
VSwitchId	string	任意	vSwitch の ID。	vsw-bp67acfmxazb4p****
ZoneId	string	任意	ゾーン ID。	cn-hangzhou-g
InstanceNetworkType	string	任意	インスタンスのネットワークタイプ。有効な値: vpc: VPC。 classic: クラシックネットワーク。クラシックネットワークは利用できなくなりました。詳細については、「廃止のお知らせ」を参照してください。	vpc
SecurityGroupId	string	任意	インスタンスが属するセキュリティグループの ID。	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: 返金が行われたためリソースがロック済みです。	セキュリティ
Filter.1.Key	string	任意	リソースのクエリに使用されるフィルター 1 のキー。値を `CreationStartTime` に設定します。Filter.1.Key と Filter.1.Value の両方を指定して、指定された時間のポイント以降に作成されたリソースをクエリできます。	CreationStartTime
Filter.2.Key	string	任意	リソースのクエリに使用されるフィルター 2 のキー。値を `CreationEndTime` に設定します。Filter.2.Key と Filter.2.Value の両方を指定して、指定された時間のポイントより前に作成されたリソースをクエリできます。	CreationEndTime
Filter.3.Key	string	任意	リソースのクエリに使用されるフィルター 3 のキー。値を `ExpiredStartTime` に設定します。Filter.3.Key と Filter.3.Value の両方を指定して、指定された時間のポイント以降に有効期限切れとなるリソースをクエリできます。	ExpiredStartTime
Filter.4.Key	string	任意	リソースのクエリに使用されるフィルター 4 のキー。値を `ExpiredEndTime` に設定します。Filter.4.Key と Filter.4.Value の両方を指定して、指定された時間のポイントより前に有効期限切れとなるリソースをクエリできます。	ExpiredEndTime
Filter.1.Value	string	任意	リソースのクエリに使用されるフィルター 1 の値。このパラメーターを指定する場合は、`Filter.1.Key` も指定する必要があります。時間を協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 初期化で指定します。	2017-12-05T22:40Z
Filter.2.Value	string	任意	リソースのクエリに使用されるフィルター 2 の値。このパラメーターを指定する場合は、`Filter.2.Key` も指定する必要があります。時間を協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 初期化で指定します。	2017-12-06T22:40Z
Filter.3.Value	string	任意	リソースのクエリに使用されるフィルター 3 の値。このパラメーターを指定する場合は、`Filter.3.Key` も指定する必要があります。時間を協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 初期化で指定します。	2017-12-07T22:40Z
Filter.4.Value	string	任意	リソースのクエリに使用されるフィルター 4 の値。このパラメーターを指定する場合は、`Filter.4.Key` も指定する必要があります。時間を協定世界時 (UTC) の `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 ペア、権限のない Resource Access Management (RAM) ユーザー、パラメーター値の欠落など、リクエストの潜在的な問題をチェックします。リクエストがドライランに失敗した場合、エラーメッセージが返されます。リクエストがドライランに成功した場合、DryRunOperation エラーコードが返されます。 false: ドライランを実行し、リクエストを送信します。リクエストがドライランに成功した場合、2XX HTTP 状態コードが返され、操作が実行されます。デフォルト値: false。	false
HttpEndpoint	string	任意	インスタンスメタデータへのアクセスチャンネルが有効かどうかを指定します。有効な値: enabled: 有効。 disabled: 無効。デフォルト値: enabled。説明インスタンスメタデータの詳細については、「ECS インスタンスメタデータの概要」を参照してください。	enabled
HttpTokens	string	任意	インスタンスメタデータにアクセスするときに強化モード (IMDSv2) を強制的に使用するかどうかを指定します。有効な値: optional: 強化モードは強制的に使用されません。 required: 強化モードが強制的に使用されます。このパラメーターを必須にセットした後、通常のパターンでインスタンスメタデータにアクセスすることはできません。デフォルト値: optional。説明インスタンスメタデータのアクセスパターンについては、「インスタンスメタデータのアクセスモード」を参照してください。	optional
HttpPutResponseHopLimit	integer	任意	説明このパラメーターはまだ利用できません。	0
Ipv6Address	array	任意	Elastic Network Interface (ENI) に割り当てられた IPv6 アドレス。
	string	任意	Elastic Network Interface (ENI) の IPv6 アドレス。N は、複数の IPv6 アドレスを設定できることを示します。N の有効値: 1～100。	2408:4321:180:1701:94c7:bc38:3bfa:****
Tag	array<object>	任意	タグ。
	object	任意	タグ。
Key	string	任意	インスタンスのタグキー。N の有効値: 1～20。単一のタグを使用してリソースをフィルター処理する場合、このタグを持つリソースの数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、指定されたすべてのタグがアタッチされているリソースの数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources 操作を使用してリソースをクエリしてください。	TestKey
Value	string	任意	インスタンスのタグ値。N の有効値: 1～20。	TestValue
key	string	任意	タグキー。説明互換性を向上させるには、代わりに Tag.N.Key パラメーターを使用してください。	keyTest
value	string	任意	タグ値。説明互換性を向上させるには、代わりに Tag.N.Value パラメーターを使用してください。	値Test
AdditionalAttributes	array	任意	インスタンスの追加プロパティのリスト。	META_OPTIONS
	string	任意	追加プロパティの値。N の有効値: 1～5。有効な値: META_OPTIONS: インスタンスメタデータ。 DDH_CLUSTER: 専用ホストクラスター。 NETWORK_PRIMARY_ENI_IP: プライマリネットワークインターフェースコントローラー (NIC) のセカンダリ IP アドレス。 PRIVATE_DNS_OPTIONS: プライベートネットワークドメイン名情報。 CPU_OPTIONS_TOPOLOGY_TYPE: インスタンスの CPU トポロジータイプ。 CURRENT_OS_NVME_SUPPORTED: 現在のオペレーティングシステムが NVMe プロトコルを介したディスクへのアクセスをサポートしているかどうか。 LOGIN_AS_NON_ROOT: インスタンスが ecs-user ログインで構成されているかどうか。	META_OPTIONS

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	指定された Tag.N.Key と Tag.N.Value が一致しません。
400	InvalidTagCount	The specified tags are beyond the permitted range.	指定されたタグが有効値外です。
400	InvalidHpcClusterId.NotFound	The specified HpcClusterId is not found.	指定されたパラメーター HpcClusterId は存在しません。
400	InvalidHpcClusterId.Creating	The specified HpcClusterId is creating.	指定された HPC クラスターは作成中です。
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.	現在のリクエストはスロットルされました。ページングクエリを実行するには、NextToken を使用して PageNumber をオーバーライドしてください。
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.

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

変更履歴

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