调用该接口查询分组详情。

限制说明

  • 如果在企业版实例中调用该接口，请求参数IotInstanceId必须填写。否则，调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数（QPS）最大限制为30。
    说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 QueryDeviceGroupInfo

系统规定参数。取值：QueryDeviceGroupInfo。
GroupId String 是 tDQvBJqbUyHs****

分组ID，分组的全局唯一标识符。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。

  • 企业版实例：必须传入此参数。您可在物联网平台控制台的实例概览页面，查看您的企业版实例ID。
  • 公共实例：无需传入此参数。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

Data Struct

调用成功时，返回的分组详细信息数据，包含以下参数。
DeviceActive Integer 1

激活设备数量。
DeviceCount Integer 10

设备总数。
DeviceOnline Integer 0

在线设备数量。
GroupDesc String usefulGroup

分组描述。
GroupId String tDQvBJqbUyHs****

分组ID。
GroupName String aliyun

分组名称。
UtcCreate String 2018-09-14T14:35:51.000Z

创建时间。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String 7411716B-A488-4EEB-9AA0-6DB05AD2491F

阿里云为该请求生成的唯一标识符。
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=QueryDeviceGroupInfo
&GroupId=tDQvBJqbUyHs****
&<公共请求参数>

正常返回示例

XML格式 

<QueryDeviceGroupInfoResponse>
      <Data>
            <DeviceOnline>0</DeviceOnline>
            <DeviceActive>1</DeviceActive>
            <GroupName>aliyun</GroupName>
            <DeviceCount>10</DeviceCount>
            <UtcCreate>2018-09-14T14:35:51.000Z</UtcCreate>
            <GroupId>tDQvBJqbUyHs****</GroupId>
      </Data>
      <RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
      <Success>true</Success>
</QueryDeviceGroupInfoResponse>

JSON格式 

{
    "Data":{
        "DeviceOnline":0,
        "DeviceActive":1,
        "GroupName":"aliyun",
        "DeviceCount":10,
        "UtcCreate":"2018-09-14T14:35:51.000Z",
        "GroupId":"tDQvBJqbUyHs****"
    },
    "RequestId":"7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Success":true
}