On this page

    Update Attributes of a Queue

    Note:
    Enterprise Edition only

    This API updates a queue’s attributes.

    Syntax

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

    Request Input

    {
      "id": "ID",
      "tag": "0",
      "name": "New Queue",
      "maxQueryMemoryPerNodeBytes": value,
      "maxMemoryPerNodeBytes": value,
      "cpuTier": "LOW | MEDIUM | HIGH | BACKGROUND | CRITICAL ",
      "maxAllowedRunningJobs": value,
      "maxStartTimeoutMs": value,
      "maxRunTimeoutMs": value
    }
    

    Response Output

    {
      "id": "ID",
      "tag": "1",
      "name": "New Queue",
      "maxQueryMemoryPerNodeBytes": value,
      "maxMemoryPerNodeBytes": value,
      "cpuTier": "LOW | MEDIUM | HIGH | BACKGROUND | CRITICAL ",
      "maxAllowedRunningJobs": value,
      "maxStartTimeoutMs": value,
      "maxRunTimeoutMs": value
    }
    

    Response Codes

    400 - Invalid body.
    403 - User does not have permission to update this queue.
    404 - Queue doesn’t exist.
    409 - Conflict, queue has been modified (version mismatch).

    Request Example

    CURL

    curl --request PUT \
      --url http://localhost:9047/api/v3/wlm/queue/by-name/UI \
      --header 'authorization: _dremioha5lrg03obu07o4fkaev5e4r8n' \
      --header 'content-type: application/json' \
      --data '{ "id": "5992f098-15d4-40b3-b158-08ea8f1f5067", "tag": "0", "name": "New Queue", "maxMemoryPerNodeBytes": 300000000, "maxQueryMemoryPerNodeBytes": 300000000, "cpuTier": "HIGH", "maxAllowedRunningJobs": 5, "maxStartTimeoutMs": 60000, "maxRunTimeoutMs": 600000 }'
    
    

    Python

    import requests
    
    url = "http://localhost:9047/api/v3/wlm/queue/by-name/UI"
    
    payload = "{ \"id\": \"5992f098-15d4-40b3-b158-08ea8f1f5067\", \"tag\": \"0\", \"name\": \"New Queue\", \"maxMemoryPerNodeBytes\": 300000000, \"maxQueryMemoryPerNodeBytes\": 300000000, \"cpuTier\": \"HIGH\", \"maxAllowedRunningJobs\": 5, \"maxStartTimeoutMs\": 60000, \"maxRunTimeoutMs\": 600000 }"
    headers = {
        'authorization': "_dremioha5lrg03obu07o4fkaev5e4r8n",
        'content-type': "application/json"
        }
    
    response = requests.request("PUT", url, data=payload, headers=headers)
    
    print(response.text)
    
    

    Response

    {
      "id": "5992f098-15d4-40b3-b158-08ea8f1f5067",
      "tag": "1",
      "name": "New Queue",
      "maxMemoryPerNodeBytes": 300000000,
      "maxQueryMemoryPerNodeBytes": 300000000,
      "cpuTier": "HIGH",
      "maxAllowedRunningJobs": 5,
      "maxStartTimeoutMs": 60000,
      "maxRunTimeoutMs": 600000
    }