Call this operation to disable a specified device.

Description

Once a device has been disabled, it cannot connect to IoT Platform, and you cannot perform operations on this device. However, the information about this device is still available in the IoT Platform system. You can use the EnableThing API operation to enable a disabled device.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DisableThing.
IotId String No

The identifier of the device that you want to disable.

Note If you use this parameter, ProductKey and DeviceName are not required. IotId is a globally unique identifier (GUID) of a device, and corresponds to a combination of ProductKey and DeviceName. If you specify both IotId and the combination of ProductKey and DeviceName, the system follows IotId.
ProductKey String No

The ProductKey of the device that you want to disable.

Note If you use this parameter, DeviceName is required.
DeviceName String No

The name of the device that you want to disable.

Note If you use this parameter, ProductKey is required.
Common Request Parameters - Yes For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Description
RequestId String The globally unique ID generated by Alibaba Cloud for the request.
Success Boolean Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.
ErrorMessage String The error message returned when the call fails.
Code String The error code returned when the call fails. For more information about error codes, see Error codes.

Examples

Request example

https://iot.cn-shanghai.aliyuncs.com/?Action=DisableThing
&IotId=MpEKNuEUJzIORNANAWJX0010929900*****
&Public Request Parameters

Response example

  • JSON format

    {
      "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
      "Success": true
    }
  • XML format

    <? xml version='1.0' encoding='utf-8'? >
    <DisableThingResponse>
        <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
        <Success>true</Success>
    </DisableThingResponse>