Elastic Cloud Phone（ECP）インスタンスのタスクリストをクエリします。ECP インスタンスに対する作成、起動、シャットダウンなどの多くの操作は非同期です。システムは各操作に対してタスク ID を生成します。タスク ID を使用して、操作の進捗状況と結果をクエリできます。また、この API 操作を呼び出して、すべてのタスクとその実行ステータスのリストをクエリすることもできます。
操作説明
DescribeTasks 操作を呼び出して、単一の ECP インスタンスまたはバッチ内の複数の ECP インスタンスに対する操作のステータスをクエリできます。
この操作では、インスタンスの起動、停止、再起動、リセット、バックアップまたは復元、アプリケーションのインストール、リモートコマンドの実行などの操作のタスクをクエリできます。
Levelフィールドはタスクレベルを示します。Levelが 1 の場合、タスクはバッチタスクです。Levelが 2 の場合、タスクはインスタンスレベルのタスクです。
例:
たとえば、ID が acp-25nt4kk9whhok**** と acp-j2taq887orj8l**** の 2 つの ECP インスタンスを再起動するとします。この操作で返されるリクエスト ID は B8ED2BA9-0C6A-5643-818F-B5D60A64**** です。このバッチ操作の結果をクエリするには、DescribeTasks を呼び出し、InvokeId を B8ED2BA9-0C6A-5643-818F-B5D60A64**** に設定します。ID が acp-25nt4kk9whhok**** のインスタンスの再起動結果を取得するには、ParentTaskId をバッチタスク ID に設定し、InstanceId を acp-25nt4kk9whhok**** に設定して DescribeTasks を呼び出します。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InvokeId |
string |
任意 |
コマンド実行の ID 。前の操作から返されたリクエスト ID を使用できます。 |
B8ED2BA9-0C6A-5643-818F-B5D60A64**** |
| ResourceIds |
array |
任意 |
リソース ID のリスト。 |
|
|
string |
任意 |
リソース ID 。クラウドフォンの起動、停止、再起動、またはリセットを行うタスクのステータスをクエリする場合は、このパラメーターにインスタンス ID を使用します。 |
acp-25nt4kk9whhok**** |
|
| TaskIds |
array |
任意 |
タスク ID のリスト。 |
|
|
string |
任意 |
タスク ID 。 |
t-bp67acfmxazb4p**** |
|
| ParentTaskId |
string |
任意 |
親タスク ID 。 |
t-iaej5dkbnmivx**** |
| TaskType |
string |
任意 |
タスクタイプ。 |
StartInstance |
| TaskTypes |
array |
任意 |
タスクタイプのリスト。 |
|
|
string |
任意 |
タスクタイプ。 |
StartInstance |
|
| TaskStatus |
string |
任意 |
タスクステータス。 |
Processing |
| TaskStatuses |
array |
任意 |
タスクステータスのリスト。 |
|
|
string |
任意 |
タスクステータス。 |
Finished |
|
| Level |
integer |
任意 |
タスクレベル。バッチタスクの場合は 1、インスタンスレベルのタスクの場合は 2 に設定します。 |
1 |
| InstanceId |
string |
任意 |
インスタンス ID 。 |
acp-2zecay9ponatdc4m**** |
| InstanceName |
string |
任意 |
インスタンス名。 |
defaultInstanceName |
| Param |
string |
任意 |
拡張フィールド。 |
param |
| MaxResults |
integer |
任意 |
1 ページあたりの最大エントリ数。有効な値: 1 ～ 100 。デフォルト値: 10 。 |
10 |
| NextToken |
string |
任意 |
次の結果ページを取得するために使用されるトークン。最初の結果ページを取得するには、このパラメーターを空のままにします。 |
FFbc8N4E1iOlcSxC+8boa0HHH2LKWbggYUinyrZWvtS1oTrMYCg1HuMLGuftj0**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| NextToken |
string |
クエリが開始される位置。このパラメーターを空のままにすると、クエリは最初から開始されます。 |
AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc**** |
| Data |
array<object> |
結果オブジェクトのリスト。 |
|
|
object |
結果オブジェクト。 |
||
| TaskId |
string |
タスク ID 。 |
t-bp67acfmxazb4p**** |
| InvokeId |
string |
コマンド実行 ID 。 |
B8ED2BA9-0C6A-5643-818F-B5D60A64**** |
| RegionId |
string |
リージョン ID 。 |
cn-hangzhou |
| ResourceId |
string |
リソース ID 。 |
acp-25nt4kk9whhok**** |
| TaskType |
string |
タスクタイプ。 |
StartInstance |
| TaskStatus |
string |
タスクステータス。 |
Processing |
| StartTime |
string |
タスクが開始された時刻。 |
2022-10-11T08:53:32Z |
| FinishTime |
string |
タスクが終了した時刻。 |
2022-10-11T08:53:32Z |
| Param |
string |
タスクパラメーター。 |
param |
| Result |
string |
タスク実行結果。 |
{'Success': True} |
| ErrorCode |
string |
エラーコード。 |
SendFileFailed |
| ErrorMsg |
string |
エラーメッセージ。 |
connect error. |
| Level |
integer |
タスクレベル。 |
1 |
| FailedChildCount |
integer |
失敗したサブタスクの総数。 |
2 |
| SuccessChildCount |
integer |
成功したサブタスクの総数。 |
98 |
| RunningChildCount |
integer |
実行中のサブタスクの総数。 |
0 |
| TotalChildCount |
integer |
現在のバッチタスクのサブタスクの総数。 |
100 |
| InstanceId |
string |
インスタンス ID 。 |
acp-uto81vfd8t8z**** |
| InstanceName |
string |
インスタンス名。 |
defaultInstanceName |
| InstanceStatus |
string |
インスタンスステータス。 |
RUNNING |
| Operator |
string |
オペレーター。 |
test |
| ParentTaskId |
string |
親タスク ID 。 |
t-41oan3tza16vs**** |
| TotalCount |
integer |
エントリの総数。 |
10 |
| RequestId |
string |
リクエスト ID 。 |
B8ED2BA9-0C6A-5643-818F-B5D60A64**** |
例
成功レスポンス
JSONJSON
{
"NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
"Data": [
{
"TaskId": "t-bp67acfmxazb4p****",
"InvokeId": "B8ED2BA9-0C6A-5643-818F-B5D60A64****",
"RegionId": "cn-hangzhou",
"ResourceId": "acp-25nt4kk9whhok****",
"TaskType": "StartInstance",
"TaskStatus": "Processing",
"StartTime": "2022-10-11T08:53:32Z",
"FinishTime": "2022-10-11T08:53:32Z",
"Param": "param",
"Result": "{'Success': True}",
"ErrorCode": "SendFileFailed",
"ErrorMsg": "connect error.",
"Level": 1,
"FailedChildCount": 2,
"SuccessChildCount": 98,
"RunningChildCount": 0,
"TotalChildCount": 100,
"InstanceId": "acp-uto81vfd8t8z****",
"InstanceName": "defaultInstanceName",
"InstanceStatus": "RUNNING",
"Operator": "test",
"ParentTaskId": "t-41oan3tza16vs****"
}
],
"TotalCount": 10,
"RequestId": "B8ED2BA9-0C6A-5643-818F-B5D60A64****"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。