调用该接口查询项目下的分组列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QuerySolutionDeviceGroupPage |
系统规定参数。取值:QuerySolutionDeviceGroupPage。 |
PageId | Integer | 是 | 1 |
当前页,从1开始,最大10000。 |
PageSize | Integer | 是 | 20 |
指定每页返回数据的最大条数,取值范围:1~50,默认值为20。 |
ProjectCode | String | 是 | 4de2c367****8c585e5992** |
项目ID,是项目的唯一标识,您可以通过项目管理控制台获取项目ID。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。 必须传入实例ID,否则调用会失败。您可在物联网平台控制台的实例概览页面,查看您的实例ID。 注意
如果公共实例没有ID,请参见如何获取实例ID。 |
FuzzyGroupName | String | 否 | test |
模糊查询分组的名称。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.tcloud.ProjectNotFound |
调用失败时,返回的错误码。更多信息,请参见错误码。 |
Data | Struct |
返回的分组列表。 |
|
List | Array of itemName |
分组列表数据。 |
|
itemName | |||
DeviceCount | Long | 100 |
分组下设备的数量。 |
GmtCreate | Long | 1356565656 |
分组的创建时间。 |
GmtModified | Long | 1357865658 |
分组最近一次修改的时间。 |
GroupDesc | String | description |
分组描述。 |
GroupId | String | 4de2c367****8c585e5992** |
分组的ID。 |
GroupName | String | test*** |
分组名称。 |
PageId | Integer | 1 |
当前页,从1开始。 |
PageSize | Integer | 20 |
每页返回的分组个数。 |
Total | Integer | 100 |
查询返回的数据总条数。 |
ErrorMessage | String | project not found |
调用失败时,返回的错误信息。 |
RequestId | String | 66FF51D3-***-49F1-B1A2-*** |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QuerySolutionDeviceGroupPage
&PageId=1
&PageSize=20
&ProjectCode=4de2c367****8c585e5992**
&<公共请求参数>
正常返回示例
XML
格式
<QuerySolutionDeviceGroupPageResponse>
<RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
<Data>
<PageId>1</PageId>
<PageSize>20</PageSize>
<Total>100</Total>
<List>
<itemName>
<GroupName>test***</GroupName>
<GmtCreate>1356565656</GmtCreate>
<GroupDesc>description</GroupDesc>
<GmtModified>1357865658</GmtModified>
<DeviceCount>100</DeviceCount>
<GroupId>4de2c367****8c585e5992** </GroupId>
</itemName>
</List>
</Data>
<Success>true</Success>
</QuerySolutionDeviceGroupPageResponse>
JSON
格式
{
"RequestId": "66FF51D3-***-49F1-B1A2-***",
"Data": {
"PageId": 1,
"PageSize": 20,
"Total": 100,
"List": {
"itemName": {
"GroupName": "test***",
"GmtCreate": 1356565656,
"GroupDesc": "description",
"GmtModified": 1357865658,
"DeviceCount": 100,
"GroupId": "4de2c367****8c585e5992**"
}
}
},
"Success": true
}