QueryDeviceByTags - IoT Platform

使用說明

單次調用，最多可輸入10個標籤。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數（QPS）最大限制為5。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceByTags	系統規定參數。取值：QueryDeviceByTags。
Tag.N.TagKey	String	是	room	裝置標籤的Key。
Tag.N.TagValue	String	是	101	裝置標籤的值。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
CurrentPage	Integer	否	1	指定從返回結果中的第幾頁開始顯示。預設值是1。
PageSize	Integer	否	10	指定返回結果中每頁顯示的裝置記錄數量，最大值是50。預設值是10。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of SimpleDeviceInfo		調用成功時，返回的裝置資訊列表（SimpleDeviceInfo）。
SimpleDeviceInfo
DeviceName	String	light1	裝置名稱。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	物聯網平台為該裝置頒發的ID，作為該裝置的唯一識別碼。
ProductKey	String	a1BwAGV****	裝置所屬產品的ProductKey。
ProductName	String	lamp	產品名稱。
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	1	總記錄數。

樣本

請求樣本

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceByTags
&CurrentPage=1
&PageSize=10
&Tag.1.TagKey=room
&Tag.1.TagValue=101
&Tag.2.TagKey=city
&Tag.2.TagValue=hangzhou
&<公用請求參數>

正常返回樣本

XML格式

<QueryDeviceByTags>
  <PageCount>1</PageCount>
  <Data>
        <SimpleDeviceInfo>
              <DeviceName>1102jichu02</DeviceName>
              <ProductKey>a1SM5S1****</ProductKey>
              <IotId>GookTiUcwqRbHosp9Ta10****3a00</IotId>
              <ProductName>TEST</ProductName>
        </SimpleDeviceInfo>
  </Data>
  <PageSize>10</PageSize>
  <Page>1</Page>
  <RequestId>2B5091E4-32D5-4884-A5B2-2E8E713D84AF</RequestId>
  <Success>true</Success>
  <Total>1</Total>
</QueryDeviceByTags>

JSON格式

{
    "PageCount": 1,
    "Data": {
        "SimpleDeviceInfo": [
            {
                "DeviceName": "1102jichu02",
                "ProductKey": "a1SM5S1****",
                "IotId": "GookTiUcwqRbHosp9Ta10****3a00",
                "ProductName": "TEST"
            }
        ]
    },
    "PageSize": 10,
    "Page": 1,
    "RequestId": "2B5091E4-32D5-4884-A5B2-2E8E713D84AF",
    "Success": true,
    "Total": 1
}

錯誤碼

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