tencent cloud

Feedback

ResetRocketMQConsumerOffSet

Last updated: 2022-10-09 15:20:45

1. API Description

Domain name for API request: tdmq.tencentcloudapi.com.

This API is used to reset the consumption offset of a specified consumer group to a specified timestamp.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ResetRocketMQConsumerOffSet.
Version Yes String Common Params. The value used for this API: 2020-02-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID.
NamespaceId Yes String Namespace name.
GroupId Yes String Consumer group name.
Topic Yes String Topic name.
Type Yes Integer Reset method. 0: Start from the latest offset; 1: Start from specified time point.
ResetTimestamp No Integer The specified timestamp that has been reset, in milliseconds. This parameter only takes effect when the value of Type is 1.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Resetting consumption offset

Input Example

https://tdmq.tencentcloudapi.com/?
Action=ResetRocketMQConsumerOffSet
&ClusterId=ocketmq-2p9vx3ax9jxg
&NamespaceId=example
&GroupId=group-example
&Topic=example-topic
&Type=0
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "def4f676-27fc-4437-b4a3-cf1509726f98"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
ResourceNotFound The resource does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support