Overview
This REST API provides remote access to the DataFlow Service. Endpoints that are marked as [BETA] are subject to change in future releases of the application without backwards compatibility and without a major version change.
Version information
Version : 0.9.112
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Tags
-
CDFLocalRPCAPIVersion1
Consumes
-
application/json
Produces
-
application/json
Paths
Create the custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/create-custom-nar-configuration
Description
Create the custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Create Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Deletes an orphaned custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/delete-custom-nar-configuration
Description
Deletes an orphaned custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Delete Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Get a custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/get-custom-nar-configuration
Description
Get a custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Get the default custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/get-default-custom-nar-configuration
Description
Get the default custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Default Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Update the custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/update-custom-nar-configuration
Description
Update the custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Update Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Validates the custom NAR configuration.
POST /dfx/api/rpc-v1/custom-nar-configurations/validate-custom-nar-configuration
Description
Validates the custom NAR configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Validate Custom NAR Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Aborts asset update request.
POST /dfx/api/rpc-v1/deployments/abort-asset-update-request
Description
Aborts an asset update request for a given deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Abort Asset Update Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Aborts a deployment request.
POST /dfx/api/rpc-v1/deployments/abort-deployment-request
Description
Aborts a deployment request.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Abort Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Cancels a NiFi version update for a deployment.
POST /dfx/api/rpc-v1/deployments/cancel-nifi-version-update
Description
Cancels a NiFi version update for a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Cancel NiFi Version Update |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Create asset update request.
POST /dfx/api/rpc-v1/deployments/create-asset-update-request
Description
Create an update request for modifying the assets of a given deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Create Asset Update Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Creates a deployment.
POST /dfx/api/rpc-v1/deployments/create-deployment
Description
Creates a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Create Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Creates a reporting task.
POST /dfx/api/rpc-v1/deployments/create-reporting-task
Description
Creates a reporting task in a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Create Reporting Task |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Deletes a reporting task.
POST /dfx/api/rpc-v1/deployments/delete-reporting-task
Description
Deletes a reporting task from a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Delete Reporting Task |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Export deployment configuration.
POST /dfx/api/rpc-v1/deployments/export-deployment
Description
Exports deployment configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Export Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Retrieves the deployment configuration.
POST /dfx/api/rpc-v1/deployments/get-deployment-configuration
Description
Retrieves the deployment configuration.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Deployment Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Retrieves the deployment configuration metadata.
POST /dfx/api/rpc-v1/deployments/get-deployment-configuration-metadata
Description
Retrieves the deployment configuration metadata.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Deployment Configuration Metadata Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Retrieves deployment request details.
POST /dfx/api/rpc-v1/deployments/get-deployment-request-details
Description
Retrieves deployment request details.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Deployment Request details |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Import deployment configuration.
POST /dfx/api/rpc-v1/deployments/import-deployment
Description
Imports deployment configuration from archive with provided archive name.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Import Deployment Configuration Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Lists the exported archive metadata of all deployments.
POST /dfx/api/rpc-v1/deployments/list-deployment-archives
Description
Lists the exported archive metadata of all deployments.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
List Deployment Archives Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Lists all reporting tasks for a deployment.
POST /dfx/api/rpc-v1/deployments/list-reporting-tasks
Description
Lists all reporting tasks for a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
List Reporting Tasks Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Restart a deployment.
POST /dfx/api/rpc-v1/deployments/restart-deployment
Description
Initiates restart of a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Restart Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Resumes a deployment.
POST /dfx/api/rpc-v1/deployments/resume-deployment
Description
Initiates the deployment resume.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Resume Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Starts a flow.
POST /dfx/api/rpc-v1/deployments/start-flow
Description
Starts the NiFi flow of a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Start Flow |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Stops a flow.
POST /dfx/api/rpc-v1/deployments/stop-flow
Description
Stops the NiFi flow of a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Stop Flow |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Suspends a deployment.
POST /dfx/api/rpc-v1/deployments/suspend-deployment
Description
Initiates the deployment suspend.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Suspend Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Terminates a deployment.
POST /dfx/api/rpc-v1/deployments/terminate-deployment
Description
Initiates the termination of a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Terminate Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Transitions a flow.
POST /dfx/api/rpc-v1/deployments/transition-flow
|
Caution
|
operation.deprecated |
Description
Transitions the NiFi flow of a deployment to the specified state. Deprecated. Use start-flow and stop-flow instead.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Transition Flow |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Updates a deployment.
POST /dfx/api/rpc-v1/deployments/update-deployment
Description
Updates a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Update Deployment Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Updates the NiFi version of a deployment.
POST /dfx/api/rpc-v1/deployments/update-nifi-version
Description
Initiates the process of updating the NiFi version of a deployment.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Update NiFi Version |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Upload an asset.
POST /dfx/api/rpc-v1/deployments/upload-asset
Description
Uploads an asset for a deployment request or asset update request.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Upload Asset |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Lists all supported NiFi versions.
POST /dfx/api/rpc-v1/environments/list-nifi-versions
Description
Lists all supported NiFi versions.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
List NiFi Versions Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Get Inbound Connection Endpoint Client Certificate (in PEM encoding). Deprecated. Use download-client-certificates-encoded instead.
POST /dfx/api/rpc-v1/inbound-connection-endpoint-certificates/download-client-certificate-encoded
Description
Get Inbound Connection Endpoint Client Certificate (in PEM encoding). Deprecated. Use download-client-certificates-encoded instead.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Inbound Connection Endpoint client’s certificate request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid inboundConnectionEndpointClientCertificateRequest. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Get Inbound Connection Endpoint Client Certificates (in PEM encoding)
POST /dfx/api/rpc-v1/inbound-connection-endpoint-certificates/download-client-certificates-encoded
Description
Get Inbound Connection Endpoint Client Certificates (in PEM encoding)
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Inbound Connection Endpoint client’s certificates |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Get Inbound Connection Endpoint Client’s Private Key (in PEM encoding). Deprecated. Use download-client-certificates-encoded instead.
POST /dfx/api/rpc-v1/inbound-connection-endpoint-certificates/download-client-private-key-encoded
Description
Get Inbound Connection Endpoint Client’s Private Key (in PEM encoding). Deprecated. Use download-client-certificates-encoded instead.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Get Inbound Connection Endpoint client’s private key request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Create Inbound Connection Endpoint
POST /dfx/api/rpc-v1/inbound-connection-endpoints/create-inbound-connection-endpoint
Description
Create Inbound Connection Endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Create Inbound Connection Endpoint request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Delete Inbound Connection Endpoint
POST /dfx/api/rpc-v1/inbound-connection-endpoints/delete-inbound-connection-endpoint
Description
Delete Inbound Connection Endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Delete Inbound Connection Endpoint request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Describe Inbound Connection Endpoint
POST /dfx/api/rpc-v1/inbound-connection-endpoints/describe-inbound-connection-endpoint
Description
Describe Inbound Connection Endpoint
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Describe Inbound Connection Endpoint request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
List Inbound Connection Endpoints
POST /dfx/api/rpc-v1/inbound-connection-endpoints/list-inbound-connection-endpoints
Description
List Inbound Connection Endpoints
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
List Inbound Connection Endpoints request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Renew Inbound Connection Endpoint certificates
POST /dfx/api/rpc-v1/inbound-connection-endpoints/renew-certificates
Description
Submits a request for renewal of Inbound Connection Endpoint certificates
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
body |
Inbound connection endpoint certificates renewal request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
No Content |
Tags
-
CDFLocalRPCAPIVersion1
Modifies the project assignment of the given workload resources.
POST /dfx/api/rpc-v1/workload-resources/reassign-resources
Description
Modifies the project assignment of the given workload resources.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
input |
Reassign Resources Request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Tags
-
CDFLocalRPCAPIVersion1
Definitions
AbortAssetUpdateRequestRequest
Request object for aborting an asset update request
| Name | Description | Schema |
|---|---|---|
assetUpdateRequestCrn |
The CRN of the asset update request |
string |
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
AbortAssetUpdateRequestResponse
Response object for aborting an asset update request
Type : object
AbortDeploymentRequestRequest
Request object for abort deployment request.
| Name | Description | Schema |
|---|---|---|
deploymentRequestCrn |
The deployment request crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
AbortDeploymentRequestResponse
Response object for aborting a deployment request.
Type : object
AlertFrequencyTolerance
The alert frequency tolerance unit choices, including a default
| Name | Description | Schema |
|---|---|---|
defaultUnitId |
The default alert frequency ID to use as the default chooser value |
string |
units |
The legal alert frequency values |
< AlertFrequencyUnit > array |
AlertFrequencyUnit
The alert frequency unit to use in KPI tolerances and metrics
| Name | Description | Schema |
|---|---|---|
abbreviation |
The abbreviation for frequency unit |
string |
id |
The id of the frequency unit |
enum (SECONDS, MINUTES, HOURS, DAYS) |
label |
The user-friendly label of the frequency unit |
string |
AssetReference
A reference to an asset used in a flow parameter
| Name | Description | Schema |
|---|---|---|
environmentProvided |
Whether or not the asset is provided automatically by the environment. If true, the asset cannot removed or replaced. |
boolean |
name |
The name of the asset |
string |
path |
The path of the asset |
string |
version |
The version of the asset |
string |
CancelNifiVersionUpdateRequest
Request object for cancelling a NiFi version update for a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
CancelNifiVersionUpdateResponse
Response object for cancelling a NiFi version update for a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
ClusterSize
Cluster scaling parameters
| Name | Description | Schema |
|---|---|---|
coresPerNode |
The number of CPU Cores per node (will be truncated to the nearest integer). |
number (double) |
enabled |
Flag to signal whether this ClusterSize is enabled |
boolean |
heapSize |
The heap size |
number (double) |
memoryLimit |
The memory limit (will be truncated to the nearest integer). |
number (double) |
name |
The name of this Cluster Size |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
text |
The text (i.e., the human readable name) for this Cluster Size |
string |
ConfiguredAlert
An alert configuration that specifies a configured frequency with lower and/or upper thresholds
| Name | Description | Schema |
|---|---|---|
frequencyTolerance |
The configured alert frequency tolerance for the KPI |
|
thresholdLessThan |
The optional lessThan threshold that should trigger an alert |
|
thresholdMoreThan |
The optional moreThan threshold that should trigger an alert; at least one of thresholdMoreThan and thresholdLessThan is required |
ConfiguredAlertFrequencyTolerance
An alert configuration frequency tolerance for measuring an amount of time and unit for alert triggering
| Name | Description | Schema |
|---|---|---|
unit |
The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated |
|
value |
The amount of time, associated with the given unit, a metric value can persist outside its boundaries before an alert is generated |
number (double) |
ConfiguredAlertThreshold
A configured alert threshold to pair together a statistical unit and value
| Name | Description | Schema |
|---|---|---|
unitId |
The identifier of the alert threshold unit to associate with the given threshold value |
string |
value |
The threshold value whose triggering causes an alert |
number (double) |
ConfiguredKpi
An instantiated KPI specifying a metric on which to alert
| Name | Description | Schema |
|---|---|---|
alert |
The alert specification for the associated metric |
|
componentId |
The optional process group ID, processor ID, or connection ID. This is a composite ID containing a chain of process group IDs representing the component’s full ancestry |
string |
id |
The id of the KPI; used only when viewing and editing existing KPIs |
string |
metricComponentType |
The component type of the associated metric |
enum (SYSTEM, NIFI_FLOW, NIFI_PROCESSOR, NIFI_PROCESS_GROUP, NIFI_CONNECTION) |
metricId |
The id of the associated metric |
string |
CreateAssetUpdateRequestRequest
Request object for creating an asset update request
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
CreateAssetUpdateRequestResponse
Response object for creating an asset update request
| Name | Description | Schema |
|---|---|---|
assetUpdateRequestCrn |
The CRN of the created asset update request |
string |
CreateCustomNarConfigurationRequest
Request object for creating a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
environmentCrn |
The CRN of an environment to execute the command. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
CreateCustomNarConfigurationResponse
Response for creating a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom resource configuration to update. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
CreateDeploymentRequest
Request object to create a deployment.
| Name | Description | Schema |
|---|---|---|
autoScaleMaxNodes |
The maximum number of nodes that the cluster should scale to. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScaleMinNodes |
The minimum number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScalingEnabled |
Specifies that auto-scaling should be enabled. |
boolean |
autoStartFlow |
Indicates whether or not the flow should be started during deployment creation |
boolean |
cfmNifiVersion |
The CFM NiFi version associated with the deployment |
string |
clusterSizeName |
The size of the cluster to deploy. Deprecated. Use 'clusterSize.name' instead |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
configurationVersion |
The version of this configuration. |
integer (int32) |
customNarConfigurationCrn |
The CRN of the custom NAR configuration. |
string |
deploymentRequestCrn |
The CRN of the deployment request. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
flowMetricsScalingEnabled |
Specifies that Flow metrics should be enabled for scaling. |
boolean |
inboundHostname |
The FQDN of inbound hostname or just the prefix part |
string |
kpis |
The list of configured KPIs. |
< ConfiguredKpi > array |
listenComponents |
Listen components port and protocol data |
< ListenComponent > array |
name |
The name of the deployment |
string |
nodeStorageProfileName |
Node storage profile name |
enum (STANDARD_AWS, STANDARD_AZURE, PERFORMANCE_AWS, PERFORMANCE_AZURE, LOCAL_K8S) |
parameterGroups |
The list of flow parameter groups. |
< FlowParameterGroup > array |
projectCrn |
The CRN of the project. |
string |
staticNodeCount |
The static number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is false. |
integer (int32) |
CreateDeploymentResponse
Response object from creating a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
CreateInboundConnectionEndpointRequest
Request object that contains FQDN for the Inbound Connection Endpoint to create
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of an environment to execute the command. |
string |
hostname |
Fully qualified domain name |
string |
projectCrn |
The project CRN to associate this endpoint with, or null to not associate with a project |
string |
CreateInboundConnectionEndpointResponse
Response object returned during Inbound Connection Endpoint creation
| Name | Description | Schema |
|---|---|---|
inboundConnectionEndpointSummary |
Data that describes the Inbound Connection Endpoint. |
CreateReportingTaskRequest
Request object for creating a reporting task
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The CRN of the deployment. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
filePath |
The full local path to the file containing the reporting task definition |
string |
CreateReportingTaskResponse
Response for creating a reporting task.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the created reporting task. |
string |
DeleteCustomNarConfigurationRequest
Request object for deleting a custom NAR configuration by CRN.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
customNarConfigurationCrn |
The CRN of the custom NAR configuration to delete. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
DeleteCustomNarConfigurationResponse
Response object for deleting a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom resource configuration to update. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
DeleteInboundConnectionEndpointRequest
Request object that contains the identifier of the Inbound Connection Endpoint to delete
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
DeleteInboundConnectionEndpointResponse
Response object returned during deletion of an Inbound Connection Endpoint
Type : object
DeleteReportingTaskRequest
Request object for deleting a reporting task
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The CRN of the deployment. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
reportingTaskCrn |
The CRN of the reporting task |
string |
DeleteReportingTaskResponse
Response for deleting a reporting task.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the deleted reporting task. |
string |
DeploymentStatus
The state and state message associated with a deployment
| Name | Description | Schema |
|---|---|---|
detailedState |
The detailed state that the deployment is currently in |
enum (GOOD_HEALTH, FAILED_TO_STOP_FLOW, FAILED_TO_UPDATE_NIFI_VERSION, FAILED_TO_START_FLOW, FAILED_TO_RESTART, FLOW_STOPPED, FAILED_TO_DEPLOY, FAILED_TO_IMPORT, FAILED_TO_UPDATE, FAILED_TO_TERMINATE, NEW, CREATING_NODES, DEPLOYING_ASSETS, DEPLOYING_FLOW_DEFINITION, IMPORTING_FLOW, STARTING_FLOW, STOPPING_FLOW, UPDATING, UPDATING_NIFI_VERSION, CANCELLING_NIFI_VERSION_UPDATE, RESTARTING, SUSPENDING, RESUMING, SUSPENDED, FAILED_TO_SUSPEND, FAILED_TO_RESUME, TERMINATING, CANCEL_REQUESTED, STOPPED, UNKNOWN, UPGRADING, FAILED_TO_UPGRADE, ROLLING_BACK, KPI_OUT_OF_RANGE, CANNOT_AUTOSCALE, DEPLOYMENT_DISCONNECTED, UNUSED_LOGICAL_BAD_HEALTH, AT_CAPACITY, SDX_OUTPUT_CHANGED, METRICS_UNAVAILABLE, METERING_WARNING, METERING_OFFLINE, CERTIFICATE_RENEWED, NOT_HEALTHY, EXCESSIVE_OFFLOAD_TIME, NIFI_BULLETIN_WARNING, FAILED_TO_START, SUSPENDING_FLOW) |
message |
Detail message relating to the current status of the deployment |
string |
state |
The state that the deployment is currently in |
enum (DEPLOYING, GOOD_HEALTH, CONCERNING_HEALTH, BAD_HEALTH, IMPORTING_FLOW, STARTING_FLOW, STOPPING_FLOW, FLOW_STOPPED, UPDATING, TERMINATING, RESTARTING, SUSPENDING, RESUMING, SUSPENDED, UPGRADING, ROLLING_BACK, STOPPED, UNKNOWN, SUSPENDING_FLOW) |
DescribeInboundConnectionEndpointRequest
Request object that contains the identifier of the Inbound Connection Endpoint to describe
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
DescribeInboundConnectionEndpointResponse
Response object that describes an Inbound Connection Endpoint
| Name | Description | Schema |
|---|---|---|
inboundConnectionEndpointSummary |
Data that describes the Inbound Connection Endpoint. |
EnvCloudRegion
A cloud region
| Name | Description | Schema |
|---|---|---|
displayName |
Display-friendly name of the cloud region |
string |
name |
Name of the cloud region |
string |
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
ExportDeploymentRequest
Request object to export deployment configuration.
| Name | Description | Schema |
|---|---|---|
archiveDescription |
The description about deployment configuration export archive |
string |
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
ExportDeploymentResponse
Response object for exporting a deployment.
| Name | Description | Schema |
|---|---|---|
archiveName |
The exported deployment configuration archive name . |
string |
FlowParameter
A flow parameter
| Name | Description | Schema |
|---|---|---|
assetReferences |
The list of referenced assets. |
< AssetReference > array |
description |
The description of the param |
string |
name |
The name of the parameter |
string |
sensitive |
Whether or not the parameter value is sensitive |
boolean |
type |
The type of parameter. Possibly TEXT, FILE, FILES, DIRECTORY |
enum (TEXT, FILE, FILES) |
value |
The value of the parameter |
string |
valueSet |
Indicates if the value of this parameter is set (i.e. not null) |
boolean |
FlowParameterGroup
A flow parameter group
| Name | Description | Schema |
|---|---|---|
name |
The name of the parameter group |
string |
parameters |
The parameters in the group |
< FlowParameter > array |
GetCustomNarConfigurationRequest
Request object for retrieving a custom NAR configuration by CRN.
| Name | Description | Schema |
|---|---|---|
customNarConfigurationCrn |
The CRN of the custom NAR configuration to retrieve. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
GetCustomNarConfigurationResponse
Response object for retrieving a custom NAR configuration by CRN.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom resource configuration to update. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
GetDefaultCustomNarConfigurationRequest
Request object for retrieving the default custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of an environment to execute the command. |
string |
GetDefaultCustomNarConfigurationResponse
Response object for retrieving the default custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom resource configuration to update. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
GetDeploymentConfigurationMetadataRequest
Request object for retrieving deployment configuration metadata.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
GetDeploymentConfigurationMetadataResponse
Response object for retrieving deployment configuration metadata request.
| Name | Description | Schema |
|---|---|---|
deploymentConfigurationMetadata |
The deployment configuration metadata. |
GetDeploymentConfigurationRequest
Request object for retrieving deployment configuration.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
GetDeploymentConfigurationResponse
Response object for retrieving deployment configuration request.
| Name | Description | Schema |
|---|---|---|
deploymentConfiguration |
The deployment configuration. |
GetDeploymentRequestDetailsRequest
Request object for retrieving deployment request details.
| Name | Description | Schema |
|---|---|---|
deploymentRequestCrn |
The deployment request crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
GetDeploymentRequestDetailsResponse
Response object for retrieving deployment request details request.
| Name | Description | Schema |
|---|---|---|
deploymentConfigurationMetadata |
The deployment configuration metadata. |
ImportDeploymentRequest
Request object to import deployment configuration.
| Name | Description | Schema |
|---|---|---|
archiveName |
Search term to filter exported archives by deployment name. |
string |
deploymentRequestCrn |
The CRN of the deployment request. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
ImportDeploymentResponse
Response object for importing deployment configuration.
| Name | Description | Schema |
|---|---|---|
rpcImportedDeploymentConfiguration |
The imported deployment configuration. |
InboundConnectionEndpointCertificateSummary
Inbound Connection Endpoint Certificate Summary
| Name | Description | Schema |
|---|---|---|
certificateType |
The type of the Inbound Connection Endpoint Certificate |
enum (CLIENT_ENTITY, CLIENT_CA, SERVER_ENTITY) |
expiration |
The timestamp of when the Inbound Connection Endpoint Certificate expires |
integer (int64) |
state |
The state of the Inbound Connection Endpoint Certificate |
enum (PROVISIONING, CURRENT, EXPIRED, RENEWING, RENEWAL_FAILED) |
statusMessage |
The status message of the Inbound Connection Endpoint Certificate |
string |
InboundConnectionEndpointClientCertificateRequest
Request object to retrieve Inbound Connection Endpoint client’s certificate.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
InboundConnectionEndpointClientCertificateResponse
Response object that contains the client’s certificate.
| Name | Description | Schema |
|---|---|---|
certificate |
The client’s encoded certificate. |
string |
InboundConnectionEndpointClientCertificatesRequest
Request object to retrieve Inbound Connection Endpoint client’s certificates.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
InboundConnectionEndpointClientPrivateKeyRequest
Request object to retrieve Inbound Connection Endpoint client’s private key.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
InboundConnectionEndpointClientPrivateKeyResponse
Response object that contains the client’s private key.
| Name | Description | Schema |
|---|---|---|
privateKey |
The client’s encoded private key. |
string |
InboundConnectionEndpointSummary
Inbound Connection Endpoint Summary
| Name | Description | Schema |
|---|---|---|
certificateSummaries |
The summaries of certificates associated with the Inbound Connection Endpoint |
|
crn |
The CRN of the Inbound Connection Endpoint |
string |
deploymentCrn |
The CRN of the deployment the hostname is assigned to |
string |
fullyQualifiedDomainName |
The FQDN of the inbound connection hostname |
string |
projectCrn |
The CRN of the project. |
string |
state |
State of the Inbound Connection Endpoint |
enum (UNASSIGNED, ASSIGNED, PROVISIONING_CERTIFICATES, RENEWING_CERTIFICATES, READY, FAILED) |
KpiContextGroup
Captures the use of a KPI in the context of a process group
| Name | Description | Schema |
|---|---|---|
id |
The id of the containing process group |
string |
name |
The name of the containing process group |
string |
scopeComponents |
The scope components of the group |
< KpiScopeComponent > array |
KpiMetaData
A template for instantiating KPIs
| Name | Description | Schema |
|---|---|---|
alertFrequencyTolerance |
The alert frequency tolerance shared by all metrics. |
|
kpiScopes |
The KPI scope meta data list, one per MetricComponentType. |
< KpiScopeMetaData > array |
unitTypes |
The entire tree of legal unit types for all metrics. |
< string, < KpiUnit > array > map |
KpiScopeComponent
Provides scoping when defining KPIs
| Name | Description | Schema |
|---|---|---|
id |
The internal id of the scope, for example the connection ID |
string |
name |
The child name to show in the hierarchical chooser |
string |
KpiScopeMetaData
Provides scoping meta data for use during KPI creation
| Name | Description | Schema |
|---|---|---|
contextGroups |
The context identifiers for the chosen scope type |
< KpiContextGroup > array |
contextLabel |
The label to use for the context identifier, which depends on scope type. |
string |
label |
The label to use for the chosen scope type |
string |
metricTypes |
The available metric types for the chosen scope type |
< KpiScopeMetricType > array |
type |
The type of the scope |
enum (SYSTEM, NIFI_FLOW, NIFI_PROCESSOR, NIFI_PROCESS_GROUP, NIFI_CONNECTION) |
KpiScopeMetricType
Provides the legal metric types for an owning scope
| Name | Description | Schema |
|---|---|---|
defaultUnitId |
The default unitId for this metric |
string |
description |
The user-visible description of the metric type |
string |
id |
The internal id of the metric type |
string |
label |
The user-visible label of the metric type |
string |
unitTypeKey |
The unit type key for this metric |
enum (DURATION, RATIO, SIZE, RATE, COUNT) |
KpiUnit
Captures the legal units for a metric, a means to avoid large numbers either before or after a decimal point
| Name | Description | Schema |
|---|---|---|
factor |
The conversion factor to use to normalize values with this unit into a common unit |
integer (int64) |
id |
The internal ID of the unit |
string |
label |
The user-visible label of the unit |
string |
ListDeploymentArchivesRequest
Request object to list exported archives of all deployments matching the search term.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of an environment to execute the command. |
string |
searchTerm |
Search term to filter exported archives by deployment name. |
string |
ListDeploymentArchivesResponse
Response for listing the deployment configuration backup archives.
| Name | Description | Schema |
|---|---|---|
archives |
The deployment configuration exported archives. |
< RpcDeploymentArchiveMetadata > array |
ListInboundConnectionEndpointsRequest
Request object to use to list Inbound Connection Endpoints
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of an environment to execute the command. |
string |
ListInboundConnectionEndpointsResponse
Response object that contains a list of Inbound Connection Endpoints
| Name | Description | Schema |
|---|---|---|
inboundConnectionEndpoints |
A list of Inbound Connection Endpoints. |
< InboundConnectionEndpointSummary > array |
ListNifiVersionsRequest
Request object for listing the supported NiFi versions.
| Name | Description | Schema |
|---|---|---|
environmentCrn |
The CRN of an environment to execute the command. |
string |
ListNifiVersionsResponse
Response object for listing the supported NiFi versions.
| Name | Description | Schema |
|---|---|---|
nifiVersions |
A list of supported NiFi versions. |
< string > array |
ListReportingTasksRequest
Request object for listing the reporting tasks for a deployment
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The CRN of the deployment. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
ListReportingTasksResponse
Response for listing the reporting tasks of a deployment.
| Name | Description | Schema |
|---|---|---|
reportingTasks |
The listed reporting tasks. |
< ReportingTaskSummary > array |
ListenComponent
Provides subset of metadata of a Listen* component
| Name | Description | Schema |
|---|---|---|
listenComponentType |
Listen component type |
enum (ListenHTTP, ListenFTP, ListenSyslog, ListenRELP, ListenTCP, ListenUDP, ListenTCPRecord, ListenUDPRecord, ListenGRPC, ListenSMTP, ListenBeats, ListenLumberjack, ListenWebSocket, HandleHttpRequest) |
port |
Inbound port |
string |
protocol |
Inbound protocol |
enum (TCP, UDP) |
NodeStorageProfileMetadata
Provides details about the node storage options.
| Name | Description | Schema |
|---|---|---|
contentRepoSize |
Content repository size |
integer (int32) |
flowfileRepoSize |
FlowFile repository size |
integer (int32) |
iops |
IOPS |
string |
name |
The name of this Storage Profile |
enum (LEGACY_STANDARD, LEGACY_PERFORMANCE, STANDARD_AWS, STANDARD_AZURE, PERFORMANCE_AWS, PERFORMANCE_AZURE, LOCAL_K8S) |
provenanceRepoSize |
Provenance repository size |
integer (int32) |
storageVolumeType |
Storage volume type |
string |
text |
The text (i.e., the human readable name) for this Storage Profile |
string |
throughput |
Throughput |
string |
ProjectMeta
The meta information about a project.
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the project |
string |
id |
The id of the project |
string |
name |
The name of the group |
string |
ReassignResourcesRequest
Request object to reassign resources.
| Name | Description | Schema |
|---|---|---|
destinationProjectCrn |
The crn of the project to reassign the resources to, or null to unassign the resources. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
workloadResourceSummaries |
The summaries of the resources being reassigned. |
< RpcWorkloadResourceSummary > array |
ReassignResourcesResponse
Response object from reassigning resources.
Type : object
RenewInboundConnectionEndpointCertificateRequest
Request object to renew Inbound Connection Endpoint certificate(s)
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the Inbound Connection Endpoint |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
renewClientCertificates |
Whether to renew Inbound Connection Endpoint’s client certificates |
boolean |
renewServerCertificate |
Whether to renew Inbound Connection Endpoint’s server certificate |
boolean |
revokeClientCertificates |
Whether to revoke existing Inbound Connection Endpoint’s client certificates |
boolean |
RenewInboundConnectionEndpointCertificateResponse
Response object for Inbound Connection Endpoint certificate renewal request
Type : object
ReportingTaskSummary
A reporting task summary
| Name | Description | Schema |
|---|---|---|
crn |
The CRN of the reporting task |
string |
identifier |
The component’s unique identifier |
string |
name |
The component’s name |
string |
type |
The type of the extension component |
string |
RestartDeploymentRequest
Request object to restart a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
forceStopFlow |
Whether to force stop the NiFi flow during restart. |
boolean |
RestartDeploymentResponse
Response object for restarting a deployment request.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
ResumeDeploymentRequest
Request object to resume a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
ResumeDeploymentResponse
Response object for resuming a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
RpcDeployment
Provides details about a deployment.
| Name | Description | Schema |
|---|---|---|
activeErrorAlertCount |
Current count of active alerts classified as an error |
integer (int64) |
activeInfoAlertCount |
Current count of active alerts classified as an info |
integer (int64) |
activeWarningAlertCount |
Current count of active alerts classified as a warning |
integer (int64) |
artifactTypeName |
The type of artifact of the flow |
string |
autoscaleMaxNodes |
The maximum number of nodes that the deployment can scale up to; can only be used when autoscalingEnabled is true |
integer (int32) |
autoscaleMinNodes |
The minimum number of nodes that the deployment will allocate; can only be used when autoscalingEnabled is true |
integer (int32) |
autoscalingEnabled |
Whether or not autoscaling is enabled for this deployment |
boolean |
cfmNifiVersion |
The CFM NiFi version associated with the deployment |
string |
clusterSize |
The initial size of the deployment. Deprecated. Use 'clusterSizeParams.name' instead |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
configurationVersion |
The current version of the deployment’s configuration |
integer (int32) |
coresPerNode |
The number of cores per node for the deployment. Deprecated. Use 'clusterSizeParams.coresPerNode' instead |
integer (int32) |
created |
Timestamp of the creation of the deployment |
integer (int64) |
creatorCrn |
The CRN of the user who deployed the flow |
string |
crn |
The CRN of the deployment |
string |
currentNodeCount |
The current node count |
integer (int32) |
customNarConfigurationId |
The identifier of the custom NAR configuration, if used. |
string |
deployedByName |
The name of the person who deployed the flow |
string |
deployedByUsername |
The username of the person who deployed the flow |
string |
dfxLocalUrl |
Base URL to the CDF Local instance running this deployment |
string |
flowCrn |
The deployment’s current flow CRN |
string |
flowDesignerId |
The ID of the flow design for a test session deployment. |
string |
flowMetricsScalingEnabled |
Whether or not flow metrics scaling is enabled for this deployment |
boolean |
flowName |
The name of the flow |
string |
flowVersion |
The version of the flow |
integer (int32) |
flowVersionCrn |
The deployment’s current flow version CRN |
string |
heapSize |
The heap size for the deployment. Deprecated. Use 'clusterSizeParams.heapSize' instead |
number (double) |
inboundConnectionEndpointId |
The ID of Inbound Connection Endpoint assigned to the deployment |
string |
lastUpdatedByUsername |
The username of the last person to update the deployment |
string |
memoryLimit |
The memory limit of the deployment. Deprecated. Use 'clusterSizeParams.memoryLimit' instead |
number (double) |
name |
The name of the deployment |
string |
nifiUrl |
The url to open the deployed flow in NiFi |
string |
nodeStorageProfile |
The node storage profile |
string |
project |
Simple information about the project this deployment belongs to, or null if does not belong to a project |
|
projectCrn |
The crn of the project this deployment belongs to, or null if does not belong to a project |
string |
service |
Simple information about the DataFlow service of the deployment |
|
staticNodeCount |
The static number of nodes of the deployment; can only be used when autoscalingEnabled is false |
integer (int32) |
status |
The status of the deployment |
|
testSession |
Indicates this deployment was created as a test session for designing a flow |
boolean |
updated |
Timestamp of the last time the deployment was modified |
integer (int64) |
validActions |
Valid actions that can be applied to the deployment in its current state |
< enum (VIEW_NIFI, START_FLOW, STOP_FLOW, EDIT, CANCEL_CREATE, TERMINATE, VIEW_METRICS, UPDATE_NIFI_VERSION, CANCEL_NIFI_VERSION_UPDATE, RESTART_DEPLOYMENT, MANAGE_DEPLOYMENT, EXPORT, SUSPEND, RESUME, DOWNLOAD_LOG, SUSPEND_FLOW) > array |
RpcDeploymentArchiveMetadata
Provides the metadata about deployment exported archive
| Name | Description | Schema |
|---|---|---|
archiveDescription |
The description provided during deployment configuration export |
string |
archiveName |
The name of the exported deployment archive |
string |
deploymentName |
The name of the deployment |
string |
flowName |
The name of the flow |
string |
modifiedTime |
The time when the deployment archive is created or modified |
integer (int64) |
projectCrn |
The CRN of the project that exported deployment is assigned to. |
string |
uploadTime |
The time when the deployment archive is uploaded to cloud |
integer (int64) |
workloadVersion |
The version of workload when deployment configuration is exported. |
string |
RpcDeploymentConfiguration
Provides all of the configuration that dictates how a flow should be deployed.
| Name | Description | Schema |
|---|---|---|
autoScaleMaxNodes |
The maximum number of nodes that the cluster should scale to. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScaleMinNodes |
The minimum number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScalingEnabled |
Specifies that auto-scaling should be enabled. |
boolean |
autoStartFlow |
Indicates whether or not the flow should be started during deployment creation. |
boolean |
cfmNifiVersion |
The CFM NiFi version associated with the deployment. |
string |
clusterSizeName |
The size of the cluster to deploy. |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
configurationVersion |
The version of this configuration. |
integer (int32) |
deploymentCrn |
The CRN of the deployment. |
string |
deploymentId |
The id of the deployment. |
string |
flowMetricsScalingEnabled |
Specifies that Flow metrics should be enabled for scaling. |
boolean |
inboundHostname |
The inbound hostname. |
string |
kpis |
The list of configured KPIs. |
< ConfiguredKpi > array |
kpisDirty |
Indicates whether or not the current KPIs have successfully been deployed as alert rules. |
boolean |
lastUpdatedByUsername |
The username of the last person to update the deployment configuration. |
string |
listenComponents |
Listen components port and protocol data. |
< ListenComponent > array |
name |
The name of the deployment |
string |
nodeStorageProfileName |
Node storage profile name. |
enum (LEGACY_STANDARD, LEGACY_PERFORMANCE, STANDARD_AWS, STANDARD_AZURE, PERFORMANCE_AWS, PERFORMANCE_AZURE, LOCAL_K8S) |
parameterGroups |
The list of flow parameter groups. |
< FlowParameterGroup > array |
parametersDirty |
Indicates whether or not all current parameter values have successfully been applied to NiFi. |
boolean |
projectCrn |
The crn of the project this deployment belongs to, or null if does not belong to a project. |
string |
sizingAndScalingDirty |
Indicates whether or not the current sizing and scaling configuration has been successfully applied in Kubernetes. |
boolean |
staticNodeCount |
The static number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is false. |
integer (int32) |
RpcDeploymentConfigurationMetadata
Provides details about the deployment and all of the different configuration items that are available.
| Name | Description | Schema |
|---|---|---|
artifactTypeName |
The type of the artifact of the flow. |
string |
clusterSizingOptions |
The options that are available for determining the size of the deployed cluster |
< ClusterSize > array |
flowCrn |
The CRN of the flow to deploy |
string |
flowName |
The name of the flow to deploy |
string |
flowVersion |
The version of the flow to deploy |
integer (int32) |
flowVersionCrn |
The CRN for the flow version |
string |
kpiMetaData |
The KPI meta data |
|
nodeStorageProfileMetadata |
The list of node storage profiles |
< NodeStorageProfileMetadata > array |
parameterGroups |
The list of flow parameter groups |
< FlowParameterGroup > array |
requiresEnvironmentSslContextService |
A flag indicating if the flow requires an Environment specific SSLContextService |
boolean |
service |
Simple information about the DataFlow service of the deployment |
RpcImportedDeploymentConfiguration
Contains the configuration data imported from exported archive.
| Name | Description | Schema |
|---|---|---|
autoScaleMaxNodes |
The cluster’s maximum number of nodes value retrieved from archive. |
integer (int32) |
autoScaleMinNodes |
The cluster’s minimum number of nodes value retrieved from archive. |
integer (int32) |
autoScalingEnabled |
The auto-scaling flag value retrieved from archive. |
boolean |
cfmNifiVersion |
The CFM NiFi version retrieved from archive. |
string |
clusterSizeName |
The cluster size name retrieved from archive. |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
customNarConfigurationCrn |
The CRN of the custom NAR configuration. |
string |
flowMetricsScalingEnabled |
The flow-metrics flag value retrieved from archive. |
boolean |
flowParameterGroups |
The flow parameter groups with values imported from archive. |
< FlowParameterGroup > array |
inboundHostName |
The FQDN of inbound hostname constructed with prefix imported from archive. |
string |
kpis |
The list of configured KPIs imported from archive. |
< ConfiguredKpi > array |
listenComponents |
The concatenated list of Nifi listen components imported from archive and flow. |
< ListenComponent > array |
nodeStorageProfile |
The node storage profile imported from archive. |
string |
projectCrn |
The project CRN retrieved from backup. |
string |
staticNodeCount |
The cluster’s static node count retrieved from archive. |
integer (int32) |
RpcWorkloadResourceSummary
Provides a summary of the workload resource.
| Name | Description | Schema |
|---|---|---|
projectCrn |
The project crn that the resource is assigned to. Should be null if resource is not assigned to a project. |
string |
resourceCrn |
The crn of the workload resource. |
string |
ServiceMeta
The meta information about a DataFlow service.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The cloudPlatform flag of the DataFlow service |
enum (AWS, AZURE, YARN, YCLOUD, GCP, OPENSTACK, LOCAL_K8S, MOCK) |
crn |
The CRN of the DataFlow service |
string |
environmentCrn |
Crn of associated CDP environment |
string |
name |
The name of the DataFlow service |
string |
region |
The region of the DataFlow service |
StartFlowRequest
Request object for starting the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
StartFlowResponse
Response object for starting the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
StopFlowRequest
Request object for stopping the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
StopFlowResponse
Response object for stopping the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
SuspendDeploymentRequest
Request object to suspend a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
SuspendDeploymentResponse
Response object for suspending a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
TerminateDeploymentRequest
Request object to terminate a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
TerminateDeploymentResponse
Response object for terminating a deployment request.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
TransitionFlowRequest
Request object for transitioning the state of the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
flowState |
The desired state of the NiFi flow |
enum (STARTED, SUSPENDED, STOPPED) |
TransitionFlowResponse
Response object for transitioning the state of the NiFi flow.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
UpdateCustomNarConfigurationRequest
Request object to update a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom NAR configuration to update. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
UpdateCustomNarConfigurationResponse
Response object for updating a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
crn |
The CRN of the custom resource configuration to update. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
UpdateDeploymentRequest
Provides all of the configuration that dictates how a flow should be deployed
| Name | Description | Schema |
|---|---|---|
assetUpdateRequestCrn |
The CRN of the asset update request. Required when updating assets of an existing deployment. |
string |
autoScaleMaxNodes |
The maximum number of nodes that the cluster should scale to. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScaleMinNodes |
The minimum number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is true. |
integer (int32) |
autoScalingEnabled |
Specifies that auto-scaling should be enabled. |
boolean |
clusterSizeName |
The deployment t-shirt size. Deprecated. Use 'clusterSize.name' instead |
enum (EXTRA_SMALL, SMALL, MEDIUM, LARGE) |
configurationVersion |
The version of this configuration. |
integer (int32) |
deploymentCrn |
The CRN of the existing deployment to be updated. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
flowMetricsScalingEnabled |
Specifies that Flow metrics should be enabled for scaling. |
boolean |
kpis |
The list of configured KPIs. |
< ConfiguredKpi > array |
parameterGroups |
The list of flow parameter groups. |
< FlowParameterGroup > array |
staticNodeCount |
The static number of nodes that the cluster should allocate. May only be specified when autoScalingEnabled is false. |
integer (int32) |
UpdateDeploymentResponse
Response object from updating a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentConfiguration |
The deployment configuration. |
UpdateNifiVersionRequest
Request object for updating the NiFi version of a deployment.
| Name | Description | Schema |
|---|---|---|
cfmNifiVersion |
The NiFi version to which to update the deployment. |
string |
deploymentCrn |
The deployment crn. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
UpdateNifiVersionResponse
Response object for updating the NiFi version of a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
UploadAssetRequest
Request object for uploading an asset
| Name | Description | Schema |
|---|---|---|
assetUpdateRequestCrn |
The CRN of the asset update request. Required when updating assets of an existing deployment. |
string |
deploymentName |
The name of the deployment. Required during initial deployment. |
string |
deploymentRequestCrn |
The CRN of the deployment request. Required during initial deployment. |
string |
environmentCrn |
The CRN of an environment to execute the command. |
string |
filePath |
The full local path to the file being uploaded |
string |
parameterGroup |
The name of the parameter group |
string |
parameterName |
The name of the parameter within the parameter group |
string |
UploadAssetResponse
Response for uploading an asset.
Type : object
ValidateCustomNarConfigurationRequest
Request object for validating a custom NAR configuration.
| Name | Description | Schema |
|---|---|---|
configurationVersion |
The version of the configuration |
integer (int32) |
environmentCrn |
The CRN of an environment to execute the command. |
string |
password |
The password used to access the storage location |
string |
projectCrn |
The CRN of the project. |
string |
storageLocation |
The storage location, such as an S3 bucket or ADLS container |
string |
username |
The username used to access the storage location |
string |
ValidateCustomNarConfigurationResponse
Response object for validating custom NAR configuration.
Type : object