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

ホストインスタンスのリストを照会します。

操作説明

最初のページのページングクエリを実行する場合、返されるエントリ数を制限するために 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:DescribeManagedInstances

get

Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。サポートされているリージョン：中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、米国 (バージニア)。 DescribeRegions の呼び出しにより、リージョン ID などの情報をクエリできます。	cn-hangzhou
OsType	string	任意	ホストインスタンスのオペレーティングシステムタイプ。有効な値: windows linux FreeBSD	windows
InstanceIp	string	任意	ホストインスタンスの内部 IP アドレスまたはパブリック IP アドレス。	192.168..
ActivationId	string	任意	アクティベーションコードの ID。	4ECEEE12-56F1-4FBC-9AB1-890F7494****
MachineId	string	任意	ホストインスタンスの登録時に指定された MachineId パラメーターの値。値の長さは最大 36 文字です。登録スクリプトのサンプル: `aliyun-service --register \ --RegionId=cn-hangznou \ --ActivationId=xxxxxxxxxxx \ --ActivationCode=xxxxxxxxx \ --MachineId=xxxxxx \ # マシンの一意の識別子を指定するオプションのパラメーター --ForceResue` 登録時に MachineId パラメーターと ForceResult パラメーターが指定されている場合、クラウドアシスタントはこの MachineId に対して固定のホストインスタンス ID を生成します。 MachineId パラメーターが明示的に指定されていない場合、クラウドアシスタントはマシンのハードウェア情報に基づいて MachineId 値を自動的に生成します。推奨事項：ホストインスタンスとオンプレミスマシン間のマッピングをマークするために、MachineId パラメーターと ForceResult パラメーターを明示的に指定します。	GOG4X8312A0188
InstanceName	string	任意	ホストインスタンスの名前。	my-webapp-server
PageNumber	integer	任意	説明このパラメーターはまもなくオフラインになります。ページングおよびページングクエリ操作には、NextToken と MaxResults を使用することを推奨します。	1
PageSize	integer	任意	説明このパラメーターはまもなくオフラインになります。ページングおよびページングクエリ操作には、NextToken と MaxResults を使用することを推奨します。	10
InstanceId	array	任意	ホストインスタンスの ID。N の有効な値：1～50。	mi-hz018jrc1o0****
	string	任意	ホストインスタンスの ID。N の有効な値：1～50。	mi-hz018jrc1o0****
Tag	array<object>	任意	タグのリスト。
	object	任意	タグのリスト。
Key	string	任意	ホストインスタンスのタグキー。N の有効な値：1～20。値は空の文字列にすることはできません。単一のタグを使用してリソースをフィルター処理する場合、このタグの配下にあるリソースのリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、複数のタグがアタッチされているリソースのリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合、 ListTagResources 操作を使用してリソースをクエリする必要があります。タグキーの長さは最大 64 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。	TestKey
Value	string	任意	ホストインスタンスのタグ値。N の有効な値：1～20。値は空の文字列にすることができます。タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。	TestValue
MaxResults	integer	任意	ページングまたはページングクエリ中に各ページで返されるエントリの最大値。最大値：50。デフォルト値：10。	10
NextToken	string	任意	ページネーショントークン。前の API 呼び出しから返された NextToken 値に値を設定します。	AAAAAdDWBF2****
ResourceGroupId	string	任意	ホストインスタンスが属するリソースグループの ID。	rg-123******
Connected	string	任意	ホストインスタンスが接続されているかどうかを指定します。有効な値: true: ホストインスタンスは接続されています。クラウドアシスタントを使用してホストインスタンスを管理できます。 false: ホストインスタンスは接続されていません。サーバーが停止しているか、クラウドアシスタントエージェントが正しくインストールされていない可能性があります。	true

レスポンスフィールド

フィールド	型	説明	例
	object
Instances	array<object>	ホストインスタンスのリスト。
	array<object>
