QueryDeviceGroupByTags - IoT Platform

QPS限制

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

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

調試

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

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	QueryDeviceGroupByTags	系統規定參數。取值：QueryDeviceGroupByTags。
Tag.N.TagKey	String	是	group	分組標籤鍵（key）。
Tag.N.TagValue	String	是	tag	分組標籤值（value）。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面，查看當前執行個體的ID。重要若有ID值，必須傳入該ID值，否則調用會失敗。若無執行個體概覽頁面或ID值，則無需傳入。執行個體的更多資訊，請參見執行個體概述。
CurrentPage	Integer	否	1	指定顯示查詢結果的第幾頁。預設值是1。
PageSize	Integer	否	10	指定每頁顯示的記錄數。預設值是10。

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

返回資料

名稱	類型	樣本值	描述
Code	String	iot.system.SystemException	調用失敗時，返回的錯誤碼。更多資訊，請參見錯誤碼。
Data	Array of DeviceGroup		調用成功時，返回分組資訊。
DeviceGroup
GroupId	String	Z0ElGF5aqc0t****	分組ID。
GroupName	String	test11	分組名稱。
ErrorMessage	String	系統異常	調用失敗時，返回的出錯資訊。
Page	Integer	1	當前頁碼。
PageCount	Integer	1	總頁數。
PageSize	Integer	10	每頁顯示的記錄數。
RequestId	String	9599EE98-1642-4FCD-BFC4-039E458A4693	阿里雲為該請求產生的唯一識別碼。
Success	Boolean	true	是否調用成功。 true：調用成功。 false：調用失敗。
Total	Integer	1	總記錄數。

樣本

請求樣本

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

正常返回樣本

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
}

錯誤碼

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