Delete Topological Relationships for Sub-devices


An edge can publish a message to this topic to delete the topological relationship between the edge and a sub-device.


After you delete the topological relationship of the sub-device, the sub-device can no longer connect to the EnOS Cloud through the edge.


Upstream

  • Request TOPIC: /sys/{productKey}/{deviceKey}/thing/topo/delete
  • Reply TOPIC: /sys/{productKey}/{deviceKey}/thing/topo/delete_reply

Note

The productKey and deviceKey in the TOPIC are the credentials of the edge.

Sample Request Format

{
  "id": "123",
  "version": "1.0",
  "params": [
    {
      "deviceKey": "deviceKey1234",
      "productKey": "1234556554"
    }
  ],
  "method": "thing.topo.delete"
}

Sample Response Format

{
  "id": "123",
  "code": 200,
  "data": {}
}

Request Parameter Description

Parameter Type Mandatory/Optional Description
id String Optional The message ID. It is a reserved parameter that is reserved for future use.
version String Mandatory The version of the protocol. The current version is 1.0.
params Array Mandatory The parameters used for deleting topological relationships.
deviceKey String Mandatory The device Key of the sub-device.
productKey String Mandatory The product key of the sub-device.
method String Mandatory The request method.

Response Parameter Description

Parameter Type Mandatory/Optional Description
code Integer Mandatory The return code. “200” indicates that the requested operation is executed successfully.

Return Code

Return Code Error Message Explanation
1256 Remove topo failure, [details] Part or all of the sub-devices cannot be removed. To troubleshoot the problem, you must read the details of this return code. [1]
[1]

Details of this return code can be categorized into the following:

  • The device that you wish remove the sub-devices from is not a gateway device.
  • The sub-device does not exist.
  • The sub-device is online.
  • The device to be removed is not a sub-device of the gateway device.