Use SetQueueAttributes to modify queue attributes - Simple Message Queue (formerly MNS)

You can call the SetQueueAttributes operation to modify the properties of a queue.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mns:SetQueueAttributes

update

*Queue

acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}

mns:EnableLogging

None

Request parameters

Parameter	Type	Required	Description	Example
QueueName	string	Yes	The name of the queue.	testqueue
DelaySeconds	integer	No	The delay period for messages that are sent to the queue. After a message is sent to the queue, it can be consumed only after the specified delay period elapses. Valid values: 0 to 604800. Unit: seconds. Default value: 0.	0
MaximumMessageSize	integer	No	The maximum size of a message body that can be sent to the queue. Valid values: 1024 to 65536. Unit: bytes. Default value: 65536.	1024
MessageRetentionPeriod	integer	No	The maximum time to live (TTL) for a message in the queue. After the specified period elapses from the time the message is sent, the message is deleted, regardless of whether it has been retrieved. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.	120
VisibilityTimeout	integer	No	The duration that a message is invisible after it is retrieved from the queue. During this period, the message is in the Inactive state. Valid values: 1 to 43200. Unit: seconds. Default value: 30.	60
PollingWaitSeconds	integer	No	The maximum time that a ReceiveMessage request waits for a message to become available in the queue. Valid values: 0 to 30. Unit: seconds. Default value: 0.	0
EnableLogging	boolean	No	Specifies whether to enable Log Management. The valid values are: true: Enables the feature. false: Disables the feature. Default value: false.	true
DlqPolicy	object	No	The dead-letter queue policy.
Enabled	boolean	No	Specifies whether to deliver dead-letter messages.	true
DeadLetterTargetQueue	string	No	The destination queue for dead-letter messages.	deadLetterTargetQueue
MaxReceiveCount	integer	No	The maximum number of times a message can be received before it is sent to the dead-letter queue.	3
TenantRateLimitPolicy	object	No
Enabled	boolean	No
MaxReceivesPerSecond	integer	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	06273500-249F-5863-121D-74D51123****
Code	integer	The response code.	200
Status	string	The status of the response.	Success
Message	string	The response message.	operation success
Success	boolean	Indicates whether the request was successful.	true
Data	object	The data returned.
Code	integer	The response code.	200
Message	string	The response message.	无
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "Code": 200,
    "Message": "无",
    "Success": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.