Help Center/ IoT Device Access/ API Reference/ MQTT or MQTTS API Reference on the Device Side/ Gateway and Child Device Management/ Platform Responding to a Request for Deleting Child Devices
Updated on 2023-02-16 GMT+08:00
View PDF
Share

Platform Responding to a Request for Deleting Child Devices

Function

This API is used by the platform to respond to a gateway's request for deleting child devices. The response is returned within 30 seconds after the platform receives the request and includes a list of child devices that are deleted.

Topic

Downstream: $oc/devices/{device_id}/sys/events/down

Parameters

Parameter

Mandatory or Optional

Type

Description

object_device_id

Optional

String

Identifies a gateway.

services

Optional

List<ServiceEvent>

Indicates a list of services that the event is about.

ServiceEvent structure

Parameter

Mandatory or Optional

Type

Description

service_id

Mandatory

String

System field. The value is fixed to $sub_device_manager.

event_type

Mandatory

String

System field. The value is fixed to delete_sub_device_response.

event_time

Optional

String

Indicates the time when the event occurs.

event_id

Mandatory

String

Identifies a request event. The value is used to associate with the corresponding request event.

paras

Mandatory

Object

Indicates the event parameters in JSON format.

paras structure

Parameter

Mandatory or Optional

Type

Description

successful_devices

Mandatory

List<String>

Indicates the device IDs of child devices that are deleted.

failed_devices

Mandatory

List<Reason>

Indicates the cause for the deletion failure.

Reason structure

Parameter

Mandatory or Optional

Type

Description

device_id

Mandatory

String

The value is that of device_id of the corresponding device in the corresponding request.

error_code

Mandatory

String

Indicates the error code.

error_msg

Mandatory

String

Indicates the error description.

Example

Topic: $oc/devices/{device_id}/sys/events/down  
Data format:
{
  "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"
          }
        ]
      }
    }
  ]
}