非同期タスクを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
bdrc:DescribeTasks |
none |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v1/tasks HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| TaskStatus |
string |
任意 |
照会対象のタスクのステータスを指定します。このパラメーターを省略した場合、API はすべてのステータスのタスクを返します。有効な値： |
RUNNING |
| NextToken |
string |
任意 |
ページネーショントークンです。次のページの結果を取得するには、このパラメーターに前回の API 呼び出しの応答から得た |
cae**********699 |
| MaxResults |
integer |
任意 |
1 ページあたりに返す最大エントリ数です。有効範囲は 10～500 です。このパラメーターを省略した場合、またはその値が 10 より小さい場合は、デフォルト値として 10 が使用されます。500 より大きい値は 500 とみなされます。 |
10 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
BaseResponse<ListResult<task>> |
||
| Data |
object |
返されたデータです。 |
|
| Content |
array<object> |
タスクの一覧です。 |
|
|
object |
|||
| TaskId |
string |
タスク ID です。 |
t-0000e4w0u1v592zdf6s7 |
| TaskName |
string |
タスク名です。 |
empty |
| TaskDescription |
string |
タスクの説明です。 |
empty |
| TaskType |
string |
タスクの種類です。有効な値： |
UPDATE_RESOURCES |
| TaskPriority |
string |
タスクの優先度です。有効な値： |
HIGH |
| RequestId |
string |
リクエスト ID です。 |
AE43C4CB-8074-5EBD-9806-8CA6D12800B1 |
| TaskDetail |
string |
タスクの詳細です。 |
{"resourceTypes":["ACS::ECS::Instance","ACS::OSS::Bucket","ACS::OTS::Instance","ACS::NAS::FileSystem"]} |
| ExecutionId |
string |
実行 ID です。このパラメーターは現在未使用であり、空文字列を返します。 |
empty |
| Progress |
integer |
タスクの進捗状況で、0～10,000 の範囲の値です。 |
100 |
| TaskStatus |
string |
タスクのステータスです。有効な値： |
RUNNING |
| ErrorMessage |
string |
タスクが失敗した場合に返されるエラーメッセージです。 |
device not online |
| StartTime |
integer |
タスクの開始時刻で、秒単位の UNIX タイムスタンプで表されます。 |
1724983927 |
| CompleteTime |
integer |
タスクの完了時刻で、秒単位の UNIX タイムスタンプで表されます。 |
1724983927 |
| ExpireTime |
integer |
タスクの有効期限で、秒単位の UNIX タイムスタンプで表されます。 |
1724983927 |
| TaskResult |
string |
タスクの結果です。 |
{"resourceCounts":[{"resourceType":"ACS::OSS::Bucket","count":2},{"resourceType":"ACS::NAS::FileSystem","count":3}]} |
| NextToken |
string |
次のページの結果を取得するために使用するページネーショントークンです。このパラメーターが空の場合、これ以上結果はありません。 |
f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2 |
| MaxResults |
integer |
1 ページあたりに返される最大エントリ数です。 |
10 |
| TotalCount |
integer |
リクエスト条件に一致するエントリの合計数です。このパラメーターはオプションであり、デフォルトでは返されません。 |
100 |
| RequestId |
string |
リクエストの固有 ID です。 |
AE43C4CB-8074-5EBD-9806-8CA6D12800B1 |
例
成功レスポンス
JSONJSON
{
"Data": {
"Content": [
{
"TaskId": "t-0000e4w0u1v592zdf6s7",
"TaskName": " empty",
"TaskDescription": " empty",
"TaskType": "UPDATE_RESOURCES",
"TaskPriority": "HIGH",
"RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1",
"TaskDetail": "{\"resourceTypes\":[\"ACS::ECS::Instance\",\"ACS::OSS::Bucket\",\"ACS::OTS::Instance\",\"ACS::NAS::FileSystem\"]}",
"ExecutionId": "empty",
"Progress": 100,
"TaskStatus": "RUNNING",
"ErrorMessage": "device not online",
"StartTime": 1724983927,
"CompleteTime": 1724983927,
"ExpireTime": 1724983927,
"TaskResult": "{\"resourceCounts\":[{\"resourceType\":\"ACS::OSS::Bucket\",\"count\":2},{\"resourceType\":\"ACS::NAS::FileSystem\",\"count\":3}]}"
}
],
"NextToken": "f4b8c2504545a3b41af5e75147d17d12e3818a0b9b2ff9a2",
"MaxResults": 10,
"TotalCount": 100
},
"RequestId": "AE43C4CB-8074-5EBD-9806-8CA6D12800B1"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。