DAdagucloud
queues

Get summary information for a specific queue

Changed on

Returns queue metadata, running items, and queued counts for the specified queue.

get/queues/{name}

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

namestring required

Queue name

Query parameters

remoteNodestring

name of the remote node

Response

A successful response

namestring required

Name of the queue (global queue name or DAG name if no queue specified)

type'global' | 'dag-based' required

Type of queue - 'global' if explicitly defined, 'dag-based' if using DAG name

maxConcurrencyinteger

Maximum number of concurrent runs allowed. For 'global' queues, this is the configured maxConcurrency. For 'dag-based' queues, this is always 1 (FIFO execution)

runningCountinteger required

Number of currently running DAG-runs

queuedCountinteger required

Number of queued DAG-runs waiting to execute. When queuedCountCapped is true this is a lower bound, not an exact total.

queuedCountCappedboolean

True when counting stopped at the server-side scan cap, so queuedCount is a lower bound rather than an exact total

Example response

{
  "running": [
    {
      "dagRunId": "latest"
    }
  ]
}

Changes

  • v1f3177cd9b416Revision changes
    • info

      added the optional property // to the response with the status

  • v1fb3d2e0b0c98Revision changes
    • warning

      added the new file enum value to the // response property for the response status