View Pool(s)

You can use this APIs to view all the pools and a pool by its name, respectively.

• View All Pools

• View A Pool By Its Name

Note

To run the experimental APIs, you require to have Airflow version 1.10.0 and above.

Required Role

A user with read permission to the cluster can make this API call.

View All Pools

For Airflow version 1.10.0 and older:

GET /airflow-webserver-<cluster-id>/api/experimental/pools

For Airflow 1.10.2 and later:

GET /airflow-rbacwebserver-<cluster-id>/api/experimental/pools

Syntax

curl -X GET \  https://<ENV>.qubole.com/airflow-rbacwebserver-<Cluster-ID>/api/experimental/pools \

Sample Query

curl -X GET \  https://api.qubole.com/airflow-rbacwebserver-1/api/experimental/pools \
  -H "Accept: application/json"
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-TOKEN: <AUTH_TOKEN>'\
  -d '{}'

Sample Response

[
 {
   "description": "This is a demo pool for qubole",
   "id": 1,
   "pool": "testing_pool",
   "slots": 2
 }
]

View A Pool By Its Name

For Airflow version 1.10.0 and older:

GET /airflow-webserver-<cluster-id>/api/experimental/pools/<string:name>

For Airflow 1.10.2 and later:

GET /airflow-rbacwebserver-<cluster-id>/api/experimental/pools/<string:name>

Syntax

curl -X GET \  https://<ENV>.qubole.com/airflow-rbacwebserver-<Cluster-ID>/api/experimental/pools/testing_pool \

Sample Query

curl -X GET \  https://api.qubole.com/airflow-rbacwebserver-1/api/experimental/pools/testing_pool \
  -H "Accept: application/json"
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-TOKEN: <AUTH_TOKEN>'\
  -d '{}'

Sample Response

{
 "description": "This is a demo pool for qubole",
 "id": 1,
 "pool": "testing_pool",
 "slots": 2
}