クラウドアシスタントコマンドの実行リストとステータスを照会します。
操作説明
-
コマンドを実行した後、コマンドが正常に実行されたか、期待どおりの結果が得られたかは保証されません。この操作の戻り値に基づいて実際の実行結果を確認する必要があります。実際の出力が優先されます。
-
過去 30 日間の実行情報をクエリできます。最大 10,000 件の実行レコードが保持されます。
-
クラウドアシスタントタスクステータスイベントをサブスクライブすることで、頻繁なポーリングを避け、イベントを通じてタスク結果を取得し、効率を向上させることができます。
-
ページングクエリの最初のページをクエリする場合、MaxResults のみをセットして返すエントリ数を制限します。応答の NextToken 値が後続ページをクエリするためのトークンとなります。後続ページをページングクエリする場合、NextToken を前回の応答から取得した NextToken 値にセットし、MaxResults をセットして返すエントリ数を制限します。
-
DescribeInvocationsとDescribeInvocationResultsの違い:- 1 回の
RunCommand/InvokeCommand呼び出しで複数のインスタンスを指定した場合:DescribeInvocationsは各インスタンスの実行ステータスと、すべてのインスタンスにわたる集約ステータスを返します。DescribeInvocationResultsは各インスタンスの個別の実行ステータスのみを返し、集約ステータスは返しません。
- 1 回の
RunCommand/InvokeCommand呼び出しで 1 つのインスタンスを指定した場合:DescribeInvocationsとDescribeInvocationResultsはほぼ同等に使用できます。
スケジュール(周期的)タスクまたは起動トリガータスク(
RepeatMode=Period, EveryReboot)の各実行の詳細を表示するには、DescribeInvocationResultsのみが過去の実行レコードを返すことができます(IncludeHistory=trueを指定)。DescribeInvocationsは最新のタスクステータスのみを返します。コマンドの内容とパラメーターを表示するには、
DescribeInvocationsのみがCommandContentを返します。
- 1 回の
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ecs:DescribeInvocations |
get |
Instance
Command
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| ResourceGroupId |
string |
任意 |
コマンド実行のリソースグループ ID。このパラメーターを指定した場合、コマンドの実行時にもリソースグループ ID を指定する必要があります。このパラメーターは対応するコマンド実行結果をフィルターします。 |
rg-bp67acfmxazb4p**** |
| RegionId |
string |
必須 |
リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
cn-hangzhou |
| InvokeId |
string |
任意 |
コマンド実行 ID。 |
t-hz0jdfwd9f**** |
| CommandId |
string |
任意 |
コマンド ID。 DescribeCommands を呼び出して、使用可能なすべてのコマンド ID をクエリできます。 |
c-hz0jdfwcsr**** |
| CommandName |
string |
任意 |
コマンド名。InstanceId も指定した場合、このパラメーターは効果がありません。 |
CommandTestName |
| CommandType |
string |
任意 |
コマンドタイプ。有効な値:
|
RunShellScript |
| Timed |
boolean |
任意 |
照会するコマンドが将来自動的に実行されるかどうかを指定します。有効な値:
デフォルト値: false。 |
true |
| InvokeStatus |
string |
任意 |
コマンドの全体的な実行ステータス。全体的な実行ステータスは、1 つ以上のインスタンスにわたる実行ステータスの組み合わせによって決定されます。有効な値:
|
Finished |
| InstanceId |
string |
任意 |
インスタンス ID。このパラメーターを指定すると、そのインスタンスのすべてのコマンド実行レコードが照会されます。 |
i-bp1i7gg30r52z2em**** |
| ContentEncoding |
string |
任意 |
応答の CommandContent フィールドと Output フィールドのエンコーディングモード。有効な値:
デフォルト値: Base64。 |
PlainText |
| IncludeOutput |
boolean |
任意 |
結果にコマンド出力を含めるかどうかを指定します。
デフォルト値: false。 |
false |
| PageNumber |
integer |
任意 |
説明
このパラメーターは廃止予定です。NextToken と MaxResults を使用してページング操作を行ってください。 |
1 |
| PageSize |
integer |
任意 |
説明
このパラメーターは廃止予定です。NextToken と MaxResults を使用してページング操作を行ってください。 |
10 |
| MaxResults |
integer |
任意 |
ページングの 1 ページあたりの最大エントリ数。 最大値: 50。 デフォルト値: 10。 |
10 |
| NextToken |
string |
任意 |
ページネーショントークン。前回の API 呼び出しで返された NextToken 値をこのパラメーターに設定します。 |
AAAAAdDWBF2 |
| RepeatMode |
string |
任意 |
コマンドの実行モード。InstanceId も指定した場合、このパラメーターは効果がありません。有効な値:
デフォルト値: 空。すべての実行モードが照会されることを示します。 |
Once |
| Tag |
array<object> |
任意 |
タグ。 |
|
|
object |
任意 |
タグ。 |
||
| Value |
string |
任意 |
コマンド実行のタグ値。N の有効な値: 1~20。タグ値は空の文字列にできます。
タグ値は最大 128 文字で、 |
TestValue |
| Key |
string |
任意 |
コマンド実行のタグキー。N の有効な値: 1~20。タグキーは空の文字列にできません。 単一のタグを使用してリソースをフィルターする場合、指定されたタグが付いたリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付いたリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources を呼び出してクエリを実行してください。 タグキーは最大 64 文字で、 |
TestKey |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| PageSize |
integer |
ページあたりのエントリ数 |
10 |
| RequestId |
string |
リクエスト ID |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| PageNumber |
integer |
クエリ結果のページ番号。 |
1 |
| TotalCount |
integer |
コマンドの総数。 |
1 |
| NextToken |
string |
この呼び出しで返されたページネーショントークン。 |
AAAAAdDWBF2 |
| Invocations |
object |
||
| Invocation |
array<object> |
コマンド実行レコード。 |
|
|
array<object> |
タスクが作成された時間。 |
||
| OssOutputDelivery |
string |
コマンド実行出力のOSS 配信設定です。 |
oss://testBucket/testPrefix |
| InvocationStatus |
string |
コマンドの全体的な実行ステータスです。全体的な実行ステータスは、この呼び出しにおけるすべてのインスタンス間の共通の実行ステータスに依存します。有効な値:
説明
|
Running |
| Parameters |
string |
コマンド内のカスタムパラメータです。 |
{} |
| Timed |
boolean |
コマンドが将来自動的に実行されるかどうかを示します。 |
false |
| CommandDescription |
string |
コマンドの説明です。 |
testDescription |
| Timeout |
integer |
ECSインスタンスでのコマンド実行の最大タイムアウト時間です。単位: 秒。 何らかの理由でコマンドを実行できない場合、タイムアウトが発生します。タイムアウトが発生すると、コマンドのPIDをキャンセルしてコマンドプロセスが強制終了されます。 |
60 |
| InvokeInstances |
object |
||
| InvokeInstance |
array<object> |
ターゲットインスタンスセットタイプです。 |
|
|
object |
実行ステータスリストです。 |
||
| Dropped |
integer |
Outputフィールドのテキストが24 KBを超えた後に切り捨てられ、破棄されたテキストの長さです。 |
0 |
| InvocationStatus |
string |
単一インスタンスでのコマンド実行ステータスです。有効な値:
|
Success |
| InstanceId |
string |
インスタンスIDです。 |
i-bp1i7gg30r52z2em**** |
| Timed |
boolean |
コマンドが将来自動的に実行されるかどうかを示します。 |
false |
| InstanceInvokeStatus |
string |
単一インスタンスでのコマンド実行ステータスです。 説明
代わりに |
Finished |
| ExitCode |
integer |
コマンドプロセスの終了コードです。有効な値:
|
0 |
| ErrorInfo |
string |
コマンド配信失敗または実行失敗の詳細です。有効な値:
|
the specified instance does not exists |
| StartTime |
string |
インスタンスでコマンドの実行が開始された時刻です。 |
2019-12-20T06:15:55Z |
| Repeats |
integer |
インスタンスでコマンドが実行された回数です。
|
0 |
| OssOutputUri |
string |
コマンド実行出力が配信されるOSSファイルURIです。配信に失敗した場合または配信中の場合、このフィールドは空の文字列です。 |
oss://testBucket/testPrefix/output.txt |
| OssOutputStatus |
string |
コマンド実行出力の配信ステータスです。有効な値:
|
Finished |
| OssOutputErrorCode |
string |
配信に失敗した場合のエラーコードです。このフィールドはOssOutputStatusがFailedの場合にのみ返されます。 有効な値:
|
CloudAssistant.UnsupportedInvocationStatus |
| OssOutputErrorInfo |
string |
配信に失敗した場合のエラー詳細です。このフィールドはOssOutputStatusがFailedの場合にのみ返されます。 |
The invocation status does not support output delivery. |
| FinishTime |
string |
コマンドプロセスの終了時刻です。 |
2019-12-20T06:15:56Z |
| Output |
string |
コマンド出力です。
|
OutPutTestmsg |
| CreationTime |
string |
コマンド実行の開始時刻です。 |
2019-12-20T06:15:54Z |
| UpdateTime |
string |
コマンドステータスが更新された時刻です。 |
2020-01-19T09:15:47Z |
| ErrorCode |
string |
コマンド配信失敗または実行失敗のエラーコードです。有効な値:
|
InstanceNotExists |
| StopTime |
string |
コマンド実行を停止するために |
2020-01-19T09:15:47Z |
| CommandContent |
string |
コマンド内容です。
|
cnBtIC1xYSB8IGdyZXAgdnNm**** |
| WorkingDir |
string |
コマンド実行の作業ディレクトリです。 |
/home/ |
| RepeatMode |
string |
コマンドの実行モードです。有効な値:
|
Once |
| InvokeStatus |
string |
コマンドの全体的な実行ステータスです。 説明
代わりに |
Finished |
| CommandType |
string |
コマンドタイプです。 |
RunShellScript |
| Username |
string |
ECSインスタンスでコマンドを実行するために使用されるユーザー名です。 |
test |
| ContainerId |
string |
コンテナIDです。 |
ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea**** |
| ContainerName |
string |
コンテナ名です。 |
test-container |
| CreationTime |
string |
タスクが作成された時刻です。 |
2020-01-19T09:15:46Z |
| Frequency |
string |
スケジュールされたコマンド実行のスケジュールです。 |
0 */20 * * * * |
| Launcher |
string |
スクリプト実行のランチャーです。ランチャーは1 KBを超えることはできません。 |
python3 -u {{ACS::ScriptFileName|Ext(".py")}} |
| CommandId |
string |
コマンドIDです。 |
c-hz0jdfwcsr**** |
| CommandName |
string |
コマンド名です。 |
CommandTestName |
| InvokeId |
string |
コマンド実行 IDです。 |
t-hz0jdfwd9f**** |
| TerminationMode |
string |
タスク停止のモード(手動停止またはタイムアウト中断)です。有効な値:
|
ProcessTree |
| Tags |
object |
||
| Tag |
array<object> |
コマンド実行のタグ情報です。 |
|
|
object |
コマンド実行のタグ情報です。 |
||
| TagKey |
string |
コマンド実行のタグキーです。 |
owner |
| TagValue |
string |
コマンド実行のタグ値です。 |
zhangsan |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"PageNumber": 1,
"TotalCount": 1,
"NextToken": "AAAAAdDWBF2",
"Invocations": {
"Invocation": [
{
"OssOutputDelivery": "oss://testBucket/testPrefix",
"InvocationStatus": "Running",
"Parameters": "{}",
"Timed": false,
"CommandDescription": "testDescription",
"Timeout": 60,
"InvokeInstances": {
"InvokeInstance": [
{
"Dropped": 0,
"InvocationStatus": "Success",
"InstanceId": "i-bp1i7gg30r52z2em****",
"Timed": false,
"InstanceInvokeStatus": "Finished",
"ExitCode": 0,
"ErrorInfo": "the specified instance does not exists",
"StartTime": "2019-12-20T06:15:55Z",
"Repeats": 0,
"OssOutputUri": "oss://testBucket/testPrefix/output.txt",
"OssOutputStatus": "Finished",
"OssOutputErrorCode": "CloudAssistant.UnsupportedInvocationStatus",
"OssOutputErrorInfo": "The invocation status does not support output delivery.",
"FinishTime": "2019-12-20T06:15:56Z",
"Output": "OutPutTestmsg",
"CreationTime": "2019-12-20T06:15:54Z",
"UpdateTime": "2020-01-19T09:15:47Z",
"ErrorCode": "InstanceNotExists",
"StopTime": "2020-01-19T09:15:47Z"
}
]
},
"CommandContent": "cnBtIC1xYSB8IGdyZXAgdnNm****",
"WorkingDir": "/home/",
"RepeatMode": "Once",
"InvokeStatus": "Finished",
"CommandType": "RunShellScript",
"Username": "test",
"ContainerId": "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
"ContainerName": "test-container",
"CreationTime": "2020-01-19T09:15:46Z",
"Frequency": "0 */20 * * * *",
"Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
"CommandId": "c-hz0jdfwcsr****",
"CommandName": "CommandTestName",
"InvokeId": "t-hz0jdfwd9f****",
"TerminationMode": "ProcessTree",
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | RegionId.ApiNotSupported | The api is not supported in this region. | |
| 400 | NumberExceed.Tags | The Tags parameter number is exceed. | |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | |
| 400 | MissingParameter.TagKey | You must specify Tag.N.Key. | |
| 400 | InvalidParam.PageNumber | The specified parameter is invalid. | |
| 400 | InvalidParam.PageSize | The specified parameter is invalid. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。