On this page

Show all

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

Platform Responding to a Request for Deleting Child Devices

Updated on 2024-12-02 GMT+08:00

View PDF

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. For details about the relationship between a gateway and its child devices, see Gateway and Child Devices.

Topic

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

Parameters

Parameter	Mandatory/Optional	Type	Description
object_device_id	Optional	String	Explanation: The value is the same as that of device_id in the topic.
services	Optional	List<ServiceEvent>	Explanation: List of services that an event is about.

Parameter

Mandatory/Optional

Type

Description

object_device_id

Optional

String

Explanation:

The value is the same as that of device_id in the topic.

services

Optional

List<ServiceEvent>

Explanation:

List of services that an event is about.

ServiceEvent structure

Parameter	Mandatory/Optional	Type	Description
service_id	Mandatory	String	Explanation: System field. Value range: Fixed at $sub_device_manager.
event_type	Mandatory	String	Explanation: System field. Value range: Fixed at delete_sub_device_response.
event_time	Optional	String	Explanation: Event time. UTC time format: yyyyMMdd'T'HHmmss'Z'.
event_id	Mandatory	String	Explanation: Event ID. The value is used to associate with the corresponding event.
paras	Mandatory	Object	Explanation: Event parameters in JSON format.

paras structure

Parameter	Mandatory/Optional	Type	Description
successful_devices	Mandatory	List<String>	Explanation: IDs of child devices that are deleted.
failed_devices	Mandatory	List<Reason>	Explanation: Cause for the deletion failure.

Parameter

Mandatory/Optional

Type

Description

successful_devices

Mandatory

List<String>

Explanation:

IDs of child devices that are deleted.

failed_devices

Mandatory

List<Reason>

Explanation:

Cause for the deletion failure.

Reason structure

Parameter	Mandatory/Optional	Type	Description
device_id	Mandatory	String	Explanation: The value is that of device_id of the corresponding device in the corresponding request.
error_code	Mandatory	String	Explanation: Error code.
error_msg	Mandatory	String	Explanation: Error description.

Parameter

Mandatory/Optional

Type

Description

device_id

Mandatory

String

Explanation:

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

error_code

Mandatory

String

Explanation:

Error code.

error_msg

Mandatory

String

Explanation:

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"
          }
        ]
      }
    }
  ]
}

Parent topic: Gateway and Child Device Management

Previous topic: Gateway Requesting for Deleting Child Devices

Next topic: Software and Firmware Upgrade