調用該接口根據(jù)標簽查詢設備分組。

QPS限制

單個阿里云賬號調用該接口的每秒請求數(shù)（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調試

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

請求參數(shù)

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

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

分組標簽鍵（key）。
Tag.N.TagValue String 是 tag

分組標簽值（value）。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

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

注意
  • 若有ID值，必須傳入該ID值，否則調用會失敗。
  • 若無ID值，則無需傳入。

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

CurrentPage Integer 否 1

指定顯示查詢結果的第幾頁。默認值是1。
PageSize Integer 否 10

指定每頁顯示的記錄數(shù)。默認值是10。

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

返回數(shù)據(jù)

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

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

Data Array of DeviceGroup

調用成功時，返回分組信息。
DeviceGroup
GroupId String Z0ElGF5aqc0t****

分組ID。
GroupName String test11

分組名稱。
ErrorMessage String 系統(tǒng)異常

調用失敗時，返回的出錯信息。
Page Integer 1

當前頁碼。
PageCount Integer 1

總頁數(shù)。
PageSize Integer 10

每頁顯示的記錄數(shù)。
RequestId String 9599EE98-1642-4FCD-BFC4-039E458A4693

阿里云為該請求生成的唯一標識符。
Success Boolean true

是否調用成功。

  • true：調用成功。
  • false：調用失敗。
Total Integer 1

總記錄數(shù)。

示例

請求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupByTags
&Tag.1.TagKey=group
&Tag.1.TagValue=tag
&CurrentPage=1
&PageSize=10
&<公共請求參數(shù)>

正常返回示例

XML格式 

<QueryDeviceGroupByTagsResponse> 
    <PageCount>1</PageCount>  
    <Data> 
        <DeviceGroup> 
            <GroupName>test11</GroupName>  
            <GroupId>Z0ElGF5aqc0t****</GroupId> 
        </DeviceGroup> 
    </Data>  
    <Page>1</Page>  
    <PageSize>10</PageSize>  
    <RequestId>9599EE98-1642-4FCD-BFC4-039E458A4693</RequestId>  
    <Success>true</Success>  
    <Total>1</Total> 
</QueryDeviceGroupByTagsResponse>

JSON格式 

{
    "PageCount": 1, 
    "Data": {
        "DeviceGroup": [
            {
                "GroupName": "test11", 
                "GroupId": "Z0ElGF5aqc0t****"
            }
        ]
    }, 
    "Page": 1, 
    "PageSize": 10, 
    "RequestId": "9599EE98-1642-4FCD-BFC4-039E458A4693", 
    "Success": true, 
    "Total": 1
}