Skip to main content
Version: 0.0.1

Queue {{< chip enterprise >}}

Use the Workload Management (WLM) API to create, retrieve, update, and delete WLM queues.

{{< codeheader "Queue Object" >}}

{
  "data": [
    {
      "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
      "tag": "BNGRmgfEnDg=",
      "name": "High Cost Reflections",
      "maxMemoryPerNodeBytes": 8589934592,
      "maxQueryMemoryPerNodeBytes": 8589934592,
      "cpuTier": "BACKGROUND",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000,
      "maxRunTimeoutMs": 300000,
      "engineId": "DATA"
    },
    {
      "id": "0dbc50a0-034d-40f6-92f7-ff11eda0c760",
      "tag": "HM2D9XElG3U=",
      "name": "Low Cost Reflections",
      "cpuTier": "BACKGROUND",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 86400000
    },
    {
      "id": "450ea2a5-9a64-4679-99cb-7b01bf6bba27",
      "tag": "p22KaFcaB7g=",
      "name": "COPY & OPTIMIZATION Queue",
      "maxMemoryPerNodeBytes": 4294967296,
      "maxQueryMemoryPerNodeBytes": 4294967296,
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 2,
      "maxStartTimeoutMs": 300000,
      "engineId": "YARN"
    },
    {
      "id": "a254d63e-9b0e-41be-af4a-1acc5bfe2332",
      "tag": "//gNL3Ta2bY=",
      "name": "Low Cost User Queries",
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 100,
      "maxStartTimeoutMs": 300000
    },
    {
      "id": "c2917cce-b566-4c6a-be63-2e28488a6928",
      "tag": "wa+vYmA73gU=",
      "name": "High Cost User Queries",
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000
    }
  ]
}

Queue Attributes​

{{< api-section file="data/software-api/wlm.json" data="queueAttributes" >}}

data​

{{< api-section file="data/software-api/wlm.json" data="queueDataAttributes" >}}

Creating a Queue​

Create a WLM queue.

{{< codeheader "Method and URL" >}}

POST /api/v3/wlm/queue

Parameters​

{{< api-section file="data/software-api/wlm.json" data="createQueueParameters" >}}


{{< codeheader "Example Request" >}}

curl -X POST 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "High Cost Reflections",
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "maxMemoryPerNodeBytes": 8589934592,
  "cpuTier": "BACKGROUND",
  "maxAllowedRunningJobs": 10,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}'

{{< codeheader "Example Response" >}}

{
  "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
  "tag": "BNGRmgfEnDg=",
  "name": "High Cost Reflections",
  "maxMemoryPerNodeBytes": 8589934592,
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "cpuTier": "BACKGROUND",
  "maxAllowedRunningJobs": 10,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="createQueueResponses" >}}

Retrieving All Queues​

Retrieve all WLM queues.

{{< codeheader "Method and URL" >}}

GET /api/v3/wlm/queue

{{< codeheader "Example Request" >}}

curl -X GET 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "data": [
    {
      "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
      "tag": "BNGRmgfEnDg=",
      "name": "High Cost Reflections",
      "maxMemoryPerNodeBytes": 8589934592,
      "maxQueryMemoryPerNodeBytes": 8589934592,
      "cpuTier": "BACKGROUND",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000,
      "maxRunTimeoutMs": 300000,
      "engineId": "DATA"
    },
    {
      "id": "0dbc50a0-034d-40f6-92f7-ff11eda0c760",
      "tag": "HM2D9XElG3U=",
      "name": "Low Cost Reflections",
      "cpuTier": "BACKGROUND",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 86400000
    },
    {
      "id": "450ea2a5-9a64-4679-99cb-7b01bf6bba27",
      "tag": "p22KaFcaB7g=",
      "name": "COPY & OPTIMIZATION Queue",
      "maxMemoryPerNodeBytes": 4294967296,
      "maxQueryMemoryPerNodeBytes": 4294967296,
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 2,
      "maxStartTimeoutMs": 300000,
      "engineId": "YARN"
    },
    {
      "id": "a254d63e-9b0e-41be-af4a-1acc5bfe2332",
      "tag": "//gNL3Ta2bY=",
      "name": "Low Cost User Queries",
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 100,
      "maxStartTimeoutMs": 300000
    },
    {
      "id": "c2917cce-b566-4c6a-be63-2e28488a6928",
      "tag": "wa+vYmA73gU=",
      "name": "High Cost User Queries",
      "cpuTier": "MEDIUM",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="retrieveQueueResponses" >}}

Retrieving a Queue by ID​

Retrieve a specific WLM queue by the queue's ID.

{{< codeheader "Method and URL" >}}

GET /api/v3/wlm/queue/{id}

Parameters​

{{< api-section file="data/software-api/wlm.json" data="retrieveQueueIdParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue/1990e713-3cd2-458c-89e1-68995c2c1047' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
  "tag": "BNGRmgfEnDg=",
  "name": "High Cost Reflections",
  "maxMemoryPerNodeBytes": 8589934592,
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "cpuTier": "BACKGROUND",
  "maxAllowedRunningJobs": 10,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="retrieveQueueIdResponses" >}}

Retrieving a Queue by Name​

Retrieve a specific WLM queue by the queue's name.

{{< codeheader "Method and URL" >}}

GET /api/v3/wlm/queue/by-name/{name}

Parameters​

{{< api-section file="data/software-api/wlm.json" data="retrieveQueueNameParameters" >}}


{{< codeheader "Example Request" >}}

curl -X GET 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue/by-name/High%20Cost%20Reflections' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

{
  "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
  "tag": "BNGRmgfEnDg=",
  "name": "High Cost Reflections",
  "maxMemoryPerNodeBytes": 8589934592,
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "cpuTier": "BACKGROUND",
  "maxAllowedRunningJobs": 10,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="retrieveQueueNameResponses" >}}

Updating a Queue​

Update the specified WLM queue.

{{< codeheader "Method and URL" >}}

PUT /api/v3/wlm/queue/{id}

Parameters​

{{< api-section file="data/software-api/wlm.json" data="updateQueueParameters" >}}


{{< codeheader "Example Request" >}}

curl -X PUT 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue/1990e713-3cd2-458c-89e1-68995c2c1047' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag": "BNGRmgfEnDg=",
  "name": "High Cost Reflections",
  "maxMemoryPerNodeBytes": 8589934592,
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "cpuTier": "LOW",
  "maxAllowedRunningJobs": 100,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}'

{{< codeheader "Example Response" >}}

{
  "id": "1990e713-3cd2-458c-89e1-68995c2c1047",
  "tag": "xQh6KNyEjus=",
  "name": "High Cost Reflections",
  "maxMemoryPerNodeBytes": 8589934592,
  "maxQueryMemoryPerNodeBytes": 8589934592,
  "cpuTier": "LOW",
  "maxAllowedRunningJobs": 100,
  "maxStartTimeoutMs": 300000,
  "maxRunTimeoutMs": 300000,
  "engineId": "DATA"
}

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="updateQueueResponses" >}}

Deleting a Queue​

Delete the specified WLM queue.

{{< codeheader "Method and URL" >}}

DELETE /api/v3/wlm/queue/{id}

Parameters​

{{< api-section file="data/software-api/wlm.json" data="deleteQueueParameters" >}}


{{< codeheader "Example Request" >}}

curl -X DELETE 'https://{DREMIO_ORIGIN}/api/v3/wlm/queue/1990e713-3cd2-458c-89e1-68995c2c1047' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'

{{< codeheader "Example Response" >}}

No response

Response Status Codes​

{{< api-responses file="data/software-api/wlm.json" data="deleteQueueResponses" >}}