queue.queues.metrics

Message counts over time (about 180 points over the range)

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

Request syntax

GET /queue/api/queues/{name}/metrics

Path parameters

  • nameRequired

    string

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

Query parameters

  • hoursOptional

    number

    How far back, in hours (default 3, at most 14 days)

    Constraints: integer, 1-336

Response

200; data holds periodSeconds (the spacing of the points, at least 60) and series: one entry per metric (messages_available, messages_in_flight, messages_delayed), each with points of { ts, value }, the highest count in each period.

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 metrics 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_metrics.