調(diào)用該接口通過(guò)標(biāo)簽查詢?cè)O(shè)備。

使用說(shuō)明

單次調(diào)用，最多可輸入10個(gè)標(biāo)簽。

QPS限制

單個(gè)阿里云賬號(hào)調(diào)用該接口的每秒請(qǐng)求數(shù)（QPS）最大限制為5。

說(shuō)明 RAM用戶共享阿里云賬號(hào)配額。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求參數(shù)

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

系統(tǒng)規(guī)定參數(shù)。取值：QueryDeviceByTags。
Tag.N.TagKey String 是 room

設(shè)備標(biāo)簽的Key。
Tag.N.TagValue String 是 101

設(shè)備標(biāo)簽的值。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實(shí)例ID。您可在物聯(lián)網(wǎng)平臺(tái)控制臺(tái)的實(shí)例概覽頁(yè)面，查看當(dāng)前實(shí)例的ID。

注意
  • 若有ID值，必須傳入該ID值，否則調(diào)用會(huì)失敗。
  • 若無(wú)ID值，則無(wú)需傳入。

實(shí)例的更多信息，請(qǐng)參見實(shí)例概述。

CurrentPage Integer 否 1

指定從返回結(jié)果中的第幾頁(yè)開始顯示。默認(rèn)值是1。
PageSize Integer 否 10

指定返回結(jié)果中每頁(yè)顯示的設(shè)備記錄數(shù)量，最大值是50。默認(rèn)值是10。

調(diào)用API時(shí)，除了本文介紹的該API的特有請(qǐng)求參數(shù)，還需傳入公共請(qǐng)求參數(shù)。公共請(qǐng)求參數(shù)說(shuō)明，請(qǐng)參見公共參數(shù)文檔。

返回?cái)?shù)據(jù)

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

調(diào)用失敗時(shí)，返回的錯(cuò)誤碼。更多信息，請(qǐng)參見錯(cuò)誤碼。

Data Array of SimpleDeviceInfo

調(diào)用成功時(shí)，返回的設(shè)備信息列表（SimpleDeviceInfo）。

SimpleDeviceInfo
DeviceName String light1

設(shè)備名稱。
IotId String Q7uOhVRdZRRlDnTLv****00100

物聯(lián)網(wǎng)平臺(tái)為該設(shè)備頒發(fā)的ID，作為該設(shè)備的唯一標(biāo)識(shí)符。
ProductKey String a1BwAGV****

設(shè)備所屬產(chǎn)品的ProductKey。
ProductName String lamp

產(chǎn)品名稱。
ErrorMessage String 系統(tǒng)異常

調(diào)用失敗時(shí)返回的出錯(cuò)信息。
Page Integer 1

當(dāng)前頁(yè)面號(hào)。
PageCount Integer 1

總頁(yè)數(shù)。
PageSize Integer 10

每頁(yè)顯示的記錄數(shù)。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請(qǐng)求生成的唯一標(biāo)識(shí)符。
Success Boolean true

表示是否調(diào)用成功。

  • true：調(diào)用成功。
  • false：調(diào)用失敗。
Total Integer 1

總記錄數(shù)。

示例

請(qǐng)求示例

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
&<公共請(qǐng)求參數(shù)>

正常返回示例

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
}