Apache NiFi REST API

REST API definition for Apache NiFi web services

OpenAPI spec version: 2.6.0 Contact: dev@nifi.apache.org Generated by: https://github.com/swagger-api/swagger-codegen.git

class nipyapi.nifi.apis.system_diagnostics_api.SystemDiagnosticsApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. Ref: https://github.com/swagger-api/swagger-codegen

__init__(api_client=None)[source]
get_jmx_metrics(**kwargs)[source]

Retrieve available JMX metrics.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_jmx_metrics_with_http_info() method instead.

Parameters:

bean_name_filter (str) – Regular Expression Pattern to be applied against the ObjectName

Returns:

The response data.

Return type:

JmxMetricsResultsEntity

get_jmx_metrics_with_http_info(**kwargs)[source]

Retrieve available JMX metrics.

Note: This endpoint is subject to change as NiFi and it’s REST API evolve.

This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_jmx_metrics() method instead.

Parameters:

bean_name_filter (str) – Regular Expression Pattern to be applied against the ObjectName

Returns:

(JmxMetricsResultsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple

get_system_diagnostics(**kwargs)[source]

Gets the diagnostics for the system NiFi is running on. This method makes a synchronous HTTP request and returns the response data directly.

For full HTTP response details (status code, headers, etc.), use the corresponding get_system_diagnostics_with_http_info() method instead.

Parameters:

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • diagnostic_level (str) – Whether or not to include verbose details. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

The response data.

Return type:

SystemDiagnosticsEntity

get_system_diagnostics_with_http_info(**kwargs)[source]

Gets the diagnostics for the system NiFi is running on. This method makes a synchronous HTTP request and returns detailed response information.

Returns the response data along with HTTP status code, headers, and other metadata. For just the response data, use the corresponding get_system_diagnostics() method instead.

Parameters:

  • nodewise (bool) – Whether or not to include the breakdown per node. Optional, defaults to false

  • diagnostic_level (str) – Whether or not to include verbose details. Optional, defaults to false

  • cluster_node_id (str) – The id of the node where to get the status.

Returns:

(SystemDiagnosticsEntity, status_code, headers) - Response data with HTTP details.

Return type:

tuple