文档首页/ 智能设施云平台/ API参考/ API列表/ 分组控制管理/ 分组任务/ 查询单个分组任务

更新时间：2025-08-19 GMT+08:00

查看PDF

查询单个分组任务

功能介绍

查询单个分组任务

URI

GET /v1/iotfm/group-tasks/{task_id}

表1 路径参数
参数	是否必选	参数类型	描述
task_id	是	String	参数说明：分组任务ID。取值范围：长度不超过64，只允许字母、数字、以及_-字符的组合。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数说明：分页查询时每页显示的记录数，默认值为10。取值范围：1-50的整数。
marker	否	String	参数说明：上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。取值范围：长度24，只允许大小写字母、数字的组合。
offset	否	Integer	参数说明：表示从marker后偏移offset条记录开始查询。默认为0，取值范围为0-500的整数。当offset为0时，表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑，您可以搭配marker使用该参数实现翻页，例如每页50条记录，1-11页内都可以直接使用offset跳转到指定页，但到11页后，由于offset限制为500，您需要使用第11页返回的marker作为下次查询的marker，以实现翻页到12-22页。取值范围：0-500的整数。
status	否	String	参数说明：任务状态。取值范围：成功（Success），失败（Fail）。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数说明：用户Token。通过调用生成Token 接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。取值范围：长度1-32768。
X-Instance-Id	是	String	参数说明：实例ID。通过访问智能设施云平台界面后获取，智能设施云平台资源均为实例级隔离，所有业务接口必须填写正确的实例ID才能被成功调用。取值范围：长度8-36，只允许大小写字母、数字和-字符的组合。
X-Root-Zone-Id	否	String	参数说明：根区域ID。取值范围：长度不超过24，只允许字母、数字的组合。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
task_info	GroupTask object	设备分组控制任务结构体
devices	Array of DevicesInfo objects	参数说明：单个任务设备任务执行详情。取值范围：数组长度不超过50。
page	Page object	查询批量分页结构体，定义了分页页码、每页记录数、记录总数、该页记录的最大Id。

表5 GroupTask
参数	参数类型	描述
task_id	String	参数说明：分组控制任务ID。取值范围：长度不超过64，只允许字母、数字、以及_-字符的组合。
group_control_id	String	参数说明：分组控制ID。取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。
group_id	String	参数说明：设备分组ID。取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。
operator	String	参数说明：用户名。取值范围：长度不超过64，只允许字母、数字、以及_-字符的组合。
success	Integer	参数说明：执行成功数量。取值范围：1~100。
fail	Integer	参数说明：执行失败数量。取值范围：1~100。
create_time	String	格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
finish_time	String	格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
executing	Integer	参数说明：正在执行任务数量。取值范围：1~100。
task_content	Array of GroupTaskContent objects	参数说明：任务内容。取值范围：数组长度不超过100。

表6 GroupTaskContent
参数	参数类型	描述
product_id	String	参数说明：产品ID。取值范围：长度不超过36，只允许字母、数字、以及_-字符的组合。
action_type	String	参数说明：DEVICE_CONTORL：下发设备控制指令类型。当选择该类型时，必须传入device_control对象。
device_control	ActionDeviceControl object	参数说明：下发设备控制任务内容。当action_type为DEVICE_CONTROL时，该字段必填。

表7 ActionDeviceControl
参数	参数类型	描述
property_path	String	参数说明：设备属性。取值范围：长度不超过128，只允许中文，字母、数字、以及_?/'#().,&%@$!-字符的组合。
property_value	Object	参数说明：设备属性值。
priority	Integer	参数说明：任务优先级。取值范围：8~16。
end_time	String	参数说明：任务结束时间。取值范围：格式为："yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"。
description	String	参数说明：操作说明。取值范围：长度不超过1024，只允许中文，字母、数字、以及_?/'#().,&%@$!-字符的组合。

表8 DevicesInfo
参数	参数类型	描述
device_id	String	参数说明：设备ID。取值范围：长度不超过128，只允许字母、数字、以及_-字符的组合。
device_name	String	参数说明：设备名称。取值范围：长度不超过64，只允许中文、字母、数字、以及_-字符的组合。
status	String	参数说明：任务的执行状态，结果范围：Waitting，Processing，Success，Fail。取值范围： Waitting: 等待执行。 Processing: 执行中。 Success: 成功。 Fail: 失败。

表9 Page
参数	参数类型	描述
count	Long	参数说明：本次分页查询结果中，获取的记录总数。取值范围：0-9223372036854775807的整数。
marker	String	参数说明：本次分页查询结果中最后一条记录的ID，可在下一次分页查询时使用。取值范围：长度不超过64的字符串。

状态码：400

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

查询分组任务详情

POST https://{endpoint}/v1/iotfm/group-tasks/18ca04467573e84c6350ed55?offset=0&limit=10

响应示例

状态码：200

{
  "task_info" : {
    "task_id" : "18ca04467573e84c6350ed55",
    "group_id" : "18ca020ed943e84c6350ed4a",
    "operator" : "iotfm_echotest_admin",
    "success" : 0,
    "fail" : 1,
    "executing" : 0,
    "create_time" : "2024-12-27T01:52:49.999Z",
    "finish_time" : "2024-11-27T01:52:49.999Z",
    "task_content" : [ {
      "product_id" : "18c9fa374df47041550bea48",
      "action_type" : "DEVICE_CONTROL",
      "device_control" : {
        "property_path" : "service1/switch",
        "property_value" : false,
        "priority" : 16,
        "description" : "打开路灯"
      }
    } ]
  },
  "devices" : [ {
    "device_id" : "123000456",
    "device_name" : "路灯",
    "status" : "Fail"
  } ],
  "page" : {
    "count" : 1,
    "marker" : "18ca044678d3e84c6350ed57"
  }
}

状态码

状态码	描述
200	OK
400	Bad Request

父主题： 分组任务

上一篇：查询分组任务列表

下一篇：执行分组任务

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

盘古Doer提问云社区提问

查询单个分组任务

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

相关文档

意见反馈

文档内容是否对您有帮助？