Skip to content

Latest commit

 

History

History
167 lines (126 loc) · 5.65 KB

EventLogApi.md

File metadata and controls

167 lines (126 loc) · 5.65 KB
Raw

airflow_python_sdk.EventLogApi

All URIs are relative to http://localhost/api/v1

Method HTTP request Description
get_event_log GET /eventLogs/{event_log_id} Get a log entry
get_event_logs GET /eventLogs List log entries

get_event_log

EventLog get_event_log(event_log_id)

Get a log entry

Example

  • Basic Authentication (Basic):
import time
import airflow_python_sdk
from airflow_python_sdk.api import event_log_api
from airflow_python_sdk.model.error import Error
from airflow_python_sdk.model.event_log import EventLog
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_python_sdk.Configuration(
    host = "http://localhost/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 = airflow_python_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = event_log_api.EventLogApi(api_client)
    event_log_id = 1 # int | The event log ID.

    # example passing only required values which don't have defaults set
    try:
        # Get a log entry
        api_response = api_instance.get_event_log(event_log_id)
        pprint(api_response)
    except airflow_python_sdk.ApiException as e:
        print("Exception when calling EventLogApi->get_event_log: %s\n" % e)

Parameters

Name Type Description Notes
event_log_id int The event log ID.

Return type

EventLog

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success. -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -
404 A specified resource is not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_event_logs

EventLogCollection get_event_logs()

List log entries

List log entries from event log.

Example

  • Basic Authentication (Basic):
import time
import airflow_python_sdk
from airflow_python_sdk.api import event_log_api
from airflow_python_sdk.model.error import Error
from airflow_python_sdk.model.event_log_collection import EventLogCollection
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_python_sdk.Configuration(
    host = "http://localhost/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 = airflow_python_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = event_log_api.EventLogApi(api_client)
    limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100
    offset = 0 # int | The number of items to skip before starting to collect the result set. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List log entries
        api_response = api_instance.get_event_logs(limit=limit, offset=offset)
        pprint(api_response)
    except airflow_python_sdk.ApiException as e:
        print("Exception when calling EventLogApi->get_event_logs: %s\n" % e)

Parameters

Name Type Description Notes
limit int The numbers of items to return. [optional] if omitted the server will use the default value of 100
offset int The number of items to skip before starting to collect the result set. [optional]

Return type

EventLogCollection

Authorization

Basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success. -
401 Request not authenticated due to missing, invalid, authentication info. -
403 Client does not have sufficient permission. -
404 A specified resource is not found. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]