调用DescribeConsumerChannel接口查询DTS订阅任务的消费组信息,如消费组ID、名称和账号,消费延迟时间等。

调试

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

请求参数

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

系统规定参数,取值:DescribeConsumerChannel

RegionId String cn-hangzhou

DTS订阅实例所在地域的ID,请参见支持的地域列表

DtsInstanceId String dtsboss6pn1w******

订阅实例ID,可以调用DescribeDtsJobs查询。

说明 参数DtsInstanceIdDtsJobId,两者必须传入其一。
DtsJobId String boss6pn1w******

订阅任务ID,可以调用DescribeDtsJobs查询。

说明 参数DtsInstanceIdDtsJobId,两者必须传入其一。
PageSize Integer 20

每页记录数,取值范围为1~100,默认值为20

PageNumber Integer 1

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

返回数据

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

消费组列表。

ConsumerGroupId String dtsor2y66j4219****

消费组ID。

ConsumerGroupName String 订阅组A

消费组的名称。

ConsumerGroupUserName String dtstest

消费组的账号。

ConsumptionCheckpoint String 2021-06-20T12:00:00Z

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

MessageDelay Long 172714

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

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

未消费的消息总数,为未消费的订阅数据数量与心跳消息数量的和。

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

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

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

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

HttpStatusCode String 200

状态码。

PageNumber Integer 1

页码。

PageRecordCount Integer 20

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

RequestId String D66140B3-C747-42B6-8315-BAF6490E****

请求ID。

Success String true

请求是否成功。

TotalRecordCount Long 1

消费组总数。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeConsumerChannel
&RegionId=cn-hangzhou
&DtsInstanceId=dtsboss6pn1w******

正常返回示例

XML格式

<DescribeConsumerChannelResponse>
      <TotalRecordCount>1</TotalRecordCount>
      <PageRecordCount>20</PageRecordCount>
      <RequestId>D66140B3-C747-42B6-8315-BAF6490E****</RequestId>
      <PageNumber>1</PageNumber>
      <HttpStatusCode>200</HttpStatusCode>
      <ConsumerChannels>
            <ConsumptionCheckpoint></ConsumptionCheckpoint>
            <ConsumerGroupId>dtsor2y66j4219****</ConsumerGroupId>
            <ConsumerGroupUserName>dtstest</ConsumerGroupUserName>
            <ConsumerGroupName>订阅组A</ConsumerGroupName>
            <MessageDelay>-1</MessageDelay>
            <UnconsumedData>-1</UnconsumedData>
      </ConsumerChannels>
      <Success>true</Success>
</DescribeConsumerChannelResponse>

JSON格式

{
	"TotalRecordCount": 1,
	"PageRecordCount": 20,
	"RequestId": "D66140B3-C747-42B6-8315-BAF6490E****",
	"PageNumber": 1,
	"HttpStatusCode": 200,
	"ConsumerChannels": [
		{
			"ConsumptionCheckpoint": "",
			"ConsumerGroupId": "dtsor2y66j4219****",
			"ConsumerGroupUserName": "dtstest",
			"ConsumerGroupName": "订阅组A",
			"MessageDelay": -1,
			"UnconsumedData": -1
		}
	],
	"Success": true
}

错误码

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