文档中心

消息队列kafka API参考手册

最近更新时间：2023-04-16 17:00:00

2 消费组管理

2.1 ResizeTopic

调用 ResizeTopic 接口是以 topic 粒度重置消费位点。

2.1.1 使用说明

PUT https://{Endpoint}/cmqk/kafka/v1.0/clusters/consumerGroup/topic/reset

2.1.2 请求参数

说明：经过网关调用接口时不需要传入表 2-1。
表2-1 header 中请求参数

表2-2 body 中的请求参数

2.1.3 返回数据

2.1.4 示例

1. 请求示例
PUT https://{Endpoint}/cmqk/kafka/v1.0/clusters/consumerGroup/topic/reset
{
      "InstanceID": "cmq-kafka-185d9d8ccc5a4a12",
      "TopicName": "topic1",
      "GroupName": "gp1",
      "ResetType": 0
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "d2df5c73-96ba-4b8b-9905-37d710bea7d3",
    "NextOffset": 0
}

2.2 ResizePartition

调用 ResizePartition 接口是以 partition 粒度重置消费位点。

2.2.1 使用说明

PUT https://{Endpoint}/cmqk/kafka/v1.0/clusters/consumerGroup/topic/resetPartition

2.2.2 请求参数

说明：经过网关调用接口时不需要传入表 2-3。
表2-3 header 中请求参数

表2-4 body 中的请求参数

2.2.3 返回数据

2.2.4 示例

1. 请求示例
https://{Endpoint}/cmqk/kafka/v1.0/clusters/consumerGroup/topic/resetPartition
{
      "InstanceID": "cmq-kafka-185d9d8ccc5a4a12",
      "TopicName": "topic1",
      "GroupName": "gp1",
      "ResetType": 2,
      "PartitionID": 0,
      "GoResetOffset": 10
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "a6b32cc1-6cc0-4241-983f-c1e5fdf94e23",
      "NextOffset": 10
}

2.3 CreateConsumerGroup

调用 CreateConsumerGroup 接口创建消费组。

2.3.1 使用说明

POST https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/create

2.3.2 请求参数

说明：经过网关调用接口时不需要传入表表 2-5。
表2-5 header 中请求参数

表2-6 body 中的请求参数

2.3.3 返回数据

2.3.4 示例

1. 请求示例
POST https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/create
{
      "InstanceId": "cmq-kafka-861bda97563341a9",
      "Name": "test-1010-1",
      "Remark": "test-1010-1"
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "5746df52-814a-4f73-bed8-a25a9a980158",
      "GroupID": "VhyEFuXwVx",
      "ClusterID": "VgWPfOl8RL",
      "GroupName": "test-1010-1",
      "Remark": "test-1010-1",
      "CreateTime": 1665382784,
      "UpdateTime": 0
}

2.4 DeleteConsumerGroup

调用 DeleteConsumerGroup 接口删除消费组。

2.4.1 使用说明

DELETE https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/delete

2.4.2 请求参数

说明：经过网关调用接口时不需要传入表 2-7。
表2-7 header 中请求参数

表2-8 body 中的请求参数

2.4.3 返回数据

2.4.4 示例

1. 请求示例
DELETE https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/delete
{
      "InstanceId": "cmq-kafka-861bda97563341a9",
     "GroupName": "test-1010-1"
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "44eb0963-b380-4529-b21e-4f4719a83296"
}

2.5 GetConsumerGroupList

调用 GetConsumerGroupList 接口获取消费组列表。

2.5.1 使用说明

GET https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/list

2.5.2 请求参数

说明：经过网关调用接口时不需要传入表 2-9。
表2-9 header 中请求参数

表2-10 写入 URL 中的请求参数

2.5.3 返回数据

表2-11 Topics 中的结构

2.5.4 示例

1. 请求示例
GET
https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/list?InstanceId=cmq-kafka-861bda97563341a9&PageNum=1&PageSize=10
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "05972bad-168f-47f5-a418-0718e89c2d3d",
      "TotalCount": 1,
      "PageSize": 10,
      "PageNumber": 1,
      "ConsumerGroups": [
      {
          "GroupID": "VgWbXqBJR9",
          "ClusterID": "VgWPfOl8RL",
          "GroupName": "gp1",
          "Remark": "",
        "CreateTime": 1665194658000,
          "UpdateTime": 0
      }
      ]
}

2.6 GetTopicToGroupDetail

调用 GetTopicToGroupDetail 接口获取 topic 和消费组订阅详细信息。

2.6.1 使用说明

GET https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/getTopicDetail

2.6.2 请求参数

说明：经过网关调用接口时不需要传入表 2-12。
表2-12 header 中请求参数

表2-13 URL 中的请求参数

2.6.3 返回数据

表2-14 TopicGroupDetails 中的结构

2.6.4 示例

1. 请求示例
GET
https://{Endpoint}/cmqk/kafka/v1.0/cluster/consumerGroup/getTopicDetail?InstanceId=cmq-kafka
-861bda97563341a9&TopicId=VgWbM2ycMx&GroupName=gp1
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "6b51a533-2cc1-4f4c-b139-a93cfe368e3e",
      "TopicGroupDetails": [
      {
          "PartitionId": 0,
          "Client": "",
          "MaxOffset": 306,
          "CurrentOffset": 306,
          "LagConsumeCount": 0
      },
      {
          "PartitionId": 1,
          "Client": "",
          "MaxOffset": 316,
          "CurrentOffset": 316,
          "LagConsumeCount": 0
      },
      {
          "PartitionId": 2,
          "Client": "",
          "MaxOffset": 324,
          "CurrentOffset": 324,
          "LagConsumeCount": 0
      },
      {
          "PartitionId": 3,
          "Client": "",
          "MaxOffset": 309,
          "CurrentOffset": 309,
          "LagConsumeCount": 0
      }
      ]
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服