tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ClearQueue

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

1. API Description

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

This API is used to clear all messages in 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: ClearQueue.
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 (-).

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 Clearing heaped messages in queue

This example shows you how to clear heaped messages in a queue.

Input Example

https://cmq.tencentcloudapi.com/?Action=ClearQueue
&QueueName=test
&<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

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.
FailedOperation.TryLater The operation is in progress. Please try again later.
InvalidParameter Invalid parameter.
InvalidParameterValue.NoTaskId The task ID does not exist.
LimitExceeded The quota limit is exceeded.
ResourceInUse The resource is in use.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy