调用GetConsumerProgress查询消费组消费状态_消息队列Kafka版-阿里云帮助中心

查询Consumer Group的消费状态。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
alikafka:ListGroup	Read	全部资源	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例ID。	alikafka_pre-cn-mp919o4v****
ConsumerId	string	是	Group的名称。	kafka-test
RegionId	string	是	实例的地域ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
Code	integer	状态码。返回200代表成功。	200
Message	string	返回信息。	operation success.
RequestId	string	请求ID。	252820E1-A2E6-45F2-B4C9-1056B8CE****
Success	boolean	调用是否成功。	true
ConsumerProgress	object	消费状态。
LastTimestamp	long	此Group最后被消费的消息的产生时间。	1566874931671
TotalDiff	long	所有Topic的未消费消息总量，即堆积量。	0
TopicList	object []	此Group对应的每个Topic的消费进度列表。
TotalDiff	long	该Topic的未消费消息总量，即堆积量。	0
LastTimestamp	long	该Topic最后被消费的消息的产生时间。	1566874931649
Topic	string	Topic名称。	kafka-test
OffsetList	object []	偏移列表。
Partition	integer	分区ID。	0
BrokerOffset	long	最大位点。	9
ConsumerOffset	long	消费位点。	9
LastTimestamp	long	该分区最后被消费的消息的产生时间。	1566874931649

示例

正常返回示例

JSON格式

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

错误码

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