获取任务详情

最近更新时间:2019-07-24 15:21:29

1. 接口描述

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

本接口(DescribeTask)用于查询一个已创建任务的详情,任务保留一个月

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTask
Version String 公共参数,本接口取值:2018-06-14
Region String 公共参数,本接口不需要传递此参数。
Id String 任务ID

3. 输出参数

参数名称 类型 描述
Type String 任务类型,目前取值为 “UpdateShadow” 或者 “PublishMessage”
Id String 任务 ID
ProductId String 产品 ID
Status Integer 状态。1表示等待处理,2表示调度处理中,3表示已完成,4表示失败,5表示已取消
CreateTime Integer 任务创建时间,Unix 时间戳
UpdateTime Integer 最后任务更新时间,Unix 时间戳
DoneTime Integer 任务完成时间,Unix 时间戳
ScheduleTime Integer 被调度时间,Unix 时间戳
RetCode Integer 返回的错误码
ErrMsg String 返回的错误信息
Percent Integer 完成任务的设备比例
AllDeviceCnt Integer 匹配到的需执行任务的设备数目
DoneDeviceCnt Integer 已完成任务的设备数目
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取任务详情

输入示例

https://iotcloud.tencentcloudapi.com/?Action=DescribeTask
&Id=5ad5aa513332ea4cb86e9ad5
&<公共请求参数>

输出示例

{
  "Response": {
    "Type": "PublishMessage",
    "Id": "5ad5b9a53332ea3de678ea52",
    "ProductId": "ABCDE12345",
    "Status": 3,
    "CreateTime": 1523956133,
    "UpdateTime": 1523958284,
    "DoneTime": 1523956134,
    "ScheduleTime": 1523956133,
    "RetCode": 0,
    "ErrMsg": "",
    "Percent": 0,
    "AllDeviceCnt": 2,
    "DoneDeviceCnt": 2,
    "RequestId": "xxxxxxxxxxxxxxxxxxxxxxx"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameterValue 参数取值错误
ResourceNotFound.TaskNotExist 任务不存在。