On this page

    View Queue Information

    Note:
    Enterprise Edition only

    This API retrieves data about queues, containing either a list of queues or information about a specific queue.

    Syntax

    OperationURI
    Retrieves list of queues.GET /api/v3/wlm/queue
    Retrieves information about a specific queue by name.GET /api/v3/wlm/queue/by-name/{name}
    Retrieves information about a specific queue by ID.GET /api/v3/wlm/queue/{id}

    Response Output

    GET /api/v3/wlm/queue

    {
      "data": [
        {
          "id": "ID",
          "tag": "0",
          "name": "Query name",
          "cpuTier": "LOW | MEDIUM | HIGH | BACKGROUND | CRITICAL ",
          "maxAllowedRunningJobs": 10,
          "maxStartTimeoutMs": 300000
        }
        ]
    }
    

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

    {
      "id": "ID",
      "tag": "0",
      "name": "Query name",
      "cpuTier": "LOW | MEDIUM | HIGH | BACKGROUND | CRITICAL ",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000
    }
    
    

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

    {
      "id": "ID",
      "tag": "0",
      "name": "Query name",
      "cpuTier": "LOW | MEDIUM | HIGH | BACKGROUND | CRITICAL ",
      "maxAllowedRunningJobs": 10,
      "maxStartTimeoutMs": 300000
    }
    

    Response Codes

    GET /api/v3/wlm/queue

    403 - User does not have permission to access queues.

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

    403 - User does not have permission to access this queue. 404 - Queue does not exist.

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

    403 - User does not have permission to access this queue.
    404 - Queue doesn’t exist.

    Example: GET /api/v3/wlm/queue

    Curl Request

    curl --request GET \
      --url http://localhost:9047/api/v3/wlm/queue \
      --header 'authorization: _dremioha5lrg03obu07o4fkaev5e4r8n' \
      --header 'content-type: application/json'
    

    Python Request

    import requests
    
    url = "http://localhost:9047/api/v3/wlm/queue"
    
    payload = ""
    headers = {
        'authorization': "_dremioha5lrg03obu07o4fkaev5e4r8n",
        'content-type': "application/json"
        }
    
    response = requests.request("GET", url, data=payload, headers=headers)
    
    print(response.text)
    

    Response

    {
      "data": [
        {
          "id": "19f8fde2-66e8-403e-b0e1-c01c5d14b9b1",
          "tag": "0",
          "name": "High Cost User Queries",
          "cpuTier": "MEDIUM",
          "maxAllowedRunningJobs": 10,
          "maxStartTimeoutMs": 300000
        },
        {
          "id": "360fa7c1-a691-4d42-a045-8c066abb4990",
          "tag": "0",
          "name": "Low Cost User Queries",
          "cpuTier": "MEDIUM",
          "maxAllowedRunningJobs": 100,
          "maxStartTimeoutMs": 300000
        },
        {
          "id": "3736910c-507b-4527-8aa1-41544ba7eb3a",
          "tag": "0",
          "name": "High Cost Reflections",
          "cpuTier": "BACKGROUND",
          "maxAllowedRunningJobs": 1,
          "maxStartTimeoutMs": 86400000
        },
        {
          "id": "54b6941b-6d3a-4b71-977b-1ec3029dda9a",
          "tag": "0",
          "name": "Low Cost Reflections",
          "cpuTier": "BACKGROUND",
          "maxAllowedRunningJobs": 10,
          "maxStartTimeoutMs": 86400000
        },
        {
          "id": "a7606f6e-6240-4fd6-bfcd-dc191d8295d7",
          "tag": "0",
          "name": "UI Previews",
          "cpuTier": "CRITICAL",
          "maxAllowedRunningJobs": 100,
          "maxStartTimeoutMs": 300000
        }
      ]
    }
    
    

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

    CURL

    curl --request GET \
      --url http://localhost:9047/api/v3/wlm/queue/by-name/UI%20Previews \
      --header 'authorization: _dremioha5lrg03obu07o4fkaev5e4r8n' \
      --header 'content-type: application/json'
    
    

    Python

    import requests
    
    url = "http://localhost:9047/api/v3/wlm/queue/by-name/UI%20Previews"
    
    payload = ""
    headers = {
        'authorization': "_dremioha5lrg03obu07o4fkaev5e4r8n",
        'content-type': "application/json"
        }
    
    response = requests.request("GET", url, data=payload, headers=headers)
    
    print(response.text)
    
    

    Response

    {
      "id": "a7606f6e-6240-4fd6-bfcd-dc191d8295d7",
      "tag": "0",
      "name": "UI Previews",
      "cpuTier": "CRITICAL",
      "maxAllowedRunningJobs": 100,
      "maxStartTimeoutMs": 300000
    }
    
    

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

    Curl

    curl --request GET \
      --url http://localhost:9047/api/v3/wlm/queue/a7606f6e-6240-4fd6-bfcd-dc191d8295d7 \
      --header 'authorization: _dremioha5lrg03obu07o4fkaev5e4r8n' \
      --header 'content-type: application/json'
    
    

    Python

    import requests
    
    url = "http://localhost:9047/api/v3/wlm/queue/a7606f6e-6240-4fd6-bfcd-dc191d8295d7"
    
    payload = ""
    headers = {
        'authorization': "_dremioha5lrg03obu07o4fkaev5e4r8n",
        'content-type': "application/json"
        }
    
    response = requests.request("GET", url, data=payload, headers=headers)
    
    print(response.text)
    
    

    Response

    {
      "id": "a7606f6e-6240-4fd6-bfcd-dc191d8295d7",
      "tag": "0",
      "name": "UI Previews",
      "cpuTier": "CRITICAL",
      "maxAllowedRunningJobs": 100,
      "maxStartTimeoutMs": 300000
    }