ホストインスタンスをクエリします。
操作説明
ページングクエリを実行する場合、最初のページでは MaxResults を設定して、返す結果のエントリ数を制限します。返された結果に含まれる NextToken は、後続ページをクエリするための認証情報として機能します。後続ページをクエリする際は、NextToken パラメーターに前の応答から取得した NextToken の値を設定し、MaxResults で返すエントリ数を制限します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeManagedInstances |
get |
Instance
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID です。サポートされているリージョン:中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、および米国 (バージニア)。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| RegionId |
string |
必須 |
リージョン ID です。サポートされているリージョン:中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (ウランチャブ)、中国 (杭州)、中国 (上海)、中国 (深セン)、中国 (河源)、中国 (広州)、中国 (成都)、中国 (香港)、シンガポール、日本 (東京)、米国 (シリコンバレー)、および米国 (バージニア)。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| OsType |
string |
任意 |
ホストインスタンスのオペレーティングシステムタイプです。有効な値:
|
windows |
| InstanceIp |
string |
任意 |
ホストインスタンスの内部 IP アドレスまたはパブリック IP アドレスです。 |
192.168.**.** |
| ActivationId |
string |
任意 |
アクティベーションコードの ID です。 |
4ECEEE12-56F1-4FBC-9AB1-890F7494**** |
| MachineId |
string |
任意 |
ホストインスタンスを登録する際に指定する MachineId パラメーターの値です。最大 36 文字まで使用できます。登録スクリプトの例:
|
GOG4X8312A0188 |
| InstanceName |
string |
任意 |
マネージドインスタンスの名前。 |
my-webapp-server |
| PageNumber |
integer |
任意 |
説明
このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。 |
1 |
| PageSize |
integer |
任意 |
説明
このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。 |
10 |
| InstanceId |
array |
任意 |
ホストインスタンス N の ID です。N の有効値:1~50。 |
mi-hz018jrc1o0**** |
|
string |
任意 |
N 番目のホストインスタンスの ID。 N の有効な値の範囲は 1~50 です。 |
mi-hz018jrc1o0**** |
|
| Tag |
array<object> |
任意 |
ホストインスタンスのタグです。 |
|
|
object |
任意 |
ホストインスタンスのタグです。 |
||
| Key |
string |
任意 |
ホストインスタンスのタグ N のキーです。N の有効値:1~20。タグキーを空の文字列にすることはできません。 単一のタグを指定してリソースをクエリする場合、このタグが追加された最大 1,000 個のリソースが応答に表示されます。複数のタグを指定してリソースをクエリする場合、これらすべてのタグが追加された最大 1,000 個のリソースが応答に表示されます。指定されたタグが追加された 1,000 個を超えるリソースをクエリするには、ListTagResources 操作を呼び出します。 タグキーの長さは最大 64 文字で、 |
TestKey |
| Value |
string |
任意 |
ホストインスタンスのタグ N の値です。N の有効値:1~20。タグ値は空の文字列にすることができます。 タグ値の長さは最大 128 文字で、 |
TestValue |
| MaxResults |
integer |
任意 |
1 ページあたりの最大エントリ数です。 有効値:1~50。 デフォルト値:10。 |
10 |
| NextToken |
string |
任意 |
次のリクエストで結果の新しいページを取得するために使用されるページネーショントークンです。前のクエリから取得したトークンを NextToken の値として指定する必要があります。 |
AAAAAdDWBF2**** |
| ResourceGroupId |
string |
任意 |
ホストインスタンスが属するリソースグループの ID です。 |
rg-123****** |
| Connected |
string |
任意 |
ホストインスタンスが接続されているかどうかを示します。 true:ホストインスタンスは接続されており、クラウドアシスタントを使用して管理できます。 false:ホストインスタンスは接続されていません。サーバーが停止しているか、クラウドアシスタントエージェントが正しくインストールされていない可能性があります。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
1 ページあたりのエントリ数です。 |
10 |
| RequestId |
string |
リクエスト ID です。 |
77115469-F2C5-4ECA-94F7-FA04F2FD**** |
| PageNumber |
integer |
ページ番号です。 |
1 |
| TotalCount |
integer |
クエリされたホストインスタンスの総数です。 |
1 |
| Instances |
array<object> |
照会されたマネージドインスタンス。 |
|
|
array<object> |
|||
| LastInvokedTime |
string |
最後のクラウドアシスタントタスクが実行された時間です。 |
2021-01-20T09:00:40Z |
| Connected |
boolean |
ホストインスタンスが接続されているかどうかを示します。有効な値:
|
true |
| InternetIp |
string |
マネージドインスタンスのパブリック IP アドレスです。 |
40.65.**.** |
| Hostname |
string |
ホストインスタンスのホスト名です。 |
demo |
| InstanceId |
string |
マネージドインスタンスの ID です。 |
mi-hz018jrc1o0**** |
| ActivationId |
string |
アクティベーションコードの ID です。 |
3704F543-F768-43FA-9864-897F75B3**** |
| IntranetIp |
string |
マネージドインスタンスの内部 IP アドレスです。 |
10.0.**.** |
| AgentVersion |
string |
クラウドアシスタントエージェントのバージョン番号です。 |
2.2.0.102 |
| RegistrationTime |
string |
ホストインスタンスが登録された時刻です。 |
2021-01-20T08:57:56Z |
| InstanceName |
string |
ホストインスタンスの名前です。 |
webAPP-linux-01 |
| OsType |
string |
ホストインスタンスのオペレーティングシステムタイプです。 |
Linux |
| OsVersion |
string |
オペレーティングシステムのバージョン情報です。 |
Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64 |
| InvocationCount |
integer |
ホストインスタンスでクラウドアシスタントタスクが実行された回数です。 |
1 |
| MachineId |
string |
ホストインスタンスのマシンコードです。 |
e03231b37ab14e53b5795ad625fc**** |
| Tags |
array<object> |
ホストインスタンスのタグです。 |
|
|
object |
ホストインスタンスのタグです。 |
||
| TagKey |
string |
ホストインスタンスのタグ N のキーです。N の有効値:1~20。タグキーを空の文字列にすることはできません。 単一のタグを指定してリソースをクエリする場合、このタグが追加された最大 1,000 個のリソースが返されます。複数のタグを指定してリソースをクエリする場合、これらすべてのタグが追加された最大 1,000 個のリソースが返されます。指定されたタグを持つ 1,000 個を超えるリソースをクエリするには、ListTagResources 操作を呼び出します。 タグキーの長さは最大 64 文字で、 |
TestKey |
| TagValue |
string |
ホストインスタンスのタグ N の値です。N の有効値:1~20。タグ値は空の文字列にすることができます。 タグ値の長さは最大 128 文字で、 |
TestValue |
| ResourceGroupId |
string |
マネージドインスタンスが属するリソースグループの ID です。 |
rg-123****** |
| NextToken |
string |
ページネーショントークン。次のリクエストで使用して、結果の新しいページを取得できます。 |
AAAAAdDWBF2 |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "77115469-F2C5-4ECA-94F7-FA04F2FD****",
"PageNumber": 1,
"TotalCount": 1,
"Instances": [
{
"LastInvokedTime": "2021-01-20T09:00:40Z",
"Connected": true,
"InternetIp": "40.65.**.**",
"Hostname": "demo",
"InstanceId": "mi-hz018jrc1o0****",
"ActivationId": "3704F543-F768-43FA-9864-897F75B3****",
"IntranetIp": "10.0.**.**",
"AgentVersion": "2.2.0.102",
"RegistrationTime": "2021-01-20T08:57:56Z",
"InstanceName": "webAPP-linux-01",
"OsType": "Linux",
"OsVersion": "Linux_#38~18.04.1-Ubuntu SMP Wed Jan 6 18:26:30 UTC 2021_x86_64",
"InvocationCount": 1,
"MachineId": "e03231b37ab14e53b5795ad625fc****",
"Tags": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
],
"ResourceGroupId": "rg-123******"
}
],
"NextToken": "AAAAAdDWBF2"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | |
| 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. | |
| 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. | |
| 500 | InternalError.Dispatch | An error occurred when you dispatched the request. | |
| 403 | Operation.Forbidden | The operation is not permitted. | |
| 404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。