文档首页/ 设备接入 IoTDA/ API参考/ 设备侧MQTT/MQTTS接口参考/ 网关与子设备管理/ 网关删除子设备请求响应
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

网关删除子设备请求响应

功能介绍

平台将该网关删除的子设备列表信息通知给网关设备。平台收到网关删除子设备请求后会在30秒内通过此接口返回响应消息。网关与子设备关系，请查看网关与子设备。

Topic

下行: $oc/devices/{device_id}/sys/events/down

参数说明

字段名

必选/可选

类型

参数描述

object_device_id

可选

String

参数解释：

该参数与Topic中的device_id一致。

services

可选

List<ServiceEvent>

参数解释：

事件服务列表。

ServiceEvent定义表

字段名

必选/可选

类型

参数描述

service_id

必选

String

参数解释：

系统字段。

取值范围：

固定为："$sub_device_manager"。

event_type

必选

String

参数解释：

系统字段。

取值范围：

固定为："delete_sub_device_response"。

event_time

可选

String

参数解释：

事件时间。UTC时间，格式：yyyyMMdd'T'HHmmss'Z'。

event_id

必选

String

参数解释：

事件请求Id，通过该参数关联对应的事件请求。

paras

必选

Object

参数解释：

事件参数JSON对象。

paras参数列表

字段名

必选/可选

类型

参数描述

successful_devices

必选

List<String>

参数解释：

成功删除的子设备（设备id）列表。

failed_devices

必选

List<Reason>

参数解释：

子设备删除失败的原因。

Reason定义表

字段名

必选/可选

类型

参数描述

device_id

必选

String

参数解释：

对应请求中指定的设备的device _id。

error_code

必选

String

参数解释：

删除失败错误原因码。

error_msg

必选

String

参数解释：

删除失败原因描述。

示例

Topic: $oc/devices/{device_id}/sys/events/down  
数据格式： 
{
  "object_device_id": "{object_device_id}",
  "services": [
    {
      "service_id": "$sub_device_manager",
      "event_type": "delete_sub_device_response",
      "event_time": "20151212T121212Z",
      "event_id": "40cc9ab1-3579-488c-95c6-c18941c99eb4",
      "paras": {
        "successful_devices": [
          "c6b39067b0325db34663d3ef421a42f6_subdevice11"
        ],
        "failed_devices": [
          {
            "device_id": "c6b39067b0325db34663d3ef421a42f6_subdevice12",
            "error_code": "XXX",
            "error_msg": "XXXX"
          }
        ]
      }
    }
  ]
}