调用该接口禁用指定设备。
限制说明
- 设备被禁用后将不能接入物联网平台，您将无法执行与设备有关的操作，但与设备关联的信息依然保留。您可以调用EnableThing接口重新接入被禁用的设备。
-
单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DisableThing |
系统规定参数。取值：DisableThing。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。 必须传入实例ID，否则调用会失败。您可在物联网平台控制台的实例概览页面，查看您的实例ID。 注意
如果公共实例没有ID，请参见如何获取实例ID。 |
| ProductKey | String | 否 | a1BwAGV**** |
设备所隶属的产品ProductKey。 说明 如果传入该参数，需同时传入DeviceName。
|
| DeviceName | String | 否 | light |
设备名称。 说明 如果传入该参数，需同时传入ProductKey。
|
| IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 |
要禁用设备的ID。物联网平台为该设备颁发的ID，设备的唯一标识符。 说明 如果传入该参数，则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符，和ProductKey与DeviceName组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName组合，则以IotId为准。
|
调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | iot.system.SystemException |
调用失败时，返回的错误码。更多信息，请参见错误码。 |
| ErrorMessage | String | 系统异常 |
调用失败时，返回的出错信息。 |
| RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
| Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
https://iot.cn-shanghai.aliyuncs.com/?Action=DisableThing
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共请求参数>正常返回示例
XML格式
<DisableThingResponse>
<RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
<Success>true</Success>
</DisableThingResponse>JSON格式
{
"RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
"Success": true
}