調用該接口查看指定設備的運行狀態。

QPS限制

單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為500。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 GetDeviceStatus

系統規定參數。取值：GetDeviceStatus。
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

調用失敗時，返回的錯誤碼。更多信息，請參見錯誤碼。

Data Struct

調用成功時，返回設備狀態信息。
Status String ONLINE

設備狀態。取值：

  • ONLINE：設備在線。
  • OFFLINE：設備離線。
  • UNACTIVE：設備未激活。
  • DISABLE：設備已禁用。
Timestamp Long 1557062301656

設備狀態變更時間。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。
Success Boolean true

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=GetDeviceStatus
&ProductKey=a1rYuVF****
&DeviceName=device1
&<公共請求參數>

正常返回示例

XML格式 

<GetDeviceStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>ONLINE</Status>
        <Timestamp>1557062301656</Timestamp>
  </Data>
  <Success>true</Success>
</GetDeviceStatusResponse>

JSON格式 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "ONLINE",
        "Timestamp": 1557062301656
    },
    "Success": true
}