RemoveThingTopo - IoT Platform - Alibaba Cloud Documentation Center

Deletes the topological relationships between a gateway and all attached sub-devices, or the topological relationship between a sub-device and the gateway to which the sub-device is attached.

Usage notes

If you specify a gateway, this operation removes the topological relationships between the gateway and all attached sub-devices.
If you specify a sub-device, this operation removes the topological relationship between the sub-device and the gateway to which the sub-device is attached.

QPS limits

Each Alibaba Cloud account can run up to 500 queries per second (QPS).

Note The RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	RemoveThingTopo	The operation that you want to perform. Set the value to RemoveThingTopo.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console. Important If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails. If no Overview page or ID is generated for your instance, you do not need to configure this parameter. For more information, see Overview.
ProductKey	String	No	a1BwAGV****	The ProductKey of the product to which the device belongs. Note If you specify a value for this parameter, you must also specify a value for the DeviceName parameter.
DeviceName	String	No	light	The DeviceName of the device. Note If you specify a value for this parameter, you must also specify a value for the ProductKey parameter.
IotId	String	No	Q7uOhVRdZRRlDnTLv****00100	The ID of the device. The ID is a unique identifier that is issued by IoT Platform to the device. Note If you specify a value for this parameter, you do not need to specify a value for the ProductKey or DeviceName parameter. The IotId parameter specifies a globally unique identifier (GUID) for the device. The value of the IotId parameter corresponds to a combination of the values of the ProductKey and DeviceName parameters. If you specify a value for the IotId parameter and values for the ProductKey and DeviceName parameters, the value of the IotId parameter takes precedence.

In addition to the preceding operation-specific request parameters, you must configure common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters


Parameter	Type	Example	Description
Code	String	iot.system.SystemException	The error code returned if the call fails. For more information, see Error codes.
Data	Boolean	true	Indicates whether the topological relationship was deleted. true: The topological relationship was deleted. false: The topological relationship failed to be deleted.
ErrorMessage	String	A system exception occurred.	The error message returned if the call fails.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	The ID of the request.
Success	Boolean	true	Indicates whether the call was successful. true: The call was successful. false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=RemoveThingTopo
&ProductKey=a1bPo9p****
&DeviceName=device1
&<Common request parameters>

Sample success responses

XML format

<RemoveThingTopoResponse>
  <Data>true</Data>
  <RequestId>098BEEF4-58F4-4181-A891-5D37DB6C4C3B</RequestId>
  <Success>true</Success>
</RemoveThingTopoResponse>

JSON format

{
    "Data": true,
    "RequestId": "098BEEF4-58F4-4181-A891-5D37DB6C4C3B",
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.