查询异步任务状态

最近更新时间:2019-07-24 15:01:27

1. 接口描述

接口请求域名: bm.tencentcloudapi.com 。

获取异步操作状态的完成状态

默认接口请求频率限制:50次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeOperationResult
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,本接口不需要传递此参数。
TaskId Integer 异步任务ID

3. 输出参数

参数名称 类型 描述
TaskStatus Integer 任务的整体状态,取值如下:

1:成功

2:失败

3:部分成功,部分失败

4:未完成

5:部分成功,部分未完成

6:部分未完成,部分失败

7:部分未完成,部分失败,部分成功
SubtaskStatusSet Array of SubtaskStatus 各实例对应任务的状态ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务状态

输入示例

https://bm.tencentcloudapi.com/?Action=DescribeOperationResult
&TaskId=123
&<公共请求参数>

输出示例

{
  "Response": {
    "TaskStatus": 1,
    "SubtaskStatusSet": [
      {
        "InstanceId": "cpm-xxx",
        "TaskStatus": 1
      }
    ],
    "RequestId": "223956ff-6e06-40a0-9aad-1056627ed72a"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败
InvalidParameter 参数错误
UnauthorizedOperation 未授权操作