有奖:语音产品征文挑战赛等你来> HOT

1. 接口描述

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

用于查询任务详情

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTask。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,此参数为可选参数。
TaskId String 简单任务或复杂任务ID
示例值:4d3535ba-3d81-4154-85ac-****

3. 输出参数

参数名称 类型 描述
Data TaskData 任务详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

输入示例

POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:     DescribeTask
<公共请求参数>

{
    "TaskId": "6d915841-****-****-****-5b278a217051"
}

输出示例

{
    "Response": {
        "Data": {
            "TaskId": "6d915841-****-****-****-5b278a217051",
            "Status": 2,
            "FailReason": "",
            "Progress": 0.94,
            "TaskType": 2,
            "Action": "BatchEnableDevice",
            "ActionZhDesc": "批量启用设备",
            "Total": 3,
            "SuccessCount": 1,
            "FailCount": 1,
            "RunningCount": 1,
            "ResourceId": "",
            "StartedAt": "2023-07-18 12:15:41",
            "CreatedAt": "2023-07-18 12:11:57",
            "UpdatedAt": "2023-07-18 14:27:06",
            "Runtime": 170209866
        },
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DatabaseError 数据库错误
FailedOperation.RequestTimeout 请求超时
InvalidParameter.InvalidParameterFormat 参数格式不对或缺少参数
InvalidParameter.RequiredHeaderParameterEmpty 必要请求头参数不能为空
InvalidParameter.TaskIdNotExist TaskId不存在
InvalidParameterValue.TaskTypeNotSupported 不支持任务类型