Release Notes and Announcements

Release Notes

Cluster Version Updates

Product Announcements

Product Introduction

Introduction and Selection of the TDMQ Product Series

What Is TDMQ for Apache Pulsar

Strengths

Scenarios

How It Works

Product Series

Version Support Instructions for Open-Source Apache Pulsar

Comparison with Open-Source Apache Pulsar

High Availability

Quotas and Limits

Basic Concepts

Billing

Billing Overview

Pricing

Billing Examples

Renewal

Viewing Consumption Details

Overdue Payments

Refund

Getting Started

Getting Started Guide

Preparations

Using the SDK to Send and Receive General Messages

Using the SDK to Send and Receive Advanced Feature Messages

User Guide

Usage Process Guide

Configuring the Account Permission

Creating a Cluster

Configuring the Namespace

Configuring the Topic

Connecting to a Cluster

Managing the Cluster

Querying Messages and Traces

Cross-Region Replication

Viewing Monitoring Data and Configuring Alarm Rules

Use Cases

Client Usage

Abnormal Consumer Isolation

Traffic Throttling Mechanisms

Transaction Reconciliation

Message Idempotence

Message Compression

Migration Guide

Single-Write Multiple-Read Cluster Migration Solutions

Hitless Migration from Virtual Cluster to Pro Cluster

SDK Reference

API Overview

SDK Reference

SDK Overview

Recommended SDK Configuration Parameters

TCP Protocol (Apache Pulsar)

Security and Compliance

Permission Management

Deletion Protection

CloudAudit

FAQs

Monitoring

Clients

Agreements

Service Level Agreement

TDMQ Policy

Glossary

ResetMsgSubOffsetByTimestamp

Focus Mode

Font Size

Last updated: 2025-11-25 10:54:05

1. API Description

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

This API is used to rewind a message by timestamp, accurate down to the millisecond.

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: ResetMsgSubOffsetByTimestamp.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley.
EnvironmentId	Yes	String	Namespace name.
TopicName	Yes	String	Topic name.
Subscription	Yes	String	Subscriber name.
ToTimestamp	Yes	Integer	Timestamp, accurate down to the millisecond.
ClusterId	Yes	String	Pulsar cluster ID

3. Output Parameters

Parameter Name	Type	Description
Result	Boolean	Result. Note: this field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Rewindable Message

Input Example

POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetMsgSubOffsetByTimestamp
<Common request parameters>

{
    "EnvironmentId": "devNs",
    "TopicName": "devTopic",
    "Subscription": "devSub",
    "ToTimestamp": 1730690396152,
    "ClusterId": "pulsar-pnvjp9mbd947"
}

Output Example

{
    "Response": {
        "Result": true,
        "RequestId": "3593f784-fcfb-4f23-b3dd-4751cba3aec7"
    }
}

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

Tencent Cloud CLI 3.0

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
AuthFailure.UnauthorizedOperation	CAM authentication failed.
FailedOperation	Operation failed.
FailedOperation.ResetMsgSubOffsetByTimestampFailed	Failed to configure message rewind.
InternalError.SystemError	System error.
InvalidParameterValue.InvalidParams	The parameter value is out of the value range.
MissingParameter.NeedMoreParams	A required parameter is missing.
ResourceNotFound.BrokerCluster	The service cluster does not exist.
ResourceNotFound.Cluster	The cluster does not exist.
ResourceNotFound.Subscription	The subscription does not exist.
ResourceNotFound.Topic	The topic does not exist.
ResourceUnavailable.FundRequired	You must top up before proceeding.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

TDMQ for Apache Pulsar