Call this operation to query the details of a group.
Request parameters
Parameter | Type | Required | Description |
---|---|---|---|
Action | String | Yes | The action that you want to perform. Set the value to QueryDeviceGroupInfo. |
GroupId | String | Yes | Group ID. It is the unique identifier of the group. |
Common request parameters | - | Yes | see Common parameters. |
Response parameters
Parameter | Type | Description |
---|---|---|
RequestId | String | The globally unique ID generated by Alibaba Cloud for the request. |
Success | Boolean | Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed. |
ErrorMessage | String | The error message returned when the call fails. |
Code | String | For error codes, see Error codes. |
Data | Data | The group details returned when the call is successful. See the following table GroupInfo. |
Parameter | Type | Description |
---|---|---|
GroupName | String | The name of the group. |
UtcCreate | String | The time when the group was created. |
DeviceOnline | Integer | The number of online devices in the group. |
DeviceActive | Integer | The number of activated devices in the group. |
DeviceCount | Integer | The total number of devices in the group. |
GroupId | String | The ID of the group. |
GroupDesc | String | The description of the group. |
Examples
Request example
http://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHskDse
&Common request parameters
Response example
{
"Data":{
"DeviceOnline":0,
"DeviceActive":1,
"GroupName":"yanglv",
"DeviceCount":10,
"UtcCreate":"2018-09-14T14:35:51.000Z",
"GroupId":"tDQvBJqbUyHskDse"
},
"RequestId":"7411716B-A488-4EEB-9AA0-6DB05AD2491F",
"Success":true
}