调用DescribeConsumerGroup接口查询数据订阅实例中的消费组详情。

调试

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

请求参数

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

系统规定参数,取值:DescribeConsumerGroup

SubscriptionInstanceId String dtso5xx5t9u19e****

数据订阅实例ID,可以通过调用DescribeSubscriptionInstances接口查询。

RegionId String cn-hangzhou

数据订阅实例所在地域的ID,详情请参见支持的地域列表

PageSize Integer 30

每页记录数,取值: 3050100,默认值为30

PageNum Integer 1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

AccountId String 12323344****

阿里云主账号ID,无需设置,该参数即将下线。

返回数据

名称 类型 示例值 描述
ConsumerChannels Array of DescribeConsumerChannel

消费组列表。

DescribeConsumerChannel
ConsumerGroupID String dtspis1110z232****

消费组ID。

ConsumerGroupName String consumergrouptest

消费组名称。

ConsumerGroupUserName String test

消费组账号。

ConsumptionCheckpoint String 2019-10-02T12:00:00Z

消费位点,即客户端在订阅通道内消费最后一条信息的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

MessageDelay Long 172714

消息延迟时间=当前时间-数据订阅通道中存在时间最早的未被消费的消息的时间戳,单位为秒。

说明 如果该参数返回 -1,则表示当前没有客户端连接该消费组。
UnconsumedData Long 186600

未消费的消息总数=未被消费的订阅数据数量+心跳消息数量

说明 如果该参数返回 -1,则表示当前没有客户端连接该消费组。
ErrCode String InternalError

调用出错时返回的错误码。

ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。

PageNumber Integer 1

页码。

PageRecordCount Integer 30

一页最多可展示的消费组数量。

RequestId String 4204E899-8193-4D7D-A4FB-3A7F9063****

请求ID。

Success String true

请求是否成功。

TotalRecordCount Integer 1

消费组总数。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeConsumerGroup
&SubscriptionInstanceId=dtso5xx5t9u19e****
&<公共请求参数>

正常返回示例

XML格式

<DescribeConsumerGroupResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>30</PageRecordCount>
      <RequestId>4204E899-8193-4D7D-A4FB-3A7F9063****</RequestId>
      <PageNumber>1</PageNumber>
      <ConsumerChannels>
            <DescribeConsumerChannel>
                  <ConsumptionCheckpoint></ConsumptionCheckpoint>
                  <ConsumerGroupID>dtspis1110z232gbm4</ConsumerGroupID>
                  <ConsumerGroupUserName>test</ConsumerGroupUserName>
                  <ConsumerGroupName>consumergrouptest</ConsumerGroupName>
                  <MessageDelay>-1</MessageDelay>
                  <UnconsumedData>-1</UnconsumedData>
            </DescribeConsumerChannel>
      </ConsumerChannels>
      <Success>true</Success>
</DescribeConsumerGroupResponse>

JSON格式

{
	"TotalRecordCount": 1,
	"PageRecordCount": 30,
	"RequestId": "4204E899-8193-4D7D-A4FB-3A7F9063****",
	"PageNumber": 1,
	"ConsumerChannels": {
		"DescribeConsumerChannel": [
			{
				"ConsumptionCheckpoint": "2019-10-02T12:00:00Z",
				"ConsumerGroupID": "dtspis1110z232gbm4",
				"ConsumerGroupUserName": "test",
				"ConsumerGroupName": "consumergrouptest",
				"MessageDelay": -1,
				"UnconsumedData": -1
			}
		]
	},
	"Success": true
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 系统错误

访问错误中心查看更多错误码。