Drive and Photo Service:GetAsyncTask - Drive and Photo Service

Retrieve information about an asynchronous task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v2/async_task/get HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No
async_task_id	string	Yes	The ID of the asynchronous task.	000e89fb-cf8f-11e9-8ab4-b6e980803a3b

Response elements

Element	Type	Description	Example
	object	Schema of Response
async_task_id	string	Asynchronous task ID	000e89fb-cf8f-11e9-8ab4-b6e980803a3b
status	string	Warning Deprecated. Use the state field instead. Task status Failed Running PartialSucceed Succeed Valid values: Failed : Failed Running : Running PartialSucceed : PartialSucceed Succeed : Succeed	Succeed
state	string	Task status Failed Running PartialSucceed Succeed	Succeed
message	string	Warning Deprecated. Use the error_message field instead. Asynchronous task error message	The request has been failed due to some unknown error. Please try again later.
err_code	integer	Warning Deprecated. Use the error_code field instead. Asynchronous task error code	404
total_process	integer	Total number of items to process for the asynchronous task, such as the number of files to package for server-side packaging and download.	1000
consumed_process	integer	Total number of items processed for the asynchronous task, such as the number of files already packaged for server-side packaging and download.	100
url	string	Download URL for data generated by the asynchronous task, such as the download URL generated by a server-side packaging and download task.	https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
error_code	string	Task error code	InternalError
error_message	string	Task error message	The request has been failed due to some unknown error. Please try again later.
uncompress_file_list	array	List of uncompressed file information
	UncompressedFileInfo	Uncompressed file information
category	string	Custom task category	album
created_at	string	Task creation time, ISO format, such as: 2019-03-28T13:03:29.298Z	2019-08-20T06:51:27.292Z
started_at	string	Task start time, ISO format, such as: 2019-03-28T13:03:29.298Z	2019-08-20T06:51:27.292Z
finished_at	string	Task completion time, ISO format, such as: 2019-03-28T13:03:29.298Z	2019-08-20T06:51:27.292Z
skipped_process	integer	Number of skipped items for the asynchronous task	0
failed_process	integer	Number of failed items for the asynchronous task	0
task_type	string

Examples

Success response

JSON format

{
  "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": 404,
  "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,
  "task_type": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.