queue.queues.create

Create a queue

POST /queue/api/queuesIAM queue:CreateQueueChanges state

Unset attributes take the defaults: visibility timeout 30 s, retention 4 days, no delay, no long polling, 256 KiB messages. deadLetterQueue names another queue of the organization; after maxReceiveCount receives a message moves there. 409 QueueAlreadyExists when the name is taken. fifo: true makes a FIFO queue (the name must end in .fifo, and a .fifo name requires it; fixed at creation): sends name a messageGroupId, each group is delivered in order with one batch in flight at a time, and sends are deduplicated for five minutes by messageDeduplicationId, or by the body with contentBasedDeduplication. A FIFO queue's dead-letter queue must be FIFO.

Request syntax

POST /queue/api/queues
{
  "name": "string",
  "fifo": "boolean",
  "tags": "map of string",
  "visibilityTimeoutSeconds": "number",
  "retentionSeconds": "number",
  "delaySeconds": "number",
  "receiveWaitSeconds": "number",
  "maximumMessageBytes": "number",
  "deadLetterQueue": "object",
  "contentBasedDeduplication": "boolean"
}

Request body

  • nameRequired

    string

    Name of the queue, unique in the organization and region; a FIFO queue’s name ends in .fifo

    Constraints: max 80 chars, /^[A-Za-z0-9_-]+(\.fifo)?$/

  • fifoOptional

    boolean

    Create a FIFO queue, which delivers each message group in order and deduplicates sends; cannot be changed later (default false)

  • tagsOptional

    map of string

    Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).

    Constraints: key=value

  • visibilityTimeoutSecondsOptional

    number

    Seconds a received message stays hidden from other consumers before it can be received again; 30 for a new queue

    Constraints: integer, 0-43200

  • retentionSecondsOptional

    number

    Seconds a message is kept before it is deleted unreceived; applies to messages sent afterwards; 4 days for a new queue

    Constraints: integer, 60-1209600

  • delaySecondsOptional

    number

    Seconds a newly sent message stays invisible before it can be received; 0 for a new queue

    Constraints: integer, 0-900

  • receiveWaitSecondsOptional

    number

    Seconds a receive waits for a message when it names no wait of its own; 0 answers at once; 0 for a new queue

    Constraints: integer, 0-20

  • maximumMessageBytesOptional

    number

    Largest message the queue accepts, in bytes, counting the body and attributes; 256 KiB for a new queue

    Constraints: integer, 1024-262144

  • deadLetterQueueOptional

    object

    Another queue of the organization (name) that receives a message after it has been received maxReceiveCount times without being deleted; null removes it; none for a new queue

    Constraints: JSON

    May be null.

  • contentBasedDeduplicationOptional

    boolean

    FIFO queues only: a send without messageDeduplicationId is deduplicated by the SHA-256 of its body; false for a new queue

Response

201; data is the new queue: id, name, region, fifo, its attributes (visibilityTimeoutSeconds, retentionSeconds, delaySeconds, receiveWaitSeconds, maximumMessageBytes, contentBasedDeduplication), deadLetterQueue ({ name, maxReceiveCount } or null), messages (counts: available, inFlight, delayed, deadLettered, total, and bytes), createdAt and updatedAt (all counts 0).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow queue:CreateQueue on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud queue queues create --name example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_queue_queues_create.