QueryDeviceByStatus - IoT Platform

使用說明

裝置狀態變更後，新的狀態資料會在變更後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"
      }
    ]
  }  
}

錯誤碼

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