文档

GetConsumerProgress - 查询消费组消费状态

更新时间:

查询Consumer Group的消费状态。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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
TopicListobject []

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

TotalDifflong

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

0
LastTimestamplong

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

1566874931649
Topicstring

Topic 名称。

kafka-test
OffsetListobject []

偏移列表。

Partitioninteger

分区 ID。

0
BrokerOffsetlong

最大位点。

9
ConsumerOffsetlong

消费位点。

9
LastTimestamplong

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

1566874931649
RebalanceInfoListobject []

该 Group 的 Rebalance 详情

Generationlong

Rebalance 次数。

100
LastRebalanceTimestamplong

本轮 Rebalance 发生的时间。单位 s。

1709199270
Reasonstring

发生 Rebalance 的原因。

removing member consumer-1-cd14eb9c-379b-4b8e-9bbd-76f147f8536f on LeaveGroup
GroupIdstring

订阅方的 Group ID。

falcon-uat
RebalanceTimeConsuminglong

本轮 Rebalance 的持续时间。单位 ms 。

1
RebalanceSuccessboolean

本轮 Rebalance 是否有新成员加入消费组。

true

示例

正常返回示例

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
              }
            ]
          }
        }
      ]
    },
    "RebalanceInfoList": {
      "RebalanceInfoList": [
        {
          "Generation": 100,
          "LastRebalanceTimestamp": 1709199270,
          "Reason": "removing member consumer-1-cd14eb9c-379b-4b8e-9bbd-76f147f8536f on LeaveGroup",
          "GroupId": "falcon-uat",
          "RebalanceTimeConsuming": 1,
          "RebalanceSuccess": true
        }
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Sls.Query.ErrorData query failed. Please try again later.数据查询失败,请稍后重试。
400AgentErrorA system exception occurred. Please submit a ticket.内部错误,请提交工单。
400AgentBusinessErrorInternal error, please try again, if invalid, please submit the work order.内部错误,请重试,若无效请提交工单。
400InvalidParameterThe %s parameter is invalid.参数%s校验不通过
404InstanceAgent.NotFoundInstance does not exist. Please check the entry and try again.Instance 不存在,请核实入参后重试。
404InvalidParameter.DataNotFoundNo data found for the %s parameter.参数%s查找不到数据

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

变更历史

变更时间变更内容概要操作
2024-04-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
    新增错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)