調用該介面分頁查詢分組列表。
QPS限制
單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為100。
說明 RAM使用者共用阿里雲帳號配額。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| Action | String | 是 | QueryDeviceGroupList | 系統規定參數。取值:QueryDeviceGroupList。 |
| IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** | 執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID。 重要
執行個體的更多資訊,請參見執行個體概述。 |
| PageSize | Integer | 否 | 10 | 每頁記錄數。最大值是200。預設值是10。 |
| SuperGroupId | String | 否 | 8vDubXr4nUvZkNgk9mle010200 | 父組ID。查詢某父組下的子分組列表時,需傳入此參數。 |
| GroupName | String | 否 | GroupName1 | 分組名稱。
|
| CurrentPage | Integer | 否 | 1 | 指定從返回結果中的第幾頁開始顯示。預設值為1。 |
| GroupTypes.N | RepeatList | 否 | LINK_PLATFORM_DYNAMIC | 待查詢的分組類型。 目前僅支援傳入一個,且為LINK_PLATFORM_DYNAMIC,表示動態分組。不傳入時,預設為靜態分組。 |
調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔。
返回資料
| 名稱 | 類型 | 樣本值 | 描述 |
| Code | String | iot.system.SystemException | 調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼。 |
| CurrentPage | Integer | 1 | 當前頁號。 |
| Data | Array of GroupInfo | 調用成功時,返回的分組資訊。請參見GroupInfo。 說明 返回的分組資訊按照分組建立時間倒序排列。 |
|
| GroupInfo | |||
| GroupDesc | String | usefulGroup | 分組描述。 |
| GroupId | String | Kzt9FD8wje8o**** | 分組ID。 |
| GroupName | String | test1 | 分組名稱。 |
| GroupType | String | LINK_PLATFORM_DYNAMIC | 分組類型。 |
| UtcCreate | String | 2018-10-09T02:58:34.000Z | 分組建立時間。 |
| ErrorMessage | String | 系統異常 | 調用失敗時,返回的出錯資訊。 |
| PageCount | Integer | 3 | 總頁數。 |
| PageSize | Integer | 10 | 每頁記錄數。 |
| RequestId | String | BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D | 阿里雲為該請求產生的唯一識別碼。 |
| Success | Boolean | true | 表示是否調用成功。
|
| Total | Integer | 24 | 總記錄數。 |
樣本
請求樣本
https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupList
&PageSize=10
&CurrentPage=1
&GroupTypes.1=LINK_PLATFORM_DYNAMIC
&<公用請求參數>
正常返回樣本
XML格式
<QueryDeviceGroupListResponse>
<PageCount>3</PageCount>
<Data>
<GroupInfo>
<GroupName>test1</GroupName>
<UtcCreate>2021-10-01T02:58:34.000Z</UtcCreate>
<GroupId>Kzt9FD8wje8o***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>test2</GroupName>
<UtcCreate>2021-10-01T02:56:40.000Z</UtcCreate>
<GroupId>0ayrSQ3DSd7***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupDesc>Test</GroupDesc>
<GroupName>test3</GroupName>
<UtcCreate>2021-10-01T05:38:27.000Z</UtcCreate>
<GroupId>oWXlIQeFZtzC***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>ylv0915</GroupName>
<UtcCreate>2021-10-01T04:51:56.000Z</UtcCreate>
<GroupId>SfEiVapLPUjB***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>ydlv</GroupName>
<UtcCreate>2021-10-01T14:35:51.000Z</UtcCreate>
<GroupId>z2S2h9NsDTZm***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>ldh_group_3</GroupName>
<UtcCreate>2021-10-01T12:26:20.000Z</UtcCreate>
<GroupId>chn5fkjin***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupDesc>ddd</GroupDesc>
<GroupName>ylvgisbim</GroupName>
<UtcCreate>2021-10-01T11:41:20.000Z</UtcCreate>
<GroupId>ncUZ8DjWYaB9***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>abc</GroupName>
<UtcCreate>2021-10-01T09:14:30.000Z</UtcCreate>
<GroupId>zpdvwxzBdt4F***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>test11</GroupName>
<UtcCreate>2021-10-01T07:22:39.000Z</UtcCreate>
<GroupId>BTaudF16X2xK***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
<GroupInfo>
<GroupName>testy</GroupName>
<UtcCreate>2021-10-01T01:58:06.000Z</UtcCreate>
<GroupId>PrTm3VOeggPw***</GroupId>
<GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
</GroupInfo>
</Data>
<PageSize>10</PageSize>
<RequestId>BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D</RequestId>
<CurrentPage>1</CurrentPage>
<Success>true</Success>
<Total>24</Total>
</QueryDeviceGroupListResponse>
JSON格式
{
"PageCount":3,
"Data":{
"GroupInfo":[
{
"GroupName":"test1",
"UtcCreate":"2021-10-01T02:58:34.000Z",
"GroupId":"Kzt9FD8wje8o***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"test2",
"UtcCreate":"2021-10-01T02:56:40.000Z",
"GroupId":"0ayrSQ3DSd7***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupDesc":"Test",
"GroupName":"test3",
"UtcCreate":"2021-10-01T05:38:27.000Z",
"GroupId":"oWXlIQeFZtzC***",
"GroupType":"LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"ylv0915",
"UtcCreate":"2021-10-01T04:51:56.000Z",
"GroupId":"SfEiVapLPUjB***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"ydlv",
"UtcCreate":"2021-10-01T14:35:51.000Z",
"GroupId":"z2S2h9NsDTZm***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"ldh_group_3",
"UtcCreate":"2021-10-01T12:26:20.000Z",
"GroupId":"chn5fkjin***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupDesc":"ddd",
"GroupName":"ylvgisbim",
"UtcCreate":"2021-10-01T11:41:20.000Z",
"GroupId":"ncUZ8DjWYaB9***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"abc",
"UtcCreate":"2021-10-01T09:14:30.000Z",
"GroupId":"zpdvwxzBdt4F***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"test11",
"UtcCreate":"2021-10-01T07:22:39.000Z",
"GroupId":"BTaudF16X2xK***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
},
{
"GroupName":"testy",
"UtcCreate":"2021-10-01T01:58:06.000Z",
"GroupId":"PrTm3VOeggPw***",
"GroupType": "LINK_PLATFORM_DYNAMIC"
}
]
},
"PageSize":10,
"RequestId":"BEFCA316-D6C7-470C-81ED-1FF4FFD4AA0D",
"CurrentPage":1,
"Success":true,
"Total":24
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。