GetConsumerProgress - 查询消费组消费状态

查询Consumer Group的消费状态。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

alikafka_pre-cn-mp919o4v****
ConsumerIdstring

Group的名称。

kafka-test
RegionIdstring

实例的地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object
Codeinteger

状态码。返回200代表成功。

200
Messagestring

返回信息。

operation success.
RequestIdstring

请求ID。

252820E1-A2E6-45F2-B4C9-1056B8CE****
Successboolean

调用是否成功。

true
ConsumerProgressobject

消费状态。

LastTimestampLong

此Group最后被消费的消息的产生时间。

1566874931671
TotalDiffLong

所有Topic的未消费消息总量,即堆积量。

0
TopicListarray

此Group对应的每个Topic的消费进度列表。

object
TotalDiffLong

该Topic的未消费消息总量,即堆积量。

0
LastTimestampLong

该Topic最后被消费的消息的产生时间。

1566874931649
Topicstring

Topic名称。

kafka-test
OffsetListarray

偏移列表。

object
Partitioninteger

分区ID。

0
BrokerOffsetLong

最大位点。

9
ConsumerOffsetLong

消费位点。

9
LastTimestampLong

该分区最后被消费的消息的产生时间。

1566874931649

示例

请求示例

http(s)://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetConsumerProgress
&RegionId=cn-hangzhou
&ConsumerId=kafka-test
&InstanceId=alikafka_pre-cn-mp919o4v****
&<公共请求参数>

正常返回示例

JSON格式

{
    "RequestId": "252820E1-A2E6-45F2-B4C9-1056B8CE****",
    "Message": "operation success.",
    "ConsumerProgress": {
        "LastTimestamp": 1566874931671,
        "TopicList": {
            "TopicList": [
				{
					"OffsetList": {
						"OffsetList": [
							{
								"Partition": 0,
								"ConsumerOffset": 9,
								"LastTimestamp": 1566874931671,
								"BrokerOffset": 9
							}
						]
					},
					"LastTimestamp": 1566874931671,
					"TotalDiff": 0,
					"Topic": "kafka_test"
				}
            ]
        },
        "TotalDiff": 0
    },
    "Code": 200,
    "Success": true
}	

XML格式

<GetConsumerProgressResponse>
    <RequestId>252820E1-A2E6-45F2-B4C9-1056B8CE****</RequestId>
    <Message>operation success.</Message>
    <ConsumerProgress>
        <LastTimestamp>1566874931671</LastTimestamp>
        <TopicList>
            <TopicList>
                <OffsetList>
                    <OffsetList>
                        <Partition>0</Partition>
                        <ConsumerOffset>9</ConsumerOffset>
                        <LastTimestamp>1566874931671</LastTimestamp>
                        <BrokerOffset>9</BrokerOffset>
                    </OffsetList>
                </OffsetList>
                <LastTimestamp>1566874931671</LastTimestamp>
                <TotalDiff>0</TotalDiff>
                <Topic>kafka_test</Topic>
            </TopicList>
        </TopicList>
        <TotalDiff>0</TotalDiff>
    </ConsumerProgress>
    <Code>200</Code>
    <Success>true</Success>
</GetConsumerProgressResponse>

错误码

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

阿里云首页 消息队列Kafka版 相关技术圈