Information about existing clusters in Managed Service for Apache Airflow™
You can request detailed information about each Managed Service for Apache Airflow™ cluster you created.
Getting a list of clusters in a folder
- In the management console
, go to the relevant folder. - In the list of services, select Managed Service for Apache Airflow™.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To request a list of Apache Airflow™ clusters in the default folder, run the command:
yc managed-airflow cluster list
Result:
+----------------------+------------+---------------------+--------+---------+
| ID | NAME | CREATED AT | HEALTH | STATUS |
+----------------------+------------+---------------------+--------+---------+
| c9qhoain7mje******** | airflow375 | 2024-09-22 18:24:08 | ALIVE | RUNNING |
| ... |
+----------------------+------------+---------------------+--------+---------+
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.list method and make a request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters' \ --url-query folderId=<folder_ID>
You can request the folder ID with the list of folders in the cloud.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/List call and make a request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/airflow/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "folder_id": "<folder_ID>" }' \ airflow.api.cloud.yandex.net:443 \ yandex.cloud.airflow.v1.ClusterService.List
You can request the folder ID with the list of folders in the cloud.
-
View the server response to make sure the request was successful.
Getting detailed information about a cluster
- In the management console
, go to the relevant folder. - In the list of services, select Managed Service for Apache Airflow™.
- Click the cluster name.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get information about the Apache Airflow™ cluster, run the following command:
yc managed-airflow cluster get <cluster_name_or_ID>
You can request the cluster ID and name with a list of clusters in the folder.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.get method and make a request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters/<cluster_ID>'
You can get the cluster ID with a list of clusters in the folder.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/Get call and make a request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/airflow/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>" }' \ airflow.api.cloud.yandex.net:443 \ yandex.cloud.airflow.v1.ClusterService.Get
You can get the cluster ID with a list of clusters in the folder.
-
View the server response to make sure the request was successful.
Viewing operations with clusters
All actions with Managed Service for Apache Airflow™ clusters are logged as a list of operations. Each operation is assigned a unique ID.
Getting a list of operations
To get a list of operations for a Managed Service for Apache Airflow™ cluster:
-
In the management console
, open the folder with the cluster. -
Select Managed Service for Apache Airflow™.
-
In the left-hand panel, select
Clusters. -
Select the cluster you need.
-
Go to the
Operations panel for the selected cluster.You will see a list of operations with the selected cluster.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get a list of operations, run the following command:
yc managed-airflow cluster list-operations <cluster_name_or_ID>
You can request the cluster ID and name with a list of clusters in the folder.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Cluster.listOperations method and make a request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://airflow.api.cloud.yandex.net/managed-airflow/v1/clusters/<cluster_ID>/operations'
You can get the cluster ID with a list of clusters in the folder.
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the ClusterService/ListOperations call and make a request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/airflow/v1/cluster_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>" }' \ airflow.api.cloud.yandex.net:443 \ yandex.cloud.airflow.v1.ClusterService.ListOperations
You can get the cluster ID with a list of clusters in the folder.
-
View the server response to make sure the request was successful.
Getting detailed information about an operation
-
Get a list of operations for a cluster.
-
Copy the operation ID.
-
Get detailed information about the operation:
REST APIgRPC API-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Use the Operation.get method and make a request, e.g., via cURL
:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://operation.api.cloud.yandex.net/operations/<operation_ID>'
-
View the server response to make sure the request was successful.
-
Get an IAM token for API authentication and put it into the environment variable:
export IAM_TOKEN="<IAM_token>"
-
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
Below, we assume the repository contents are stored in the
~/cloudapi/
directory. -
Use the OperationService/Get call and make a request, e.g., via gRPCurl
:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/operation/operation_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "operation_id": "<operation_ID>" }' \ operation.api.cloud.yandex.net:443 \ yandex.cloud.operation.OperationService.Get
-
View the server response to make sure the request was successful.
-