文档首页/ 分布式消息服务Kafka版/ API参考/ API V2(推荐)/ 消费组管理/ 删除消费组在指定Topic的消费位点
更新时间:2025-06-19 GMT+08:00

删除消费组在指定Topic的消费位点

功能介绍

删除消费组在指定Topic的消费位点。

调用方法

请参见如何调用API

URI

POST /v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/delete-offset

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见获取项目ID

instance_id

String

实例ID。

group

String

消费组ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topics

Array of strings

Topic列表

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

topics

Array of DeleteConsumerGroupOffsetsResponseEntity objects

结果列表

表4 DeleteConsumerGroupOffsetsResponseEntity

参数

参数类型

描述

name

String

Topic名称

success

Boolean

消费位点删除是否成功

error_code

String

错误码

请求示例

/v2/kafka/{project_id}/instances/{instance_id}/groups/{group}/delete-offset

{
  "topics" : [ "topic-1", "topic-2" ]
}

响应示例

状态码:200

删除成功。

{
  "topics" : [ {
    "name" : "topic-1",
    "success" : true
  }, {
    "name" : "topic-2",
    "success" : true
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class DeleteConsumerGroupOffsetsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        DeleteConsumerGroupOffsetsRequest request = new DeleteConsumerGroupOffsetsRequest();
        request.withInstanceId("{instance_id}");
        request.withGroup("{group}");
        DeleteConsumerGroupOffsetsRequestBody body = new DeleteConsumerGroupOffsetsRequestBody();
        List<String> listbodyTopics = new ArrayList<>();
        listbodyTopics.add("topic-1");
        listbodyTopics.add("topic-2");
        body.withTopics(listbodyTopics);
        request.withBody(body);
        try {
            DeleteConsumerGroupOffsetsResponse response = client.deleteConsumerGroupOffsets(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DeleteConsumerGroupOffsetsRequest()
        request.instance_id = "{instance_id}"
        request.group = "{group}"
        listTopicsbody = [
            "topic-1",
            "topic-2"
        ]
        request.body = DeleteConsumerGroupOffsetsRequestBody(
            topics=listTopicsbody
        )
        response = client.delete_consumer_group_offsets(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeleteConsumerGroupOffsetsRequest{}
	request.InstanceId = "{instance_id}"
	request.Group = "{group}"
	var listTopicsbody = []string{
        "topic-1",
	    "topic-2",
    }
	request.Body = &model.DeleteConsumerGroupOffsetsRequestBody{
		Topics: &listTopicsbody,
	}
	response, err := client.DeleteConsumerGroupOffsets(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

删除成功。

错误码

请参见错误码