更新时间:2024-03-29 GMT+08:00

重置消费进度

功能介绍

重置消费进度。

调用方法

请参见如何调用API

URI

POST /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset

表1 路径参数

参数

是否必选

参数类型

描述

engine

String

引擎类型:reliability。

缺省值:reliability

project_id

String

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

instance_id

String

实例ID。

group_id

String

消费组名称。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

topic

String

重置的主题。

timestamp

String

重置的时间。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

queues

Array of queues objects

重置的队列。

表4 queues

参数

参数类型

描述

broker_name

String

队列所在的broker。

queue_id

Integer

队列ID。

timestamp_offset

Long

重置消费进度。

请求示例

重置topic_01主题的消费进度到指定时间点。

POST https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group_id}/reset-message-offset

{
  "topic" : "topic_01",
  "timestamp" : 1662652800000
}

响应示例

状态码: 200

重置消费进度成功。

{
  "queues" : [ {
    "broker_name" : "broker-1",
    "queue_id" : 0,
    "timestamp_offset" : 0
  } ]
}

SDK代码示例

SDK代码示例如下。

重置topic_01主题的消费进度到指定时间点。

 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
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.rocketmq.v2.region.rocketmqRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ResetConsumeOffsetSolution {

    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);

        rocketmqClient client = rocketmqClient.newBuilder()
                .withCredential(auth)
                .withRegion(rocketmqRegion.valueOf("<YOUR REGION>"))
                .build();
        ResetConsumeOffsetRequest request = new ResetConsumeOffsetRequest();
        request.withEngine(ResetConsumeOffsetRequest.EngineEnum.fromValue("{engine}"));
        request.withInstanceId("{instance_id}");
        request.withGroupId("{group_id}");
        ResetConsumeOffsetReq body = new ResetConsumeOffsetReq();
        body.withTimestamp("1662652800000");
        body.withTopic("topic_01");
        request.withBody(body);
        try {
            ResetConsumeOffsetResponse response = client.resetConsumeOffset(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());
        }
    }
}

重置topic_01主题的消费进度到指定时间点。

 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import rocketmqRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId) \

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

    try:
        request = ResetConsumeOffsetRequest()
        request.engine = "{engine}"
        request.instance_id = "{instance_id}"
        request.group_id = "{group_id}"
        request.body = ResetConsumeOffsetReq(
            timestamp="1662652800000",
            topic="topic_01"
        )
        response = client.reset_consume_offset(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

重置topic_01主题的消费进度到指定时间点。

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/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 := rocketmq.NewrocketmqClient(
        rocketmq.rocketmqClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ResetConsumeOffsetRequest{}
	request.Engine = model.GetResetConsumeOffsetRequestEngineEnum().ENGINE
	request.InstanceId = "{instance_id}"
	request.GroupId = "{group_id}"
	request.Body = &model.ResetConsumeOffsetReq{
		Timestamp: "1662652800000",
		Topic: "topic_01",
	}
	response, err := client.ResetConsumeOffset(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

重置消费进度成功。

错误码

请参见错误码