QueryDevice - IoT Platform

使用說明

調用該介面，單次最多查詢到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
}

錯誤碼

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