Domain name for API request: cmq.tencentcloudapi.com.
This API is used to modify queue attributes.
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
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: ModifyQueueAttribute. |
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 | Maximum message rewindable period. Value range: 0–msgRetentionSeconds (maximum message retention period of a queue). 0 means not to enable message rewinding. |
FirstQueryInterval | No | Integer | First query time |
MaxQueryCount | No | Integer | Maximum number of queries |
DeadLetterQueueName | No | String | Dead letter queue name |
MaxTimeToLive | No | Integer | Maximum period in seconds before an unconsumed message expires, which is required if MaxTimeToLivepolicy is 1. Value range: 300–43200. This value should be smaller than MsgRetentionSeconds (maximum message retention period) |
MaxReceiveCount | No | Integer | Maximum number of receipts |
Policy | No | Integer | Dead letter queue policy |
Trace | No | Boolean | Whether to enable message trace. true: yes, false: no. If this field is left empty, the feature will not be enabled. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify queue attributes.
https://cmq.tencentcloudapi.com/?Action=ModifyQueueAttribute
&QueueName=test&MaxMsgSize=1024
&<Common request parameters>
{
"Response": {
"RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
}
}
This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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.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. |
Was this page helpful?