調用該接口禁用指定設備。
限制說明
- 設備被禁用后將不能接入物聯網平臺,您將無法執行與設備有關的操作,但與設備關聯的信息依然保留。您可以調用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
}