| # airflow_client.client.DagReportApi |
| |
| All URIs are relative to *http://localhost* |
| |
| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**get_dag_reports**](DagReportApi.md#get_dag_reports) | **GET** /api/v2/dagReports | Get Dag Reports |
| |
| |
| # **get_dag_reports** |
| > object get_dag_reports(subdir) |
| |
| Get Dag Reports |
| |
| Get DAG report. |
| |
| ### Example |
| |
| * OAuth Authentication (OAuth2PasswordBearer): |
| * Bearer Authentication (HTTPBearer): |
| |
| ```python |
| import airflow_client.client |
| from airflow_client.client.rest import ApiException |
| from pprint import pprint |
| |
| # Defining the host is optional and defaults to http://localhost |
| # See configuration.py for a list of all supported configuration parameters. |
| configuration = airflow_client.client.Configuration( |
| host = "http://localhost" |
| ) |
| |
| # 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. |
| |
| configuration.access_token = os.environ["ACCESS_TOKEN"] |
| |
| # Configure Bearer authorization: HTTPBearer |
| configuration = airflow_client.client.Configuration( |
| access_token = os.environ["BEARER_TOKEN"] |
| ) |
| |
| # Enter a context with an instance of the API client |
| with airflow_client.client.ApiClient(configuration) as api_client: |
| # Create an instance of the API class |
| api_instance = airflow_client.client.DagReportApi(api_client) |
| subdir = 'subdir_example' # str | |
| |
| try: |
| # Get Dag Reports |
| api_response = api_instance.get_dag_reports(subdir) |
| print("The response of DagReportApi->get_dag_reports:\n") |
| pprint(api_response) |
| except Exception as e: |
| print("Exception when calling DagReportApi->get_dag_reports: %s\n" % e) |
| ``` |
| |
| |
| |
| ### Parameters |
| |
| |
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **subdir** | **str**| | |
| |
| ### Return type |
| |
| **object** |
| |
| ### Authorization |
| |
| [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer) |
| |
| ### HTTP request headers |
| |
| - **Content-Type**: Not defined |
| - **Accept**: application/json |
| |
| ### HTTP response details |
| |
| | Status code | Description | Response headers | |
| |-------------|-------------|------------------| |
| **200** | Successful Response | - | |
| **400** | Bad Request | - | |
| **401** | Unauthorized | - | |
| **403** | Forbidden | - | |
| **422** | Validation Error | - | |
| |
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| |