获取任务列表

最近更新时间:2019-04-30 15:23:05

1. 接口描述

本接口(ListTasks)用于查询已创建的任务列表,任务保留一个月。

接口请求域名:iotcloud.api.qcloud.com

2.输入参数

以下是请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 必选 类型 描述
pageNum Int 分页页数,返回第 pageNum 页的结果。
pageSize Int 分页的大小,数值范围 1-250

3.输出参数

参数名称 类型 描述
code Int 公共错误码。0 表示成功,其他值表示失败,详见 公共错误码 页面。
message String 模块错误信息描述,格式为 "(模块错误码)模块错误信息" 详见本页面的 模块错误码
codeDesc String 模块错误码的英文描述
taskTotalCount Int 用户一个月内创建的任务总数
tasks Array of Task 此页任务对象的数组,按创建时间排序

Task 的结构如下:

参数名称 类型 描述
type String 任务类型,目前取值为 “UpdateShadow” 或者 “PublishMessage”
id String 任务 ID
productID String 产品 ID
status Int 状态。1表示等待处理,2表示调度处理中,3表示已完成,4表示失败,5表示已取消
createTime Int 任务创建时间,Unix 时间戳
updateTime Int 最后任务更新时间,Unix 时间戳
retCode Int 返回的错误码
errMsg String 返回的错误信息

4.示例

输入

  https://iotcloud.api.qcloud.com/v2/index.php?Action=ListTasks
  &pageNum=1&pageSize=10
  &<公共请求参数>

输出

{
    "tasks": [
        {
            "type": "PublishMessage",
            "id": "5ad5b9a53332ea3de678ea52",
            "productID": "ABCDE12345",
            "status": 3,
            "createTime": 1523956133,
            "updateTime": 1523958284,
            "retCode": 0,
            "errMsg": ""
        },
        {
            "type": "UpdateShadow",
            "id": "5ad5b9743332ea3de678ea51",
            "productID": "ABCDE12345",
            "status": 1,
            "createTime": 1523956084,
            "updateTime": 1523956084,
            "retCode": 0,
            "errMsg": ""
        }
    ],
    "taskTotalCount": 2,
    "message": "",
    "codeDesc": "Success",
    "code": 0
}

模块错误码

模块错误码 描述
10100 内部服务器错误,请联系技术人员
10101 请求参数非法