ActivationId	string	アクティベーションコードの ID。	3704F543-F768-43FA-9864-897F75B3****
AgentVersion	string	クラウドアシスタントエージェントのバージョン番号。	2.2.0.102
Connected	boolean	ホストインスタンスが接続されているかどうかを示します。有効な値: true: ホストインスタンスは接続されています。クラウドアシスタントを使用してホストインスタンスを管理できます。 false: ホストインスタンスは接続されていません。サーバーが停止しているか、クラウドアシスタントエージェントが正しくインストールされていない可能性があります。	true
Hostname	string	ホストインスタンスのホスト名。	demo
InstanceId	string	ホストインスタンスの ID。	mi-hz018jrc1o0****
InstanceName	string	ホストインスタンスの名前。	webAPP-linux-01
InternetIp	string	ホストインスタンスのパブリック IP アドレス。	40.65..
IntranetIp	string	ホストインスタンスの内部 IP アドレス。	10.0..
InvocationCount	integer	ホストインスタンスで実行されたクラウドアシスタントタスクの数。	1
LastInvokedTime	string	最後のクラウドアシスタントタスクが実行された時間。時間は協定世界時 (UTC) タイムゾーンの ISO 8601 初期化で表示されます。	2021-01-20T09:00:40Z
MachineId	string	ホストインスタンスのマシン ID。	e03231b37ab14e53b5795ad625fc****
OsType	string	ホストインスタンスのオペレーティングシステム。	Linux
OsVersion	string	オペレーティングシステムのバージョン情報。	Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64
RegistrationTime	string	ホストインスタンスの登録時間。時間は協定世界時 (UTC) タイムゾーンの ISO 8601 初期化で表示されます。	2021-01-20T08:57:56Z
ResourceGroupId	string	ホストインスタンスが属するリソースグループの ID。	rg-123******
Tags	array<object>	タグのリスト。
	object	タグのリスト。
TagKey	string	ホストインスタンスのタグキー。N の有効な値：1～20。値は空の文字列にすることはできません。単一のタグを使用してリソースをフィルター処理する場合、このタグの配下にあるリソースのリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、複数のタグがアタッチされているリソースのリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合、 ListTagResources 操作を使用してリソースをクエリする必要があります。タグキーの長さは最大 64 文字です。aliyun または acs: で始めることはできず、http:// または https:// を含めることはできません。	TestKey
TagValue	string	ホストインスタンスのタグ値。N の有効な値：1～20。値は空の文字列にすることができます。タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。	TestValue
NextToken	string	この呼び出しに対して返されるページネーショントークン。	AAAAAdDWBF2
PageNumber	integer	ホストインスタンスリストのページ番号。	1
PageSize	integer	ページごとに返されるエントリ数。	10
RequestId	string	リクエスト ID	77115469-F2C5-4ECA-94F7-FA04F2FD****
TotalCount	integer	照会されたホストインスタンスの総数。説明ページングおよびページングクエリに MaxResults パラメーターと NextToken パラメーターを使用する場合、返される TotalCount 値に意味はありません。	1

例

成功レスポンス

JSONJSON

{
  "Instances": [
    {
      "ActivationId": "3704F543-F768-43FA-9864-897F75B3****",
      "AgentVersion": "2.2.0.102",
      "Connected": true,
      "Hostname": "demo",
      "InstanceId": "mi-hz018jrc1o0****",
      "InstanceName": "webAPP-linux-01",
      "InternetIp": "40.65.**.**",
      "IntranetIp": "10.0.**.**",
      "InvocationCount": 1,
      "LastInvokedTime": "2021-01-20T09:00:40Z",
      "MachineId": "e03231b37ab14e53b5795ad625fc****",
      "OsType": "Linux",
      "OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
      "RegistrationTime": "2021-01-20T08:57:56Z",
      "ResourceGroupId": "rg-123******",
      "Tags": [
        {
          "TagKey": "TestKey",
          "TagValue": "TestValue"
        }
      ]
    }
  ],
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "77115469-F2C5-4ECA-94F7-FA04F2FD****",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RegionId.ApiNotSupported	The api is not supported in this region.	指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定されたタグキーパラメーターが無効です。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定されたタグ値パラメーターが無効です。
400	NumberExceed.Tags	The Tags parameter number is exceed.	タグの数が最大値を超えています。この操作では最大 20 個のタグを指定できます。
400	MissingParameter.TagKey	You must specify Tag.N.Key.	タグキーを指定してください。
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	タグに重複するキーが存在します。すべてのキーが一意になるようにしてください。
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定された MaxResults パラメーターは無効です。
500	InternalError.Dispatch	An error occurred when you dispatched the request.	リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	この操作は許可されていません。
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	指定された RegionId が存在しません。指定されたリージョンでこのプロダクトが利用可能かどうかを確認してください。

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

変更履歴

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