调用 DescribeConsumedPartitions 接口查看消费组订阅的指定 Topic 的分区信息。
此接口用于查看消费组订阅的指定 Topic 中每个分区的基本信息,包括分区的编号、消费者、消费进度等。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeConsumedPartitions | 要执行的操作,取值:DescribeConsumedPartitions。 |
Version | String | 是 | 2022-05-01 | API的版本,取值:2022-05-01。 |
InstanceId | String | 是 | kafka-cnngbnntswg1**** | 实例 ID。 |
GroupId | String | 是 | my_group | 消费组 ID。 |
TopicName | String | 是 | my_topic | Topic 名称。 |
PageNumber | Integer | 是 | 1 | 列表的页码,最小值为 1。 |
PageSize | Integer | 是 | 1 | 列表中每一页的条目数量,取值范围为 1~100。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Total | Integer | 12 | 消费组消费对应 Topic 的分区总数。 |
ConsumedPartitionsInfo | Array of Object | -- | 指定 Topic 的分区列表。 |
POST /?Action=DescribeConsumedPartitions&Version=2022-05-01 HTTP/1.1 Content-Type: application/json Host: kafka.volcengineapi.com X-Date: 20210328T100802Z Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=******** { "InstanceId": "kafka-cnng1si21igu****", "PageNumber": 1, "PageSize": 20, "GroupId":"Group", "TopicName": "test" }
{ "ResponseMetadata": { "RequestId": "20230321113657C9E60632E1D4F61E5BC5", "Action": "DescribeConsumedPartitions", "Version": "2022-05-01", "Service": "Kafka", "Region": "cn-beijing" }, "Result": { "ConsumedPartitionsInfo": [ { "Accumulation": 14733811, "ConsumedClient": "consumer-1/192.168.xxx.xx", "ConsumedOffset": 5384592589, "EndOffset": 5399326400, "PartitionId": 0, "StartOffset": 5383336144 }, ...... { "Accumulation": 14840853, "ConsumedClient": "consumer-1/192.168.xxx.xx", "ConsumedOffset": 5384490996, "EndOffset": 5399331849, "PartitionId": 11, "StartOffset": 5383905142 } ], "Total": 12 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | InvalidParameter | 参数值无效。 |
403 | OperationDenied.AccountNotAuthorized | 您不具备相关权限 ,请授权或切换账号后重试。 |
403 | OperationDenied.InvalidInstanceStatus | 当前实例状态不允许执行该操作。 |
404 | InvalidInstanceId.NotFound | 实例不存在。 |
404 | InvalidGroupId.NotFound | Group 不存在。 |
404 | InvalidTopicName.NotFound | Topic 不存在。 |
500 | InternalError | 内部错误,请稍后重试。 |