调用该接口查询AMQP服务端订阅的消费组详情。

使用说明

使用AMQP服务端订阅时，可以调用该接口根据消费组ID查询消费组详情。创建AMQP服务端订阅的接口信息，请参见CreateSubscribeRelation。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：QueryConsumerGroupByGroupId。
GroupId String 是 nJRaJPn5U1JITGf******

消费组ID。调用CreateConsumerGroup创建消费组成功后，会返回消费组ID。您可以调用QueryConsumerGroupList按消费组名称查询消费组ID。
IotInstanceId String 否 iot-cn-0pp1n8t****

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

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

返回数据

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

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

调用成功时，返回的消费组详情。
CreateTime String 2020-05-20T00:05:20.000Z

消费组创建时间。为UTC时间，以毫秒计，格式为“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。
GroupId String nJRaJPn5U1JITGf******

消费组ID。
GroupName String 消费组1

消费组名称。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String 73B9DF43-7780-47DE-8BED-077729D28BD2

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

是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式

<QueryConsumerGroupByGroupIdResponse>
    <Data>
        <GroupId>nJRaJPn5U1JITGf******</GroupId>
        <GroupName>消费组1</GroupName>
        <CreateTime>2019-11-12T11:19:13.000Z</CreateTime>
    </Data>
    <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
    <Success>true</Success>
</QueryConsumerGroupByGroupIdResponse>

JSON格式

{
  "Data": {
        "GroupId": "nJRaJPn5U1JITGf******",
        "GroupName": "消费组1",
        "CreateTime": "2019-11-12T11:19:13.000Z"
    },
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}