queue.queues.get

One queue: its attributes and visible, in-flight and delayed message counts

GET /queue/api/queues/{name}IAM queue:GetQueueAttributesRead

Request syntax

GET /queue/api/queues/{name}

Path parameters

  • nameRequired

    string

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

Response

200; data is the 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.

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:GetQueueAttributes 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 get name

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