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

限制说明

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为30。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值:QueryDeviceGroupInfo。

GroupId String tDQvBJqbUyHs****

分组ID,分组的全局唯一标识符。

您可调用QueryDeviceGroupList接口查询分组ID(GroupId)。

IotInstanceId String iot-cn-0pp1n8t****

实例ID。

您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。

说明 如果公共实例没有ID值,请参见如何获取实例ID
GroupType String LINK_PLATFORM_DYNAMIC

分组类型。

目前仅支持传入LINK_PLATFORM_DYNAMIC,表示动态分组。不传入时,默认为静态分组。

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

返回数据

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

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

Data Struct

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

DeviceActive Integer 1

激活设备数量。

DeviceCount Integer 10

设备总数。

DeviceOnline Integer 0

在线设备数量。

DynamicGroupExpression String product_key = "a1***" and name LIKE "test%"

动态分组规则,仅动态分组返回该参数信息。

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>
<RequestId>7411716B-A488-4EEB-9AA0-6DB05AD2491F</RequestId>
<Data>
    <GroupName>aliyun</GroupName>
    <UtcCreate>2021-10-14T14:35:51.000Z</UtcCreate>
    <DeviceOnline>0</DeviceOnline>
    <GroupDesc>usefulGroup</GroupDesc>
    <DeviceActive>1</DeviceActive>
    <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
    <DeviceCount>10</DeviceCount>
    <GroupId>tDQvBJqbUyHs****</GroupId>
</Data>
<Success>true</Success>
<QueryDeviceGroupInfoResponse>

JSON格式

{
    "RequestId": "7411716B-A488-4EEB-9AA0-6DB05AD2491F",
    "Data": {
        "GroupName": "aliyun",
        "UtcCreate": "2021-10-14T14:35:51.000Z",
        "DeviceOnline": 0,
        "GroupDesc": "usefulGroup",
        "DeviceActive": 1,
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "DeviceCount": 10,
        "GroupId": "tDQvBJqbUyHs****"
    },
    "Success": true
}