新功能发布记录
集群版本更新记录
产品公告
Domain name for API request: tdmq.intl.tencentcloudapi.com.
This API is used to create a CMQ queue.
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: CreateCmqQueue. |
| 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-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| QueueName | Yes | String | Queue name, which is unique under the same account in a single region. It is a string of up to 64 characters. It can contain letters, digits, and hyphens (-) and must start with a letter. |
| 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-1048576 Byte (1-1024K). default value: 1048576. |
| MsgRetentionSeconds | No | Integer | The max period during which a message is retained before it is automatically acknowledged. Value range: 30-43,200 seconds (30 seconds to 12 hours). Default value: 3600 seconds (1 hour). |
| RewindSeconds | No | Integer | Rewindable time of messages in the queue. Value range: 0-1,296,000s (if message rewind is enabled). The value “0” indicates that message rewind is not enabled. |
| 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 configured, the feature will not be enabled |
| Tags.N | No | Array of Tag | Tag array. |
| RetentionSizeInMB | No | Integer | Queue storage space configured for message rewind. Value range: 10,240-512,000 MB (if message rewind is enabled). The value “0” indicates that message rewind is not enabled. |
| Parameter Name | Type | Description |
|---|---|---|
| QueueId | String | queueId of a successfully created queue |
| 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. |
This example shows you how to create a queue.
POST / HTTP/1.1
Host: tdmq.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCmqQueue
<Common request parameters>
{
"QueueName": "test789"
}{
"Response": {
"RequestId": "864b1295-ed7e-45ed-9602-be53ac23177b",
"QueueId": "cmqq-rd42drdeaag9"
}
}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. |
| FailedOperation.CreateCluster | Failed to create the cluster. |
| FailedOperation.CreateTopic | Failed to create the topic. |
| FailedOperation.SetRetentionPolicy | Failed to set the message retention policy. |
| FailedOperation.SetTTL | Failed to configure the message TTL. |
| InternalError.BrokerService | The broker service is exceptional. |
| ResourceInUse | The resource is in use. |
| ResourceInUse.Queue | The queue already exists. |
| ResourceNotFound.Environment | The environment does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourceUnavailable.CreateFailed | Assignment exception. |
| ResourceUnavailable.FundRequired | You must top up before proceeding. |
| UnsupportedOperation | Unsupported operation. |
文档反馈