tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RewindQueue

Last updated: 2020-05-09 10:25:46

1. API Description

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

This API is used to rewind a queue.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cmq.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: RewindQueue.
Version Yes String Common parameter. The value used for this API: 2019-03-04.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
QueueName Yes String Queue name, which is unique under the same account in an individual region. It is a string of up to 64 characters, which must begin with a letter and can contain letters, digits, and dashes (-).
StartConsumeTime Yes Integer After this time is set, the (Batch)receiveMessage API will consume the messages received after this timestamp in the order in which they are produced.

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 Rewinding consumption position in queue

This example shows you how to rewind the consumption position in a queue.

Input Example

https://cmq.tencentcloudapi.com/?Action=RewindQueue
&QueueName=test&StartConsumeTime=1582108595
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy