文档

GetAsyncTask - 获取异步任务信息

更新时间:

根据CopyCdsFile接口获得的AsyncTaskId返回参数获取文件夹复制异步任务的详细信息。

调试

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

授权信息

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

请求参数

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

企业网盘 ID。

cn-shanghai+cds-135515****
AsyncTaskIdstring

异步任务 ID。调用 CopyCdsFile 接口复制文件夹时,因为是后台异步复制,所以会返回该字段。调用本接口并传入该异步任务 ID 即可获取任务详细信息。

81a8a07a-aec4-4dd5-80da-ae69e482****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Successstring

操作是否成功。

枚举值:
  • true成功
  • false失败
true
Codestring

执行结果。返回success表示成功,否则将返回错误信息。

success
Dataobject

数据信息。

Statusstring

任务状态。

枚举值:
  • Failed失败
  • Running运行中
  • PartialSucceed部分成功
  • Succeed成功
Failed
TotalProcesslong

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

1000
Urlstring

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

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

异步任务错误码。

InternalError
AsyncTaskIdstring

异步任务 ID。

000e89fb-cf8f-11e9-8ab4-b6e98080****
Messagestring

异步任务的错误信息。

The request failed due to some unknown errors. Please try again later.
ConsumedProcessstring

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

100

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Success": "true",
  "Code": "success",
  "Data": {
    "Status": "Failed",
    "TotalProcess": 1000,
    "Url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
    "ErrCode": 0,
    "AsyncTaskId": "000e89fb-cf8f-11e9-8ab4-b6e98080****",
    "Message": "The request failed due to some unknown errors. Please try again later.",
    "ConsumedProcess": "100"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