All URIs are relative to /api/v1
Method | HTTP request | Description |
---|---|---|
get_health | GET /health | Get instance status |
get_version | GET /version | Get version information |
HealthInfo get_health()
Get instance status
Get the status of Airflow's metadatabase and scheduler. It includes info about metadatabase and last heartbeat of scheduler.
import time import airflow_client.client from airflow_client.client.api import monitoring_api from airflow_client.client.model.health_info import HealthInfo from pprint import pprint # Defining the host is optional and defaults to /api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitoring_api.MonitoringApi(api_client) # example, this endpoint has no required or optional parameters try: # Get instance status api_response = api_instance.get_health() pprint(api_response) except client.ApiException as e: print("Exception when calling MonitoringApi->get_health: %s\n" % e)
This endpoint does not need any parameter.
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionInfo get_version()
Get version information
import time import airflow_client.client from airflow_client.client.api import monitoring_api from airflow_client.client.model.version_info import VersionInfo from pprint import pprint # Defining the host is optional and defaults to /api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = monitoring_api.MonitoringApi(api_client) # example, this endpoint has no required or optional parameters try: # Get version information api_response = api_instance.get_version() pprint(api_response) except client.ApiException as e: print("Exception when calling MonitoringApi->get_version: %s\n" % e)
This endpoint does not need any parameter.
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]