文档

GetAsyncTask - 获取异步任务信息

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

获取异步任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/async_task/get HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体。

async_task_idstring

异步任务 id

000e89fb-cf8f-11e9-8ab4-b6e980803a3b

返回参数

名称类型描述示例值
object

Schema of Response

async_task_idstring

异步任务 id

000e89fb-cf8f-11e9-8ab4-b6e980803a3b
statusstring

警告 已废弃(推荐使用 state 字段替代)

任务状态

  • Failed(失败)

  • Running(运行中)

  • PartialSucceed(部分成功)

  • Succeed(成功)

Succeed
statestring

任务状态

  • Failed(失败)

  • Running(运行中)

  • PartialSucceed(部分成功)

  • Succeed(成功)

Succeed
messagestring

警告 已废弃(推荐使用 error_message 字段替代)
异步任务错误信息

The request has been failed due to some unknown error. Please try again later.
err_codelong

警告 已废弃(推荐使用 error_code 字段替代)
异步任务错误码

404
total_processlong

异步任务需处理总量,如服务端打包下载需打包的文件量

1000
consumed_processlong

异步任务已处理总量,如服务端打包下载已打包的文件量

100
urlstring

异步任务生成数据的下载地址,如服务端打包下载任务生成下载地址

https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx
error_codestring

任务错误码

InternalError
error_messagestring

任务错误信息

The request has been failed due to some unknown error. Please try again later.
uncompress_file_listarray

解压文件信息列表

UncompressedFileInfo

解压文件信息

categorystring

任务自定义类别

album
created_atstring

任务创建时间,ISO 格式, 如:2019-03-28T13:03:29.298Z

2019-08-20T06:51:27.292Z
started_atstring

任务开始时间,ISO 格式, 如:2019-03-28T13:03:29.298Z

2019-08-20T06:51:27.292Z
finished_atstring

任务完成时间,ISO 格式, 如:2019-03-28T13:03:29.298Z

2019-08-20T06:51:27.292Z
skipped_processlong

异步任务已跳过处理的数量

0
failed_processlong

异步任务已处理失败的数量

0

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。