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

  • 本接口仅适用于新版订阅通道。
    说明 在调用ConfigureSubscriptionInstance接口时,需要传入SubscriptionInstanceNetworkType参数,如果不传入该参数则订阅通道被定义为旧版。
  • 只有订阅通道配置完成后,才能调用本接口。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeConsumerGroup 要执行的操作,取值:DescribeConsumerGroup
SubscriptionInstanceId String dtsxxxxxxxx 订阅实例ID。
pageSize Integer 30 每页显示的消费组数量,默认值为30
pageNum Integer 1

页码。

大于0,且不超过Integer的最大值,默认值为1

返回参数

名称 类型 示例值 描述
RequestId String 36923CC2-DDAB-4B48-A144-DA92C1E19537 请求ID。
DescribeConsumerChannel List 不涉及 消费组列表。
 └ConsumerGroupID String dtsxxxxxxxx 消费组ID。
 └ConsumerGroupName String 测试消费组 消费组名称。
 └ConsumptionCheckpoint String 2019-06-02T06:33:07Z 订阅通道的下游消费时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
 └UnconsumedData Long 500 堆积的记录数。
 └MessageDelay Long 15 消息延迟时间,单位为秒。
 └ConsumerGroupUserName String dtstest 当前消费组的账号。
PageRecordCount Integer 1 本页消费组数量。
PageNumber Integer 1 页码。
TotalRecordCount Integer 1 消费组总数。

示例

    public DescribeConsumerGroupResponse describeConsumerGroup(String instanceId) throws Exception {
        DescribeConsumerGroupRequest request = new DescribeConsumerGroupRequest();
        request.setSubscriptionInstanceId(instanceId);

        DescribeConsumerGroupResponse response = client.getAcsResponse(request);
        System.out.println(response.getConsumerChannels().size());
        return response;
    }

错误码

错误码 错误信息 描述
InvalidParameter The Input Parameter${parameter} is not valid. 输入的参数不合法,请检查输入的参数是否正确。
InvalidParameterValid The Value of Input Parameter${parameter} is not valid. 参数值校验不通过,请检查是否缺失所提示的参数以及用户AK是否正确。
MissingParameter The parameter "<parameter name>" is needed but no provided. 缺少参数,请检查是否缺失所提示的参数以及用户AK是否正确,具体请参照DTS OpenAPI文档。
Forbidden.ConsumerGroupNotFound ConsumerGroupis not found. 消费组不存在。