非同期タスクの情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/async_task/get HTTP/1.1
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| body |
object |
任意 |
リクエストパラメーターです。 |
|
| async_task_id |
string |
必須 |
非同期タスクの ID。 |
000e89fb-cf8f-11e9-8ab4-b6e980803a3b |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターです。 |
||
| async_task_id |
string |
非同期タスクの ID。 |
000e89fb-cf8f-11e9-8ab4-b6e980803a3b |
| status |
string |
警告 このパラメーターは現在使用されていません。代わりに state の使用を推奨します。 タスクの状態。有効な値:
列挙値:
|
Succeed |
| state |
string |
タスクの状態。有効な値:
|
Succeed |
| message |
string |
警告 このパラメーターは現在使用されていません。代わりに error_message の使用を推奨します。 非同期タスクが失敗した場合に返されるエラーメッセージ。 |
The request has been failed due to some unknown error. Please try again later. |
| err_code |
integer |
警告 このパラメーターは現在使用されていません。代わりに error_code の使用を推奨します。 非同期タスクが失敗した場合に返されるエラーコード。 |
InternalError |
| total_process |
integer |
非同期タスクで実行される総作業量。例えば、サーバーでのパッケージダウンロードのためにパッケージ化されるファイルの数などです。 |
1000 |
| consumed_process |
integer |
非同期タスクで完了した作業量。例えば、サーバーでのパッケージダウンロードのためにパッケージ化されたファイルの数などです。 |
100 |
| url |
string |
非同期タスクによって生成されたデータのダウンロード URL。例えば、サーバーでのパッケージダウンロードタスクによって生成された、パッケージ化されたファイルのダウンロード URL などです。 |
https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx |
| error_code |
string |
非同期タスクが失敗した場合に返されるエラーコード。 |
InternalError |
| error_message |
string |
非同期タスクが失敗した場合に返されるエラーメッセージ。 |
The request has been failed due to some unknown error. Please try again later. |
| uncompress_file_list |
array |
展開されたファイル。 |
|
| UncompressedFileInfo |
展開されたファイル。 |
||
| category |
string |
タスクのカスタムカテゴリ。 |
album |
| created_at |
string |
タスクが作成された時刻。時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ フォーマットです。例:2019-03-28T13:03:29.298Z。 |
2019-08-20T06:51:27.292Z |
| started_at |
string |
タスクが開始された時刻。時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ フォーマットです。例:2019-03-28T13:03:29.298Z。 |
2019-08-20T06:51:27.292Z |
| finished_at |
string |
タスクが完了した時刻。時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ フォーマットです。例:2019-03-28T13:03:29.298Z。 |
2019-08-20T06:51:27.292Z |
| skipped_process |
integer |
非同期タスクでスキップされたプロセスの数。 |
0 |
| failed_process |
integer |
非同期タスクで失敗したプロセスの数。 |
0 |
例
成功レスポンス
JSONJSON
{
"async_task_id": "000e89fb-cf8f-11e9-8ab4-b6e980803a3b",
"status": "Succeed",
"state": "Succeed",
"message": "The request has been failed due to some unknown error. Please try again later.",
"err_code": 0,
"total_process": 1000,
"consumed_process": 100,
"url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
"error_code": "InternalError",
"error_message": "The request has been failed due to some unknown error. Please try again later.",
"uncompress_file_list": [
{
"drive_id": "5060",
"file_id": "66972349b2b12fa309a143fb9db29647b2ddabfd",
"is_folder": true,
"name": "1.mov",
"size": 218052,
"updated_at": 1721368014000,
"items": [
{
"drive_id": "5060",
"file_id": "66972349b2b12fa309a143fb9db29647b2ddabfd",
"is_folder": true,
"name": "1.mov",
"size": 218052,
"updated_at": 1721368014000,
"items": [
{
"drive_id": "5060",
"file_id": "66972349b2b12fa309a143fb9db29647b2ddabfd",
"is_folder": true,
"name": "1.mov",
"size": 218052,
"updated_at": 1721368014000,
"items": []
}
]
}
]
}
],
"category": "album",
"created_at": "2019-08-20T06:51:27.292Z",
"started_at": "2019-08-20T06:51:27.292Z",
"finished_at": "2019-08-20T06:51:27.292Z",
"skipped_process": 0,
"failed_process": 0
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。