CreateQueue

Updated at:

Creates 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:CreateQueue

create

*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.

06273500-249F-5863-121D-74D51123****

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.

65536

MessageRetentionPeriod

integer

No

The maximum retention period of a message in the queue. After the specified period elapses from the time the message is sent to the queue, the message is deleted regardless of whether it has been received. Valid values: 60 to 604800. Unit: seconds. Default value: 345600.

345600

VisibilityTimeout

integer

No

The duration for which a message remains in the inactive state after it is received from the queue. Valid values: 1 to 43200. Unit: seconds. Default value: 30.

60

PollingWaitSeconds

integer

No

The maximum wait time for a ReceiveMessage request when no messages are available in the queue. Valid values: 0 to 30. Unit: seconds. Default value: 0.

0

EnableLogging

boolean

No

Specifies whether to enable the Log Management feature. Valid values:

  • true: Enabled.

  • false: Disabled.

Default value: false.

true

DelaySeconds

integer

No

The delay time for all messages sent to the queue. A message can be consumed only after the specified delay time elapses from the time it is sent to the queue. Valid values: 0 to 604800. Unit: seconds. Default value: 0.

0

Tag

array<object>

No

The list of resource tags.

object

No

The tag value corresponding to the tag key.

Key

string

No

The tag key.

tag1

Value

string

No

The tag value.

test

DlqPolicy

object

No

The dead-letter policy.

DeadLetterTargetQueue

string

No

The destination queue for dead-letter messages.

deadLetterQueue

Enabled

boolean

No

Specifies whether to enable dead-letter message delivery.

true

MaxReceiveCount

integer

No

The maximum number of receive attempts for a message.

3

QueueType

string

No

The type of the queue. Valid values:

  • normal: Standard queue.

  • fifo: FIFO queue.

normal

TenantRateLimitPolicy

object

No

The throttling policy.

Enabled

boolean

No

Specifies whether to enable throttling. Valid values:

  • true

  • false

false

MaxReceivesPerSecond

integer

No

The maximum number of receives per second.

1000

EnableSSE

boolean

No

Specifies whether log broker encryption is enabled. Valid values: true and false.

SseType

string

No

The storage encryption method. Valid values: SMQ and KMS.

KMS

SseAlgorithm

string

No

The storage encryption algorithm. AES-256-GCM is supported. If you do not specify this parameter, the default algorithm is used.

AES-256-GCM

KmsKeyId

string

No

The KMS key ID. This parameter is required only when SseType is set to KMS.

key-xxx

Response elements

Element

Type

Description

Example

object

Code

integer

The response code.

200

Data

object

The response data.

Code

integer

The response code.

200

Message

string

The response message.

None

Success

boolean

Indicates whether the request is successful.

true

Message

string

The response message.

operation success

RequestId

string

The ID of the request.

06273500-249F-5863-121D-74D51123E62C

Status

string

The response status.

Success

Success

boolean

Indicates whether the request is successful.

true

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.