Skip to content

Latest commit

 

History

History
416 lines (280 loc) · 10.3 KB

ControllerApi.md

File metadata and controls

416 lines (280 loc) · 10.3 KB
Raw

ControllerApi

All URIs are relative to http://localhost/nifi-api

Method HTTP request Description
createControllerService POST /controller/controller-services Creates a new controller service
createReportingTask POST /controller/reporting-tasks Creates a new reporting task
deleteHistory DELETE /controller/history Purges history
deleteNode DELETE /controller/cluster/nodes/{id} Removes a node from the cluster
getCluster GET /controller/cluster Gets the contents of the cluster
getControllerConfig GET /controller/config Retrieves the configuration for this NiFi Controller
getNode GET /controller/cluster/nodes/{id} Gets a node in the cluster
updateControllerConfig PUT /controller/config Retrieves the configuration for this NiFi
updateNode PUT /controller/cluster/nodes/{id} Updates a node in the cluster

createControllerService

ControllerServiceEntity createControllerService(body)

Creates a new controller service

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
ControllerServiceEntity body = new ControllerServiceEntity(); // ControllerServiceEntity | The controller service configuration details.
try {
    ControllerServiceEntity result = apiInstance.createControllerService(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#createControllerService");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ControllerServiceEntity The controller service configuration details.

Return type

ControllerServiceEntity

Authorization

No authorization required

HTTP request headers

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

createReportingTask

ReportingTaskEntity createReportingTask(body)

Creates a new reporting task

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
ReportingTaskEntity body = new ReportingTaskEntity(); // ReportingTaskEntity | The reporting task configuration details.
try {
    ReportingTaskEntity result = apiInstance.createReportingTask(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#createReportingTask");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ReportingTaskEntity The reporting task configuration details.

Return type

ReportingTaskEntity

Authorization

No authorization required

HTTP request headers

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

deleteHistory

HistoryEntity deleteHistory(endDate)

Purges history

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
String endDate = "endDate_example"; // String | Purge actions before this date/time.
try {
    HistoryEntity result = apiInstance.deleteHistory(endDate);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#deleteHistory");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
endDate String Purge actions before this date/time.

Return type

HistoryEntity

Authorization

No authorization required

HTTP request headers

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

deleteNode

NodeEntity deleteNode(id)

Removes a node from the cluster

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
String id = "id_example"; // String | The node id.
try {
    NodeEntity result = apiInstance.deleteNode(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#deleteNode");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The node id.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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

getCluster

ClusterEntity getCluster()

Gets the contents of the cluster

Returns the contents of the cluster including all nodes and their status.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
try {
    ClusterEntity result = apiInstance.getCluster();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#getCluster");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ClusterEntity

Authorization

No authorization required

HTTP request headers

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

getControllerConfig

ControllerConfigurationEntity getControllerConfig()

Retrieves the configuration for this NiFi Controller

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
try {
    ControllerConfigurationEntity result = apiInstance.getControllerConfig();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#getControllerConfig");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ControllerConfigurationEntity

Authorization

No authorization required

HTTP request headers

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

getNode

NodeEntity getNode(id)

Gets a node in the cluster

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
String id = "id_example"; // String | The node id.
try {
    NodeEntity result = apiInstance.getNode(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#getNode");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The node id.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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

updateControllerConfig

ControllerConfigurationEntity updateControllerConfig(body)

Retrieves the configuration for this NiFi

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
ControllerConfigurationEntity body = new ControllerConfigurationEntity(); // ControllerConfigurationEntity | The controller configuration.
try {
    ControllerConfigurationEntity result = apiInstance.updateControllerConfig(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#updateControllerConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ControllerConfigurationEntity The controller configuration.

Return type

ControllerConfigurationEntity

Authorization

No authorization required

HTTP request headers

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

updateNode

NodeEntity updateNode(id, body)

Updates a node in the cluster

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.ControllerApi;


ControllerApi apiInstance = new ControllerApi();
String id = "id_example"; // String | The node id.
NodeEntity body = new NodeEntity(); // NodeEntity | The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.
try {
    NodeEntity result = apiInstance.updateNode(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ControllerApi#updateNode");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The node id.
body NodeEntity The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.

Return type

NodeEntity

Authorization

No authorization required

HTTP request headers

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