查询群组任务进度

更新时间：2024-06-29 02:32:28下载pdf

本文介绍查询群组任务进度的 API。

接口描述

根据群组 ID 和任务 ID，查询群组任务进度。

接口地址

GET: /v2.1/cloud/thing/group/task/{group_id}/{task_id}

请求参数

参数名	类型	参数位置	是否必填	说明
group_id	Long	path	true	群组 ID。
task_id	Long	path	true	任务 ID。

返回参数

参数名	类型	说明
result	JsonObject	返回群组数据结果。
success	Boolean	API 调用是否成功。 `true`：调用成功。 `false`：调用失败。
t	Long	时间戳。
tid	String	链路 ID。

result 说明

参数名	类型	说明
group_id	Long	群组 ID。
task_id	String	任务 ID。
task_type	Integer	任务类型。 `1`：添加，例如创建群组。 `2`：更新，例如添加设备入群组、从群组中移除设备。 `3`：删除，例如删除群组。
success_devices	List	加入群组成功或者从群组中移除成功的设备列表。
failed_devices	List	加入群组失败，从群组中移除失败，不支持群组功能以及设备离线的设备列表。
operating_devices	List	未进行操作或者还在操作中的设备列表。

operating_devices 说明

参数名	类型	说明
device_id	String	设备 ID。
action	Integer	操作类型。 `0`：添加设备到群组。 `1`：从群组中移除设备。
operate_status	Integer	操作状态。 `-1`：未操作。 `-2`：操作中。

failed_devices 说明

参数名	类型	说明
device_id	String	设备 ID。
action	Integer	操作类型。 `0`：添加设备到群组。 `1`：从群组中移除设备。
operate_status	Integer	操作状态。 `1`：超过加入数量上限。 `2`：子设备超时。 `3`：设置值超出范围。 `4`：写文件错误。 `5`：其他错误。 `-3`：设备超时返回。 `-4`：设备不支持群组，无法加入。 `-5`：设备离线，无法加入。

success_devices 说明

参数名	类型	说明
device_id	String	设备 ID。
action	Integer	操作类型。 `0`：添加设备到群组。 `1`：从群组中移除设备。
operate_status	Integer	操作状态。 `0`：操作成功。

请求示例

GET: /v2.1/cloud/thing/group/task/1393****/178304019638051****

返回示例

{
    "tid": "b0d2f182022211efbe7a366d87620758",
    "result": {
        "operating_devices": [
        ],
        "failed_devices": [
        ],
        "task_id": "1783040196380512***",
        "success_devices": [
            {
                "device_id": "vdevo17059963185****",
                "operate_status": 0,
                "action": 0
            },
            {
                "device_id": "vdevo17059963113****",
                "operate_status": 0,
                "action": 0
            }
        ],
        "group_id": 13931111,
        "task_type": 1
    },
    "t": 1713953349341,
    "success": true
}

错误码

参考错误码。

调用频率限制

参考调用频率限制。

上一篇获取设备所在群组

下一篇查询群组状态