調用該接口查詢指定產品下的設備列表。

使用說明

調用該接口，單次最多查詢到100萬個設備。

QPS限制

  • 單個阿里云賬號調用該接口的每秒請求數（QPS）最大限制為50。
    說明 RAM用戶共享阿里云賬號配額。

  • 當請求參數CurrentPage與PageSize的值相乘結果大于或等于100,000時，會降低調用該接口的QPS。

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

調試

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

請求參數

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

系統規定參數。取值：QueryDevice。
ProductKey String 是 a1BwAGV****

要查詢的設備所屬產品的ProductKey。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

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

實例的更多信息，請參見實例概述。

PageSize Integer 否 10

指定返回結果中每頁顯示的記錄數量，最大值是50。默認值是10。
CurrentPage Integer 否 1

指定顯示返回結果中的第幾頁的內容。默認值是 1。
NextToken String 否 TGlzdFJlc291cm***

下一頁標識，首次查詢無需傳入。后續查詢需使用的NextToken，要從上一次查詢的返回結果中獲取。

當PageSize×CurrentPage值大于10,000時，必須傳入NextToken。否則，無法返回數據。

重要

如果傳入NextToken值，則PageSize×CurrentPage值必須小于1,000,000。否則，無法返回數據。

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

返回數據

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

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

Data Array of DeviceInfo

調用成功時，返回設備信息列表（DeviceInfo）。

說明 返回的設備信息按照設備創建時間倒序排列。
DeviceInfo
DeviceId String dwnS41bhNxjslDAI****

設備ID（舊版參數）。

說明 該參數是舊版本遺留參數，已無實際作用，不能用來標識設備。目前，有效的設備標識符為IotId和ProductKey與DeviceName組合。
DeviceName String light

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

設備密鑰。
DeviceStatus String ONLINE

設備狀態。取值：

  • ONLINE：設備在線。
  • OFFLINE：設備離線。
  • UNACTIVE：設備未激活。
  • DISABLE：設備已禁用。
DeviceType String Lighting

設備所屬產品的品類。

說明 目前不返回此參數。
GmtCreate String Wed, 20-Feb-2019 02:16:09 GMT

設備創建時間，GMT格式。
GmtModified String Wed, 20-Feb-2019 02:16:09 GMT

設備信息最后一次更新時的時間，GMT格式。
IotId String Q7uOhVRdZRRlDnTLv****00100

設備ID。物聯網平臺為該設備頒發的ID，設備的唯一標識符。
Nickname String 智能燈設備

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

設備所隸屬的產品ProductKey。
UtcCreate String 2019-02-20T02:16:09.000Z

設備創建時間，UTC格式。
UtcModified String 2019-02-20T02:16:09.000Z

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

調用失敗時，返回的出錯信息。
NextToken String TGlzdFJlc291cm***

下一頁標識。可在下次請求時傳入，來獲取下一頁數據。

如果NextToken值為空，表示沒有下一頁數據。

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=QueryDevice
&ProductKey=aldafD****
&PageSize=10
&CurrentPage=1
&<公共請求參數>

正常返回示例

XML格式 

<QueryDeviceResponse>
  <PageCount>1</PageCount>
  <NextToken>TGlzdFJlc291cm***</NextToken>
  <Data>
        <DeviceInfo>
              <DeviceId>Av8NGHGtwPrH9BYG****</DeviceId>
              <DeviceName>Av8NGHGtwPrH9BYGLMBi</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>d7GYhf5hfcPHDe1bXSd3n9MjO1G3****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>Av8NGHGtwPrH9BYGLMBi00****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>SensorInShanghai</Nickname>
        </DeviceInfo>
        <DeviceInfo>
              <DeviceId>zNIcSmWQ9BPJlmkj****</DeviceId>
              <DeviceName>zNIcSmWQ9BPJlmkjn3H1</DeviceName>
              <ProductKey>a1dafDE****</ProductKey>
              <DeviceSecret>C27XXmC18yLIEDXvUj6FSlvgO7ag****</DeviceSecret>
              <UtcModified>2019-02-20T02:16:09.000Z</UtcModified>
              <GmtCreate>Wed, 20-Feb-2019 02:16:09 GMT</GmtCreate>
              <UtcCreate>2019-02-20T02:16:09.000Z</UtcCreate>
              <GmtModified>Wed, 20-Feb-2019 02:16:09 GMT</GmtModified>
              <IotId>zNIcSmWQ9BPJlmkjn3H100****</IotId>
              <DeviceStatus>UNACTIVE</DeviceStatus>
              <Nickname>DriverInShanghai</Nickname>
        </DeviceInfo>
  </Data>
  <Page>1</Page>
  <PageSize>10</PageSize>
  <RequestId>CD9E5F99-A095-4A05-9256-D924EA3075E8</RequestId>
  <Success>true</Success>
  <Total>2</Total>
</QueryDeviceResponse>

JSON格式 

{
  "PageCount": 1,
  "NextToken":"TGlzdFJlc291cm***", 
  "Data": {
    "DeviceInfo": [
      {
        "DeviceId": "Av8NGHGtwPrH9BYG****", 
        "DeviceName": "Av8NGHGtwPrH9BYGLMBi", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "d7GYhf5hfcPHDe1bXSd3n9MjO1G3****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "Av8NGHGtwPrH9BYGLMBi00****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "SensorInShanghai"
      }, 
      {
        "DeviceId": "zNIcSmWQ9BPJlmkj****", 
        "DeviceName": "zNIcSmWQ9BPJlmkjn3H1", 
        "ProductKey": "a1dafDE****", 
        "DeviceSecret": "C27XXmC18yLIEDXvUj6FSlvgO7ag****", 
        "UtcModified": "2019-02-20T02:16:09.000Z", 
        "GmtCreate": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "UtcCreate": "2019-02-20T02:16:09.000Z", 
        "GmtModified": "Wed, 20-Feb-2019 02:16:09 GMT", 
        "IotId": "zNIcSmWQ9BPJlmkjn3H100****", 
        "DeviceStatus": "UNACTIVE", 
        "Nickname": "DriverInShanghai"
      }
    ]
  }, 
  "Page": 1, 
  "PageSize": 10, 
  "RequestId": "CD9E5F99-A095-4A05-9256-D924EA3075E8", 
  "Success": true, 
  "Total": 2
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。