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

自動プロビジョニンググループ内のインスタンスを照会します。

今すぐお試しください

この 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:DescribeAutoProvisioningGroupInstances

get

*AutoProvisioningGroup

acs:ecs:{#regionId}:{#accountId}:autoprovisioninggroup/{#autoprovisioninggroupId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	自動プロビジョニンググループが存在するリージョンの ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
PageNumber	integer	任意	ページングクエリのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリを使用する場合の 1 ページあたりのエントリ数。設定項目: 最大値: 100。デフォルト値: 10。	10
AutoProvisioningGroupId	string	必須	オートプロビジョニンググループの ID	apg-uf6jel2bbl62wh13****

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID	B48A12CD-1295-4A38-A8F0-0E92C937****
PageNumber	integer	ページ番号。	1
TotalCount	integer	自動プロビジョニンググループ内のインスタンスの総数。	2
Instances	object
Instance	array<object>	自動プロビジョニンググループ内のすべてのインスタンスの情報。
	object	自動プロビジョニンググループ内のすべてのインスタンスの情報。
Status	string	インスタンスステータス。	Running
CreationTime	string	インスタンスが作成された時間。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。	2017-12-10T04:04Z
IsSpot	boolean	インスタンスがスポットインスタンスかどうかを示します。	true
CPU	integer	インスタンスの vCPU 数。	2
InstanceId	string	インスタンス ID	i-bp67acfmxazb4p****
NetworkType	string	インスタンスのネットワークタイプ。有効な値: vpc: 仮想非公開クラウド (VPC)。 classic: クラシックネットワーク。この機能は廃止されました。詳細については、廃止のお知らせを参照してください。	vpc
InstanceType	string	インスタンスタイプ	ecs.g5.large
RegionId	string	インスタンスが存在するリージョンの ID。	cn-hangzhou
IoOptimized	boolean	インスタンスが I/O 最適化されているかどうかを示します。	true
OsType	string	インスタンスのオペレーティングシステムタイプ。有効な値: windows: Windows。 linux: Linux。	linux
ZoneId	string	インスタンスが属するゾーンの ID。	cn-hangzhou-g
Memory	integer	メモリサイズ。単位: MiB。	1024

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "B48A12CD-1295-4A38-A8F0-0E92C937****",
  "PageNumber": 1,
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "Status": "Running",
        "CreationTime": "2017-12-10T04:04Z",
        "IsSpot": true,
        "CPU": 2,
        "InstanceId": "i-bp67acfmxazb4p****",
        "NetworkType": "vpc",
        "InstanceType": "ecs.g5.large",
        "RegionId": "cn-hangzhou",
        "IoOptimized": true,
        "OsType": "linux",
        "ZoneId": "cn-hangzhou-g",
        "Memory": 1024
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter	The specified parameter "AutoProvisioningGroupId" should not be null.	必須パラメーターが指定されていません。
400	MissingParamter.RegionId	The regionId should not be null.	RegionId パラメーターは空にできません。
403	Forbidden.RAM	User not authorized to operate on the specified resource, or this API doesn't support RAM.	現在の操作は許可されていません。この操作を実行する前に、Alibaba Cloud アカウントのオーナーに連絡し、必須の権限を付与してもらってください。
404	InvalidAutoProvisioningGroupId.NotFound	The specified AutoProvisioningGroupId does not exist.	指定された自動プロビジョニンググループは存在しません。

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

変更履歴

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