Domain name for API request: tdmq.intl.tencentcloudapi.com.
Reset consumer offset.
This API is applicable to clusters: 4.x virtual cluster, 4.x dedicated cluster, and 4.x generic cluster. For 5.x clusters, refer to the API documentation ResetConsumerGroupOffset to reset the consumer offset.
A maximum of 20 requests can be initiated per second for this API.
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. The 4.x common Cluster Namespace is fixed as: tdmq_default |
| GroupId | Yes | String | Consumer group name. |
| Type | Yes | Integer | Reset method. 0: Start from the latest offset; 1: Start from specified time point. |
| Topic | No | String | Topic name. |
| ResetTimestamp | No | Integer | Reset the specified timestamp. This parameter is valid only when Type is 1, in milliseconds. |
| RetryFlag | No | Boolean | Whether the reset flag is retry topic. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ResetRocketMQConsumerOffSet
<Common request parameters>
{
"ClusterId": "rocketmq-2p9vx3ax9jxg",
"NamespaceId": "test_namespace",
"GroupId": "test_group",
"Topic": "test_topic",
"Type": 1,
"ResetTimestamp": 1697945990000
}
{
"Response": {
"RequestId": "def4f676-27fc-4437-b4a3-cf1509726f98"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| ResourceInUse | The resource is in use. |
| ResourceNotFound | The resource does not exist. |
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