CreateQueue

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

1. API Description

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

This API is used to create 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: CreateQueue.
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 (-).
MaxMsgHeapNum No Integer Maximum number of heaped messages. The value range is 1,000,000–10,000,000 during the beta test and can be 1,000,000–1,000,000,000 after the product is officially released. The default value is 10,000,000 during the beta test and will be 100,000,000 after the product is officially released.
PollingWaitSeconds No Integer Long polling wait time for message reception. Value range: 0–30 seconds. Default value: 0.
VisibilityTimeout No Integer Message visibility timeout period. Value range: 1–43200 seconds (i.e., 12 hours). Default value: 30.
MaxMsgSize No Integer Maximum message length. Value range: 1024–65536 bytes (i.e., 1–64 KB). Default value: 65536.
MsgRetentionSeconds No Integer Message retention period. Value range: 60–1296000 seconds (i.e., 1 minute–15 days). Default value: 345600 (i.e., 4 days).
RewindSeconds No Integer Whether to enable the message rewinding feature for a queue. Value range: 0–msgRetentionSeconds, where 0 means not to enable this feature, while msgRetentionSeconds indicates that the maximum rewindable period is the message retention period of the queue.
Transaction No Integer 1: transaction queue, 0: general queue
FirstQueryInterval No Integer First lookback interval
MaxQueryCount No Integer Maximum number of lookbacks
DeadLetterQueueName No String Dead letter queue name
Policy No Integer Dead letter policy. 0: message has been consumed multiple times but not deleted, 1: Time-To-Live has elapsed
MaxReceiveCount No Integer Maximum receipt times. Value range: 1–1000
MaxTimeToLive No Integer Maximum period in seconds before an unconsumed message expires, which is required if policy is 1. Value range: 300–43200. This value should be smaller than msgRetentionSeconds (maximum message retention period)
Trace No Boolean Whether to enable message trace. true: yes, false: no. If this field is not set, the feature will not be enabled

3. Output Parameters

Parameter Name Type Description
QueueId String queueId of a successfully created queue
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating queue

This example shows you how to create a queue.

Input Example

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

Output Example

{
  "Response": {
    "QueueId": "queue-ges05csc",
    "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.
LimitExceeded The quota limit is exceeded.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help