調用該接口根據設備狀態查詢設備列表。

使用說明

設備狀態變更后，新的狀態數據會在變更后10秒內生效。變更數據生效后，才能根據新狀態查詢到該設備；變更數據生效前，根據原狀態仍能查詢到該設備。

QPS限制

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

說明 單個阿里云賬號下的所有RAM用戶共享該阿里云賬號的配額。

調試

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

請求參數

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

系統規定參數。取值：QueryDeviceByStatus。
Status Integer 是 1

設備狀態。 可選值：

  • 0：未激活。
  • 1：在線。
  • 3：離線。
  • 8：已禁用。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。

重要
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無實例概覽頁面或ID值，則無需傳入。
ProductKey String 否 a1BwAGV****

設備所屬的產品ProductKey。
CurrentPage Integer 否 1

指定從返回結果中的第幾頁開始顯示。
PageSize Integer 否 10

指定返回結果中每頁顯示的記錄數量，最大值是50。
ResourceGroupId String 否 rg-acfm4l5tcwd***

資源組ID。

重要 目前，物聯網平臺僅支持實例維度的資源組管理。請求參數ResourceGroupId配置已無效，無需再傳入。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

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

調用成功時，返回的設備信息列表（SimpleDeviceInfo）。
SimpleDeviceInfo
DeviceName String light

設備名稱。
DeviceSecret String sLefbFmN9SYfnWLJTePG893XNuRV****

設備密鑰。
GmtCreate String 2021-02-18 10:46:32

設備創建時的時間，GMT格式。
GmtModified String 2021-02-18 10:46:32

設備信息最后一次修改時的時間，GMT格式。
IotId String Av8NGHGtwPrH9BYGLMBi00****

設備ID。
Nickname String SensorInShanghai

設備的備注名稱。
ProductKey String a1BwAGV****

設備所屬產品的ProductKey。
Status String ONLINE

設備狀態。 取值：

  • UNACTIVE：未激活。
  • ONLINE：在線。
  • OFFLINE：離線。
  • DISABLE：已禁用。
UtcCreate String 2021-02-18T02:46:32.000Z

設備創建時的時間，UTC格式。
UtcModified String 2021-02-18T02:46:32.000Z

設備信息最后一次修改時的時間，UTC格式。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
Page Integer 1

當前頁碼。
PageCount Integer 1

總頁數。
PageSize Integer 10

每頁顯示的設備數。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。
Total Integer 2

查詢到的設備總數。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByStatus
&ProductKey=aldafD****
&Status=0
&PageSize=10
&CurrentPage=1
&<公共請求參數>

正常返回示例

XML格式

<QueryDeviceByStatusResponse>
      <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
      <Success>true</Success>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
      <TotalPageCount>1</TotalPageCount>
      <TotalCount>2</TotalCount>
      <Data>
            <SimpleDeviceInfo>
                  <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
                  <DeviceName>Av8NGHG***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
                  <UtcModified>2021-02-18T02:46:32.000Z</UtcModified>
                  <GmtCreate>2021-02-18 10:46:32</GmtCreate>
                  <UtcCreate>2021-02-18T02:46:32.000Z</UtcCreate>
                  <GmtModified>2021-02-18 10:46:32</GmtModified>
                  <Status>UNACTIVE</Status>
                  <Nickname>SensorInShanghai</Nickname>
            </SimpleDeviceInfo>
            <SimpleDeviceInfo>
                  <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
                  <DeviceName>zNIcSmWQ***</DeviceName>
                  <ProductKey>a1dafDE****</ProductKey>
                  <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
                  <UtcModified>2021-02-09T09:44:55.000Z</UtcModified>
                  <GmtCreate>2021-02-09 17:44:55</GmtCreate>
                  <UtcCreate>2021-02-09T09:44:55.000Z</UtcCreate>
                  <GmtModified>2021-02-09 17:44:55</GmtModified>
                  <DeviceStatus>UNACTIVE</DeviceStatus>
                  <Nickname>DriverInShanghai</Nickname>
            </SimpleDeviceInfo>
      </Data>
</QueryDeviceByStatusResponse>

JSON格式

{
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true,  
  "CurrentPage": 1, 
  "PageSize": 10, 
  "TotalPageCount": 1,
  "TotalCount": 2,
  "Data": {
    "SimpleDeviceInfo": [
      {
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceName": "Av8NGHG***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2021-02-18T02:46:32.000Z", 
        "GmtCreate": "2021-02-18 10:46:32", 
        "UtcCreate": "2021-02-18T02:46:32.000Z", 
        "GmtModified": "2021-02-18 10:46:32", 
        "Status": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceName": "zNIcSmWQ***", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2021-02-09T09:44:55.000Z", 
        "GmtCreate": "2021-02-09 17:44:55", 
        "UtcCreate": "2021-02-09T09:44:55.000Z", 
        "GmtModified": "2021-02-09 17:44:55", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }  
}