Overview
Manage DataFlow Services.
Version information
Version : 0.9.157 (BETA)
License information
License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
Add ready flow.
POST /api/v1/df/addReadyflow
Description
Adds the specified ready flow into this account.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Assign a flow definition to collection.
POST /api/v1/df/assignToCollection
Description
Assign a flow definition to a catalog collection.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Cancels deletion of a Project.
POST /api/v1/df/cancelDeleteProject
Description
Cancels deletion of a Project.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create catalog collection.
POST /api/v1/df/createCollection
Description
Create a collection in the catalog
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Create flow version tag.
POST /api/v1/df/createFlowVersionTag
Description
Creates a new tag for the specified flow version
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Creates a Project.
POST /api/v1/df/createProject
Description
Creates a Project.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete added ready flow.
POST /api/v1/df/deleteAddedReadyflow
Description
Deletes the specified added ready flow from this account.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete catalog collection.
POST /api/v1/df/deleteCollection
Description
Delete an empty collection in the catalog
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete flow.
POST /api/v1/df/deleteFlow
Description
Deletes the specified flow.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Delete flow version tag.
POST /api/v1/df/deleteFlowVersionTag
Description
Deletes the specified flow version tag.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Deletes a Project.
POST /api/v1/df/deleteProject
Description
Deletes a Project.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe added ready flow detail.
POST /api/v1/df/describeAddedReadyflow
Description
Gets the details for the specified ready flow as added by the current account.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe catalog collection.
POST /api/v1/df/describeCollection
Description
Describe a collection in the catalog
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe deployment.
POST /api/v1/df/describeDeployment
Description
Describes a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe event detail for deployment.
POST /api/v1/df/describeDeploymentEventDetail
Description
Describes event detail for deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe flow.
POST /api/v1/df/describeFlow
Description
Gets the details for the specified flow.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe flow event detail in a deployment.
POST /api/v1/df/describeFlowEventDetailInDeployment
Description
Describes flow event detail in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe flow in a deployment.
POST /api/v1/df/describeFlowInDeployment
Description
Describes a flow in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describes a Project.
POST /api/v1/df/describeProject
Description
Describes a Project
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe ready flow.
POST /api/v1/df/describeReadyflow
Description
Gets the details for the specified ready flow.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe service.
POST /api/v1/df/describeService
Description
Describes service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Describe event history detail for service.
POST /api/v1/df/describeServiceEventDetail
Description
Describe event history detail for service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Disable service.
POST /api/v1/df/disableService
Description
Disable service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Enable DataFlow service from a CDP environment.
POST /api/v1/df/enableService
Description
Enable DataFlow service from a CDP environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get flow version.
POST /api/v1/df/getFlowVersion
Description
Downloads the Flow Definition for the specified Flow Version.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Get Kubeconfig.
POST /api/v1/df/getKubeconfig
Description
Gets kubernetes configuration for the environment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Grant remote user access to the service’s cluster.
POST /api/v1/df/grantUserKubernetesAccess
Description
Grants remote user access to the service’s cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Import a new flow definition.
POST /api/v1/df/importFlowDefinition
Description
Import a new flow definition.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Import a new flow definition version to an existing flow.
POST /api/v1/df/importFlowDefinitionVersion
Description
Import a new flow definition version to an existing flow.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Initiate a deployment creation.
POST /api/v1/df/initiateDeployment
Description
Initiates a deployment creation. Intended for internal use, use create-deployment instead.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Initiate the flow creation process in a deployment.
POST /api/v1/df/initiateFlowInDeployment
Description
Initiates the flow creation process in a deployment. Intended for internal use, use add-flow-to-deployment instead.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List catalog collections.
POST /api/v1/df/listCollections
Description
Lists the collections in the catalog
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List services that a DataFlow Admin can deploy to.
POST /api/v1/df/listDeployableServicesForNewDeployments
Description
List services that a DataFlow Admin can deploy to.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List active alerts for deployment.
POST /api/v1/df/listDeploymentActiveAlerts
Description
List active alerts for deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List event history for deployment.
POST /api/v1/df/listDeploymentEvents
Description
Lists event history for deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List deployment KPIs.
POST /api/v1/df/listDeploymentKPIs
Description
Lists deployment KPIs.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List deployment System metrics.
POST /api/v1/df/listDeploymentSystemMetrics
Description
Lists deployment System metrics.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List deployments.
POST /api/v1/df/listDeployments
Description
Lists deployments.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List diagnostics.
POST /api/v1/df/listDiagnostics
Description
List diagnostics requests.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List filter options.
POST /api/v1/df/listFilterOptions
Description
Lists filter options.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List active alerts for a flow in a deployment.
POST /api/v1/df/listFlowActiveAlertsInDeployment
Description
Lists active alerts for a flow in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List flow definition versions.
POST /api/v1/df/listFlowDefinitionVersions
Description
Lists flow definition versions for a flow
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List flow definitions.
POST /api/v1/df/listFlowDefinitions
Description
Lists flow definitions.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List event history for a flow in a deployment.
POST /api/v1/df/listFlowEventsInDeployment
Description
Lists flow event history in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List KPI metrics for a flow in a deployment.
POST /api/v1/df/listFlowKpisInDeployment
Description
Lists flow KPI charts in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List flow version tags.
POST /api/v1/df/listFlowVersionTags
Description
Lists tags for the specified flow version
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List flows in a deployment.
POST /api/v1/df/listFlowsInDeployment
Description
Lists flows in a deployment.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List notifications.
POST /api/v1/df/listNotifications
Description
Lists notifications.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List filter options.
POST /api/v1/df/listProjectFilterOptions
Description
Lists filter options to be used with ListProjects.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List Projects.
POST /api/v1/df/listProjects
Description
Lists Projects.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List ready flows.
POST /api/v1/df/listReadyflows
Description
Lists ready flows.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List active alerts for service.
POST /api/v1/df/listServiceActiveAlerts
Description
List active alerts for service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List events for service.
POST /api/v1/df/listServiceEvents
Description
List events for service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List service System metrics.
POST /api/v1/df/listServiceSystemMetrics
Description
List service System metrics.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List services.
POST /api/v1/df/listServices
Description
Lists services.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
List users that have access to the service’s cluster.
POST /api/v1/df/listUserKubernetesAccess
Description
List users that have access to the service’s cluster
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Renew workload UI certificates.
POST /api/v1/df/renewCertificates
Description
Renew workload UI certificates.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Resets all references to a service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.
POST /api/v1/df/resetService
Description
Resets the service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Revoke access for the remote user from the service’s cluster.
POST /api/v1/df/revokeUserKubernetesAccess
Description
Revokes access for the remote user from the service’s cluster.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Rotate password.
POST /api/v1/df/rotatePassword
Description
Rotate database server root password.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Start diagnostics collection.
POST /api/v1/df/startGetDiagnosticsCollection
Description
Start diagnostics bundle creation and upload.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update a collection’s details.
POST /api/v1/df/updateCollection
Description
Updates a collection’s metadata.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update cloud provider node images.
POST /api/v1/df/updateNodeImages
Description
Updates the nodes images that the DataFlow service is running on to their latest version. The service will be unavailable for it’s duration.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Updates a Project.
POST /api/v1/df/updateProject
Description
Updates a Project
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Update service.
POST /api/v1/df/updateService
Description
Update service.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Upgrade service.
POST /api/v1/df/upgradeService
Description
Upgrade an enabled DataFlow service to the latest version.
Parameters
| Type | Name | Schema |
|---|---|---|
Body |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Definitions
AddReadyflowRequest
Request object for the AddReadyflow method
| Name | Description | Schema |
|---|---|---|
readyflowCrn |
The ready flow CRN |
string |
AddReadyflowResponse
Response object for the AddReadyflow method
| Name | Description | Schema |
|---|---|---|
addedReadyflowDetail |
The added ready flow detail |
AddedReadyflowDetails
A detailed representation of a ready flow as added by the current account
| Name | Description | Schema |
|---|---|---|
addedReadyflowCrn |
The added ready flow crn |
string |
readyflow |
The ready flow name |
|
versions |
The ready flow versions |
< ArtifactVersion > array |
AlertCondition
Alert condition
| Name | Description | Schema |
|---|---|---|
alertOperator |
Operator for the condition |
string |
id |
Id of the alert condition |
string |
unit |
unit of measurement for the value |
|
value |
Value used to for evaluation of this condition |
number (double) |
AlertFrequencyUnit
Alert frequency unit
| Name | Description | Schema |
|---|---|---|
abbreviation |
Abbreviation used for this unit |
string |
id |
Id of alert frequency unit |
string |
label |
Label of the unit |
string |
ArtifactVersion
A representation of a artifact detail version
| Name | Description | Schema |
|---|---|---|
author |
The author of the artifact |
string |
bucketIdentifier |
The bucketIdentifier of the artifact |
string |
comments |
Comments about the version |
string |
crn |
The artifact version CRN |
string |
deploymentCount |
The number of deployments of the artifactVersion |
integer (int32) |
draftCount |
The number of drafts associated with the version. |
integer (int32) |
timestamp |
The timestamp of the artifactVersion |
integer (int64) |
version |
The version of the artifactVersion |
integer (int32) |
AssignToCollectionRequest
Request object when assigning a flow to a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollectionCrn |
The catalog collection CRN. If omitted, the flow will be assigned to the UNASSIGNED catalog collection. |
string |
flowCrn |
The flow CRN. |
string |
AssignToCollectionResponse
Response object when assigning a flow to a catalog collection.
| Name | Description | Schema |
|---|---|---|
flowSummary |
The updated flow summary with the new collection. |
CancelDeleteProjectRequest
A request to cancel the deletion of a Project that is deleting
| Name | Description | Schema |
|---|---|---|
projectCrn |
The Project CRN. |
string |
projectRevision |
The Project revision |
integer (int32) |
CancelDeleteProjectResponse
A response to cancelling the deletion of a Project
Type : object
CatalogCollection
A catalog collection.
| Name | Description | Schema |
|---|---|---|
crn |
The catalog collection CRN. |
string |
description |
The description of the catalog collection. |
string |
flowCount |
The number of flow summaries in the catalog collection. |
integer (int32) |
flowSummaries |
The summaries of flows in the catalog collection. |
< FlowSummary > array |
name |
The name of the catalog collection. |
string |
CreateCollectionRequest
Request object when creating a catalog collection.
| Name | Description | Schema |
|---|---|---|
description |
The description of the catalog collection. |
string |
name |
The name of the catalog collection. |
string |
CreateCollectionResponse
Response object when creating a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollection |
Details of the catalog collection. |
CreateFlowVersionTagRequest
Request object for the CreateFlowVersionTag method.
| Name | Description | Schema |
|---|---|---|
flowVersionCrn |
The flow version CRN. |
string |
tagColor |
The color of the version tag (optional). |
string |
tagName |
The name of the version tag. |
string |
CreateFlowVersionTagResponse
Response object for the CreateVersionTag method.
| Name | Description | Schema |
|---|---|---|
flowVersionTag |
Flow version tag details. |
CreateProjectRequest
A request to create a Project
| Name | Description | Schema |
|---|---|---|
description |
The Project description. |
string |
name |
The Project name. |
string |
serviceCrn |
The service CRN. |
string |
CreateProjectResponse
A response to create a Project
| Name | Description | Schema |
|---|---|---|
project |
The Project |
DeleteAddedReadyflowRequest
Request object for the DeleteAddedReadyFlow method
| Name | Description | Schema |
|---|---|---|
addedReadyflowCrn |
The added ready flow CRN |
string |
DeleteAddedReadyflowResponse
Response object for the DeleteAddedReadyflow method
| Name | Description | Schema |
|---|---|---|
readyflowDetail |
The ready flow details |
DeleteCollectionRequest
Request object when deleting a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollectionCrn |
The catalog collection CRN. |
string |
DeleteCollectionResponse
Response object when deleting a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollection |
Details of the deleted catalog collection. |
DeleteFlowRequest
Request object for the DeleteFlow method
| Name | Description | Schema |
|---|---|---|
flowCrn |
The flow CRN |
string |
DeleteFlowResponse
Response object for the DeleteFlow method
| Name | Description | Schema |
|---|---|---|
flow |
The flow that was deleted |
DeleteFlowVersionTagRequest
Request object for the DeleteFlowVersionTag method.
| Name | Description | Schema |
|---|---|---|
flowVersionCrn |
The flow version CRN. |
string |
tagName |
The name of the tag. |
string |
DeleteFlowVersionTagResponse
Response object for the DeleteVersionTag method.
| Name | Description | Schema |
|---|---|---|
flowVersionTag |
Flow version tag details. |
DeleteProjectRequest
A request to delete a Project
| Name | Description | Schema |
|---|---|---|
projectCrn |
The Project CRN. |
string |
projectRevision |
The Project revision |
integer (int32) |
DeleteProjectResponse
A response to delete a Project
Type : object
DeployedFlow
A flow, potentially one of many, deployed inside a deployment.
| Name | Description | Schema |
|---|---|---|
activeErrorAlertCount |
Current count of active alerts classified as errors. |
integer (int64) |
activeInfoAlertCount |
Current count of active alerts classified as informational. |
integer (int64) |
activeWarningAlertCount |
Current count of active alerts classified as warnings. |
integer (int64) |
created |
Timestamp of the creation of the deployed flow. |
integer (int64) |
creatorCrn |
The CRN of the user who deployed the flow. |
string |
crn |
The deployed flow CRN. |
string |
deploymentCrn |
The CRN of the deployment that contains the flow. |
string |
deploymentName |
The parent deployment name. |
string |
flowCrn |
The CRN of the flow definition. |
string |
flowVersion |
The version of the flow. |
integer (int32) |
flowVersionCrn |
The deployed flow definition version CRN. |
string |
name |
The deployed flow name. |
string |
projectCrn |
The CRN of the project that the flow’s deployment belongs to. |
string |
status |
The deployed flow status. |
|
updated |
Timestamp of the last time the deployed flow was modified. |
integer (int64) |
DeployedFlowState
The state that the deployed flow is currently in. "DEPLOYING" indicates that the flow is in the process of being deployed. "GOOD_HEALTH" indicates that the flow is in good health. "CONCERNING_HEALTH" indicates that there is a concern with the health of the flow (e.g., a KPI threshold breach) "BAD_HEALTH" indicates that the flow is in bad health. "IMPORTING_FLOW" indicates that the flow definition is in process of being imported. "STARTING_FLOW" indicates that the flow is in process of being started. "STOPPING_FLOW" indicates that the flow is in process of being stopped. "FLOW_STOPPED" indicates that the flow is currently stopped. "CHANGING_FLOW_VERSION" indicates that the flow version is in process of being changed. "UPDATING" indicates that the flow configuration is currently being updated. "TERMINATING" indicates that the flow is currently being terminated. "UNKNOWN" indicates that the state is not currently known.
Type : enum (DEPLOYING, GOOD_HEALTH, CONCERNING_HEALTH, BAD_HEALTH, IMPORTING_FLOW, STARTING_FLOW, STOPPING_FLOW, FLOW_STOPPED, CHANGING_FLOW_VERSION, UPDATING, TERMINATING, UNKNOWN)
DeployedFlowStatus
The status of the flow being deployed.
| Name | Description | Schema |
|---|---|---|
detailedState |
The detailed state that the deployed flow is currently in. |
string |
message |
Detail message relating to the current status of the deployed flow. |
string |
state |
The state that the deployed flow is currently in. |
DeployedFlowSummary
A deployed flow summary.
| Name | Description | Schema |
|---|---|---|
activeErrorAlertCount |
Current count of active alerts classified as errors. |
integer (int64) |
activeInfoAlertCount |
Current count of active alerts classified as informational. |
integer (int64) |
activeWarningAlertCount |
Current count of active alerts classified as warnings. |
integer (int64) |
crn |
The deployed flow CRN. |
string |
deploymentCrn |
The deployment CRN. |
string |
name |
The deployed flow name. |
string |
status |
The deployed flow status. |
|
updated |
Timestamp of the last time the deployed flow was modified. |
integer (int64) |
Deployment
A deployment.
| Name | Description | Schema |
|---|---|---|
activeErrorAlertCount |
Current count of active alerts classified as errors. |
integer (int64) |
activeInfoAlertCount |
Current count of active alerts classified as informational. |
integer (int64) |
activeWarningAlertCount |
Current count of active alerts classified as warnings. |
integer (int64) |
autoscaleMaxNodes |
The maximum number of nodes that the deployment can scale up to, or null if autoscaling is not enabled for this deployment. |
integer (int32) |
autoscaleMinNodes |
The minimum number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is true. |
integer (int32) |
autoscalingEnabled |
Whether or not to autoscale the deployment. |
boolean |
cfmNifiVersion |
The version of NiFi being used by this deployment. |
string |
clusterSize |
The initial size of the deployment. |
string |
configurationVersion |
The version of the configuration for this deployment. |
integer (int64) |
crn |
The deployment CRN. |
string |
currentNodeCount |
The current node count. |
integer (int32) |
deployedByCrn |
The actor CRN of the person who deployed the flow. |
string |
deployedByName |
The name of the person who deployed the flow. |
string |
dfxLocalUrl |
Base URL to the dfx-local instance running this deployment. |
string |
flowCrn |
The CRN of the flow definition. Deprecated, use flowCrn in DeployedFlow |
string |
flowMetricsScalingEnabled |
Whether or not to use Flow metrics to scale the deployment. May only be specified when autscalingEnabled is true. |
boolean |
flowName |
The name of the flow. Deprecated, use artifactName in DeployedFlow |
string |
flowVersion |
The version of the flow. Deprecated, use flowVersion in DeployedFlow |
integer (int32) |
flowVersionCrn |
The deployment’s current flow version CRN. Deprecated, use flowVersionCrn in DeployedFlow |
string |
lastUpdatedByName |
The name of the person who last updated the deployment. |
string |
name |
The deployment name. |
string |
nifiUrl |
The url to open the deployed flow in NiFi. |
string |
project |
The project information of the deployment. |
|
service |
The DataFlow service information of the deployment. |
|
staticNodeCount |
The static number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is false. |
integer (int32) |
status |
The deployment status. |
|
updated |
Timestamp of the last time the deployment was modified. |
integer (int64) |
DeploymentState
The state that the deployment is currently in.
Type : enum (DEPLOYING, GOOD_HEALTH, CONCERNING_HEALTH, BAD_HEALTH, STARTING_FLOW, SUSPENDED, UPDATING, TERMINATING, RESTARTING, UPGRADING, ROLLING_BACK, STOPPED, UNKNOWN, IMPORTING_FLOW, STOPPING_FLOW, FLOW_STOPPED, SUSPENDING, RESUMING, CHANGING_FLOW_VERSION, TERMINATED)
DeploymentStatus
The status of a deployment.
| Name | Description | Schema |
|---|---|---|
detailedState |
The detailed state that the deployment is currently in. |
string |
message |
Detail message relating to the current status of the deployment. |
string |
state |
The state that the deployment is currently in. |
DeploymentSummary
A deployment summary.
| Name | Description | Schema |
|---|---|---|
activeErrorAlertCount |
Current count of active alerts classified as errors. |
integer (int64) |
activeInfoAlertCount |
Current count of active alerts classified as informational. |
integer (int64) |
activeWarningAlertCount |
Current count of active alerts classified as warnings. |
integer (int64) |
crn |
The deployment CRN. |
string |
name |
The deployment name. |
string |
project |
The project information of the deployment. |
|
service |
The DataFlow service information of the deployment. |
|
status |
The deployment status. |
|
updated |
Timestamp of the last time the deployment was modified. |
integer (int64) |
DescribeAddedReadyflowRequest
Request object for the DescribeAddedReadyflow method
| Name | Description | Schema |
|---|---|---|
addedReadyflowCrn |
The added ready flow CRN |
string |
DescribeAddedReadyflowResponse
Response object for the DescribeAddedReadyflow method
| Name | Description | Schema |
|---|---|---|
addedReadyflowDetail |
The added ready flow detail |
DescribeCollectionRequest
Request object when describing a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollectionCrn |
The catalog collection CRN. |
string |
DescribeCollectionResponse
Response object when describing a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollection |
Details of the catalog collection. |
DescribeDeploymentEventDetailRequest
A request to describe event details for deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The CRN of the deployment. |
string |
eventCrn |
The CRN of the event. |
string |
DescribeDeploymentEventDetailResponse
A response to describe event details for deployment.
| Name | Description | Schema |
|---|---|---|
eventDetail |
The event details. |
DescribeDeploymentRequest
A request to describe a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN. |
string |
DescribeDeploymentResponse
A response to describe a deployment.
| Name | Description | Schema |
|---|---|---|
deployment |
The deployment. |
DescribeFlowEventDetailInDeploymentRequest
A request to describe flow event details in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The CRN of the deployed flow. |
string |
deploymentCrn |
The CRN of the deployment. |
string |
eventCrn |
The CRN of the event to be described. |
string |
DescribeFlowEventDetailInDeploymentResponse
A response to describe flow event details in a deployment.
| Name | Description | Schema |
|---|---|---|
eventDetail |
The event details. |
DescribeFlowInDeploymentRequest
A request to describe a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The deployed flow CRN. |
string |
deploymentCrn |
The deployment CRN. |
string |
DescribeFlowInDeploymentResponse
A response to describe a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlow |
The deployed flow. |
DescribeFlowRequest
Request object for the DescribeFlow method
| Name | Description | Schema |
|---|---|---|
flowCrn |
The flow CRN |
string |
DescribeFlowResponse
Response object for the DescribeFlow method
| Name | Description | Schema |
|---|---|---|
flowDetail |
The flow detail |
DescribeProjectRequest
A request to describe a Project
| Name | Description | Schema |
|---|---|---|
projectCrn |
The Project CRN. |
string |
DescribeProjectResponse
A response to describe a Project
| Name | Description | Schema |
|---|---|---|
project |
The Project |
DescribeReadyflowRequest
Request object for the DescribeReadyflow method
| Name | Description | Schema |
|---|---|---|
readyflowCrn |
The ready flow CRN |
string |
DescribeReadyflowResponse
Response object for the DescribeReadyflow method
| Name | Description | Schema |
|---|---|---|
readyflowDetail |
the ready flow detail |
DescribeServiceEventDetailRequest
Request object for DescribeServiceEventDetail
| Name | Description | Schema |
|---|---|---|
eventCrn |
The event CRN |
string |
serviceCrn |
The service CRN |
string |
DescribeServiceEventDetailResponse
Response object for DescribeServiceEventDetail
| Name | Description | Schema |
|---|---|---|
event |
The events for the specified service |
DescribeServiceRequest
Request object for the DescribeService method.
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN |
string |
DescribeServiceResponse
Response object for the DescribeService method.
| Name | Description | Schema |
|---|---|---|
service |
The service |
DiagnosticsCollectionScope
DiagnosticsCollectionScope enum.
Type : enum (ALL, ENVIRONMENT, DEPLOYMENT)
DiagnosticsDestination
DiagnosticsDestination enum.
Type : enum (SUPPORT, CLOUD_STORAGE)
DiagnosticsEnvironmentComponent
DiagnosticsEnvironmentComponent enum.
Type : enum (CFM_OPERATOR, ZOOKEEPER_OPERATOR, CERT_MANAGER, CADENCE, DFX_LOGGING, DFX_LOCAL, DFX_OPS, FLUXCD, NGINX, NFS_PROVISIONER, REDIS, VAULT, VALKEY)
DiagnosticsStatus
Diagnostics status enum.
Type : enum (INPROGRESS, FAILED, SUCCESS)
DisableServiceRequest
Request object for DisableService
| Name | Description | Schema |
|---|---|---|
persist |
Whether or not to retain the database records of related entities |
boolean |
serviceCrn |
The service CRN. |
string |
terminateDeployments |
Whether or not to terminate all deployments associated with this DataFlow service |
boolean |
DisableServiceResponse
Response object for DisableService
| Name | Description | Schema |
|---|---|---|
status |
The DataFlow status of the service. |
EnableServiceRequest
Request object for EnableService
| Name | Description | Schema |
|---|---|---|
clusterSubnets |
Subnets to use for the Kubernetes cluster |
< string > array |
enforceProject |
Indicates whether to enforce project or not. |
boolean |
environmentCrn |
The CDP environment CRN |
string |
instanceType |
Indicates custom instance type to be used |
string |
kubeApiAuthorizedIpRanges |
The IP ranges authorized to connect to the Kubernetes API server. |
< string > array |
loadBalancerAuthorizedIpRanges |
IP Ranges that are authorized to access DF local endpoints. |
< string > array |
loadBalancerSubnets |
Subnets to use for the Load Balancer |
< string > array |
maxK8sNodeCount |
The maximum number of kubernetes nodes that service may scale up under high-demand situations. |
integer (int32) |
minK8sNodeCount |
The minimum number of kubernetes nodes needed for the service. |
integer (int32) |
podCidr |
CIDR range from which to assign IPs to pods in the kubernetes cluster. |
string |
privateCluster |
Indicates whether to provision private k8s cluster. |
boolean |
serviceCidr |
CIDR range from which to assign IPs to internal services in the kubernetes cluster. |
string |
skipPreflightChecks |
Indicates whether to skip Liftie’s pre-flight checks. |
boolean |
tags |
The tags to apply to service-related resources created. |
< string, string > map |
usePublicLoadBalancer |
Indicates whether or not to use a public load balancer when deploying dependencies stack, such as Nginx Ingress Controller. |
boolean |
userDefinedRouting |
Indicates whether User Defined Routing (UDR) mode is enabled for AKS clusters. |
boolean |
EnableServiceResponse
Response object for EnableService
| Name | Description | Schema |
|---|---|---|
service |
The service |
EncryptionParameters
The encryption parameters used by the DataFlow service for K8s secret encryption and EBS volume encryption.
| Name | Description | Schema |
|---|---|---|
encryptionKeyArn |
The AWS KMS key ARN used for encryption of Kubernetes secrets and EBS volumes. |
string |
encryptionStrategy |
The encryption strategy used by the DataFlow service. |
EncryptionStrategy
The encryption strategy used by the DataFlow service.
Type : enum (ENVIRONMENT_LEVEL)
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
Event
An event
| Name | Description | Schema |
|---|---|---|
alertType |
Optional value for alerts |
string |
crn |
The CRN of the event |
string |
description |
Description of the event |
string |
eventType |
The type of event that occurred |
string |
eventValue |
Optional value of the event when it was triggered |
number (double) |
firstOccurrence |
Timestamp of the first occurrence of this event |
integer (int64) |
lastOccurrence |
Timestamp of the last occurrence of this event |
integer (int64) |
lowerThreshold |
Optional value of the low end of the threshold that defines the event triggering condition |
number (double) |
lowerThresholdUnit |
Optional value of the units for the lower bound of the threshold |
string |
name |
Name of the event |
string |
referenceType |
Type of component that is identified by the referenceId. |
string |
severity |
The severity of the event |
string |
timeToleranceMillis |
Optional number of milliseconds tolerated outside the threshold bounds before the event is triggered |
integer (int64) |
upperThreshold |
Optional value of the high end of the threshold that defines the event triggering condition |
number (double) |
upperThresholdUnit |
Optional value of the units for the upper bound of the threshold |
string |
userName |
The user associated with creating the event. Null for user-agnostic events. |
string |
EventDetail
Event details.
| Name | Description | Schema |
|---|---|---|
event |
The event. |
|
metricSummary |
the metric summary. |
EventSummary
An event summary
| Name | Description | Schema |
|---|---|---|
alertType |
Optional value for alerts |
string |
crn |
The CRN of the event |
string |
eventType |
The type of event that occurred |
string |
firstOccurrence |
Timestamp of the first occurrence of this event |
integer (int64) |
name |
Name of the event |
string |
severity |
The severity of the event |
string |
FilterOption
A filter option.
| Name | Description | Schema |
|---|---|---|
iconClass |
The icon class. |
string |
identifier |
The filter identifier. |
string |
label |
The filter label. |
string |
Flow
A representation of a versioned data flow.
| Name | Description | Schema |
|---|---|---|
author |
Author of the most recent version |
string |
collectionCrn |
The collection CRN. |
string |
collectionName |
The collection name. |
string |
createdTimestamp |
The created timestamp. |
integer (int64) |
crn |
The artifact CRN |
string |
description |
The artifact description. |
string |
modifiedTimestamp |
The modified timestamp. |
integer (int64) |
name |
The artifact name. |
string |
versionCount |
The number of versions uploaded to the catalog. |
integer (int32) |
versions |
The list of artifactDetail versions |
< FlowVersion > array |
FlowDefinitionTagData
A representation of an artifact version tag.
| Name | Description | Schema |
|---|---|---|
tagColor |
The color of the version tag (optional). |
string |
tagName |
The name of the version tag. |
string |
FlowDefinitionVersionTagData
A representation of an artifact version tag.
| Name | Description | Schema |
|---|---|---|
tagColor |
The color of the version tag (optional). |
string |
tagName |
The name of the version tag. |
string |
FlowSummary
A summarized version of a flow, mostly useful in listing flows
| Name | Description | Schema |
|---|---|---|
artifactType |
The type of artifact |
string |
collectionCrn |
The collection CRN. |
string |
collectionName |
The collection name. |
string |
crn |
The artifact CRN |
string |
modifiedTimestamp |
The modified timestamp. |
integer (int64) |
name |
The artifact name. |
string |
versionCount |
The number of versions uploaded to the catalog. |
integer (int32) |
FlowVersion
A representation of a flow detail version
| Name | Description | Schema |
|---|---|---|
author |
The author of the flow |
string |
bucketIdentifier |
The bucketIdentifier of the flow |
string |
comments |
Comments about the flow |
string |
crn |
The flow version CRN |
string |
deploymentCount |
The number of deployments of the flow |
integer (int32) |
draftCount |
The number of draft flows associated with the version. |
integer (int32) |
tags |
The list of tags associated with the flow version. |
< FlowVersionTag > array |
timestamp |
The timestamp of the flow |
integer (int64) |
version |
The version of the flow |
integer (int32) |
FlowVersionTag
A representation of an artifact version tag.
| Name | Description | Schema |
|---|---|---|
tagColor |
The color of the version tag (optional). |
string |
tagName |
The name of the version tag. |
string |
GetFlowVersionRequest
Request object for the GetFlowVersion method.
| Name | Description | Schema |
|---|---|---|
flowVersionCrn |
The Flow Version CRN. |
string |
GetFlowVersionResponse
Response object for the GetFlowVersion method.
| Name | Description | Schema |
|---|---|---|
flowDefinition |
the flow definition. |
string (byte) |
GetKubeconfigRequest
Request object for GetKubeconfig.
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
GetKubeconfigResponse
Response object for GetKubeconfig.
| Name | Description | Schema |
|---|---|---|
kubeconfig |
The kubernetes configuration of the environment. |
string |
GrantUserKubernetesAccessRequest
The request for granting access
| Name | Description | Schema |
|---|---|---|
cloudUserId |
The user to grant remote access for |
string |
serviceCrn |
The service CRN. |
string |
GrantUserKubernetesAccessResponse
The response for granting access
| Name | Description | Schema |
|---|---|---|
cloudUserId |
The cloudUserId for the newly granted user |
string |
ImportFlowDefinitionRequest
Request object for ImportFlowDefinition
| Name | Description | Schema |
|---|---|---|
collectionCrn |
The CRN of the collection into which the flow definition will be imported. If unspecified, the flow will not be assigned to a collection. |
string |
comments |
The comments of the flow. |
string |
description |
The description of the flow. |
string |
file |
The file to be uploaded. |
string |
name |
The name of the flow. |
string |
tags |
The list of tags for the initial flow definition version |
< FlowDefinitionTagData > array |
ImportFlowDefinitionResponse
Response object for ImportFlowDefinition
| Name | Description | Schema |
|---|---|---|
author |
Author of the most recent version |
string |
collectionCrn |
The collection CRN. |
string |
collectionName |
The collection name. |
string |
createdTimestamp |
The created timestamp. |
integer (int64) |
crn |
The artifact CRN |
string |
description |
The artifact description. |
string |
modifiedTimestamp |
The modified timestamp. |
integer (int64) |
name |
The artifact name. |
string |
versionCount |
The number of versions uploaded to the catalog. |
integer (int32) |
versions |
The list of artifactDetail versions |
< FlowVersion > array |
ImportFlowDefinitionVersionRequest
Request object for ImportFlowDefinitionVersion
| Name | Description | Schema |
|---|---|---|
comments |
The comments of the flow version. |
string |
file |
The file to be uploaded. |
string |
flowCrn |
The CRN of the previously uploaded flow. |
string |
tags |
The tags for the flow version. |
< FlowDefinitionVersionTagData > array |
ImportFlowDefinitionVersionResponse
Response object for ImportFlowDefinitionVersion
| Name | Description | Schema |
|---|---|---|
author |
The author of the flow |
string |
bucketIdentifier |
The bucketIdentifier of the flow |
string |
comments |
Comments about the flow |
string |
crn |
The flow version CRN |
string |
deploymentCount |
The number of deployments of the flow |
integer (int32) |
tags |
The tags for the flow version. |
< FlowVersionTag > array |
timestamp |
The timestamp of the flow |
integer (int64) |
version |
The version of the flow |
integer (int32) |
InitiateDeploymentRequest
A request to initiate a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN for a deployment where change flow version is being performed. |
string |
flowVersionCrn |
The flow version CRN. |
string |
serviceCrn |
The service CRN. |
string |
InitiateDeploymentResponse
A response from initiating a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentRequestCrn |
The newly created deployment request CRN. |
string |
dfxLocalUrl |
The base URL of the dfx-local instance where the deployment will eventually be created. |
string |
InitiateFlowInDeploymentRequest
A request to initiate the flow creation process in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The CRN of an existing deployed flow where a 'change flow version' operation is being performed. |
string |
deploymentCrn |
The CRN of the existing deployment where this flow will be initiated. |
string |
flowVersionCrn |
The flow version CRN. |
string |
serviceCrn |
The service CRN. |
string |
InitiateFlowInDeploymentResponse
A response from initiating the flow creation process in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowRequestCrn |
The CRN of the newly created flow deployment request. |
string |
dfxLocalUrl |
The base URL of the dfx-local instance where the flow deployment will eventually be created. |
string |
ListCollectionsRequest
Request object when listing collections.
| Name | Description | Schema |
|---|---|---|
pageSize |
The page size. |
integer (int32) |
searchTerm |
Search term to filter by name |
string |
sorts |
The sort criteria |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListCollectionsResponse
Response object when listing collections.
| Name | Description | Schema |
|---|---|---|
collections |
The listing of Catalog Collections. |
< CatalogCollection > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListDeployableServicesForNewDeploymentsRequest
Request object for the ListDeployableServicesForNewDeploymentsRequest method.
Type : object
ListDeployableServicesForNewDeploymentsResponse
Response object for the ListDeployableServicesForNewDeploymentsRequest method.
| Name | Description | Schema |
|---|---|---|
services |
The services. |
< ServiceSummary > array |
ListDeploymentActiveAlertsRequest
A request to list active alerts for deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN. |
string |
sort |
Sort criteria (firstOccurrence|name|eventType):(asc|desc). Defaults to firstOccurrence:asc. |
string |
ListDeploymentActiveAlertsResponse
A response to list active alerts for deployment.
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The events for the specified deployment. |
< EventSummary > array |
ListDeploymentEventsRequest
A request to list event history for deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN. |
string |
filters |
Filter criteria (see list-filter-options). |
< string > array |
pageSize |
The page size. |
integer (int32) |
rows |
This field is deprecated and will be removed. Use max-items instead. Historically used to set the number of elements to return. Note that if max-items is also specified, and rows is less than max-items, an error will be returned. |
integer (int32) |
startingToken |
The token pointing to the next element to be retrieved. |
string |
timestampFrom |
Timestamp from when to list events prior. |
integer (int64) |
ListDeploymentEventsResponse
A response to list event history for deployment.
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The list of events. |
< EventSummary > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListDeploymentKPIsRequest
A request to list deployment KPIs.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN. |
string |
metricsTimePeriod |
The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY). |
string |
ListDeploymentKPIsResponse
A response to list deployment KPIs.
| Name | Description | Schema |
|---|---|---|
metricCharts |
The metrics for the configured KPIs. |
< MetricChart > array |
ListDeploymentSystemMetricsRequest
A request to list deployment system metrics.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN. |
string |
metricsTimePeriod |
The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY). |
string |
ListDeploymentSystemMetricsResponse
A response to list deployment system metrics.
| Name | Description | Schema |
|---|---|---|
metricCharts |
The metrics for the configured KPIs. |
< MetricChart > array |
ListDeploymentsRequest
A request to list deployments.
| Name | Description | Schema |
|---|---|---|
filters |
The filter criteria (see list-filter-options). |
< string > array |
pageSize |
The page size. |
integer (int32) |
searchTerm |
A search term by which to filter the name field. |
string |
sorts |
The sort criteria (updated|name|state|dataSent|dataReceived):(asc|desc) e.g., name:asc. |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListDeploymentsResponse
A response from listing deployments.
| Name | Description | Schema |
|---|---|---|
deployments |
The listing of deployments in this page. |
< DeploymentSummary > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListDiagnosticsRequest
A request to list past and present diagnostics for a given DataFlow Service.
| Name | Description | Schema |
|---|---|---|
dfServiceCrn |
DataFlow Service CRN from which to list diagnostics. |
string |
pageSize |
The page size. |
integer (int32) |
startingToken |
The token pointing to the next element to be retrieved. |
string |
uuids |
List of UUIDs to list in the response. |
< string > array |
ListDiagnosticsResponse
Response object for ListDiagnostics.
| Name | Description | Schema |
|---|---|---|
diagnostics |
List of previous and current diagnostics requests for a given DataFlow Service. |
< ListDiagnosticsResponseItem > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListDiagnosticsResponseItem
Object representation of a diagnostics request list item.
| Name | Description | Schema |
|---|---|---|
bundleCloudPath |
Cloud storage path of the bundle, only populated for CLOUD_STORAGE destinations. |
string |
caseNumber |
Support case number associated with the collection. |
string |
collectionScope |
Collection scope. |
|
deployments |
List of Flow deployments included in the collection. |
< string > array |
description |
User provided description of request. |
string |
destination |
Upload destination. |
|
dfServiceCrn |
DataFlow Service CRN. |
string |
endTime |
Time to which to collect logs. |
string |
environmentComponents |
List of environment components included in the collection. |
< DiagnosticsEnvironmentComponent > array |
requestedTime |
Time at which the collection was requested. |
string |
startTime |
Time from which to collect logs. |
string |
status |
Status of request. |
|
uuid |
Uuid of the collection. |
string |
ListFilterOptionsRequest
A request to list filter options.
| Name | Description | Schema |
|---|---|---|
filterType |
The type of filter. |
string |
ListFilterOptionsResponse
A response to list filter options.
| Name | Description | Schema |
|---|---|---|
filterOptions |
The filter options. |
< FilterOption > array |
ListFlowActiveAlertsInDeploymentRequest
A request to list active alerts for a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The deployed flow CRN. |
string |
deploymentCrn |
The deployment CRN. |
string |
sort |
Sort criteria (firstOccurrence|name|eventType):(asc|desc). Defaults to firstOccurrence:asc. |
string |
ListFlowActiveAlertsInDeploymentResponse
A response to list active alerts for a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The events for the specified deployed flow. |
< EventSummary > array |
ListFlowDefinitionVersionsRequest
Request object for the ListFlowDefinitionVersions method.
| Name | Description | Schema |
|---|---|---|
flowCrn |
The flow CRN |
string |
searchTerm |
Search term to use in the list of tags |
string |
ListFlowDefinitionVersionsResponse
Response object for the ListFlowDefinitionVersions method.
| Name | Description | Schema |
|---|---|---|
flowVersions |
The list of matching flow versions |
< FlowVersion > array |
ListFlowDefinitionsRequest
Request object for the ListFlowDefinitions method.
| Name | Description | Schema |
|---|---|---|
collectionCrn |
Filter by collection CRN. |
string |
pageSize |
The page size. |
integer (int32) |
searchTerm |
Search term to filter by name |
string |
sorts |
The sort criteria |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListFlowDefinitionsResponse
Response object for the ListFlowDefinitions method.
| Name | Description | Schema |
|---|---|---|
flows |
The flows. |
< FlowSummary > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListFlowEventsInDeploymentRequest
A request to list flow event history in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The deployment CRN. |
string |
deploymentCrn |
The deployment CRN. |
string |
filters |
Filter criteria (see list-filter-options). |
< string > array |
pageSize |
The page size. |
integer (int32) |
startingToken |
The token pointing to the next element to be retrieved. |
string |
timestampFrom |
Timestamp from when to list events prior. |
integer (int64) |
ListFlowEventsInDeploymentResponse
A response to list flow event history in a deployment.
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The list of events. |
< EventSummary > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListFlowKpisInDeploymentRequest
A request to list KPI metrics for a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlowCrn |
The deployed flow CRN. |
string |
deploymentCrn |
The deployment CRN. |
string |
metricsTimePeriod |
The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY). |
string |
ListFlowKpisInDeploymentResponse
A response to list KPI metrics for a flow in a deployment.
| Name | Description | Schema |
|---|---|---|
metricCharts |
The metrics for the configured KPIs. |
< MetricChart > array |
ListFlowVersionTagsRequest
Request object for the ListFlowVersionTags method.
| Name | Description | Schema |
|---|---|---|
flowVersionCrn |
The flow version CRN. |
string |
ListFlowVersionTagsResponse
Response object for the ListFlowVersionTags method.
| Name | Description | Schema |
|---|---|---|
flowVersionTags |
The flow version tag data. |
< FlowVersionTag > array |
ListFlowsInDeploymentRequest
A request to list the flows in a deployment.
| Name | Description | Schema |
|---|---|---|
deploymentCrn |
The deployment CRN to list flows for. |
string |
filters |
The filter criteria (see list-filter-options). |
< string > array |
pageSize |
The page size. |
integer (int32) |
searchTerm |
A search term by which to filter the name field. |
string |
sorts |
The sort criteria (updated|name|state):(asc|desc) e.g., name:asc. |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListFlowsInDeploymentResponse
A response from listing flows in a deployment.
| Name | Description | Schema |
|---|---|---|
deployedFlows |
The list of deployed flows in this page. |
< DeployedFlowSummary > array |
nextToken |
The page token for requesting the next page of results. |
string |
ListNotificationsRequest
The request for retrieving notifications
| Name | Description | Schema |
|---|---|---|
timestampAfter |
Timestamp from when to list notifications since |
integer (int64) |
ListNotificationsResponse
The response for retrieving notifications
| Name | Description | Schema |
|---|---|---|
notifications |
The notifications |
< Notification > array |
ListProjectFilterOptionsRequest
A request to list filter options
| Name | Description | Schema |
|---|---|---|
filterType |
The type of filter |
string |
ListProjectFilterOptionsResponse
A response to list filter options
| Name | Description | Schema |
|---|---|---|
filterOptions |
The filter options |
< ProjectFilterOption > array |
ListProjectsRequest
A request to list Projects
| Name | Description | Schema |
|---|---|---|
filters |
The filter criteria |
< string > array |
pageSize |
The page size. |
integer (int32) |
sorts |
The sort criteria |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListProjectsResponse
A response to list Projects
| Name | Description | Schema |
|---|---|---|
nextToken |
The page token for requesting the next page of results. |
string |
projects |
The listing of Projects. |
< Project > array |
ListReadyflowsRequest
Request object for the ListReadyflows method.
| Name | Description | Schema |
|---|---|---|
pageSize |
The page size. |
integer (int32) |
searchTerm |
Search term by which to filter (optional) |
string |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListReadyflowsResponse
Response object for the ListReadyflows method.
| Name | Description | Schema |
|---|---|---|
nextToken |
The page token for requesting the next page of results. |
string |
readyflows |
The ready flows |
< ReadyflowSummary > array |
ListServiceActiveAlertsRequest
Request object for ListServiceActiveAlerts
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN |
string |
sort |
Sort criteria |
string |
ListServiceActiveAlertsResponse
Response object for ListServiceActiveAlerts
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The events for the specified service |
< EventSummary > array |
ListServiceEventsRequest
Request object for ListServiceEvents
| Name | Description | Schema |
|---|---|---|
filters |
Filter criteria |
< string > array |
rows |
Max number of rows to return |
integer (int32) |
serviceCrn |
The service CRN |
string |
timestampFrom |
Timestamp from when to list events prior |
integer (int64) |
ListServiceEventsResponse
Response object for ListServiceEvents
| Name | Description | Schema |
|---|---|---|
eventSummaries |
The events for the specified service |
< EventSummary > array |
ListServiceSystemMetricsRequest
A request to list service system metrics
| Name | Description | Schema |
|---|---|---|
metricsTimePeriod |
The metrics time period |
string |
serviceCrn |
The service CRN |
string |
ListServiceSystemMetricsResponse
A response to list service system metrics
| Name | Description | Schema |
|---|---|---|
metricCharts |
The system metrics for the service |
< MetricChart > array |
ListServicesRequest
Request object for the ListServices method.
| Name | Description | Schema |
|---|---|---|
pageSize |
The page size. |
integer (int32) |
searchTerm |
Search term to filter by name |
string |
sorts |
The sort criteria |
< string > array |
startingToken |
The token pointing to the next element to be retrieved. |
string |
ListServicesResponse
Response object for the ListServices method.
| Name | Description | Schema |
|---|---|---|
nextToken |
The page token for requesting the next page of results. |
string |
services |
The services. |
< ServiceSummary > array |
ListUserKubernetesAccessRequest
The request for listing the users that have access to a cluster
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
ListUserKubernetesAccessResponse
The response for listing the users that have access to a cluster
| Name | Description | Schema |
|---|---|---|
cloudUserIds |
The cloudUserId for the newly granted user |
< string > array |
MetricChart
A metric chart
| Name | Description | Schema |
|---|---|---|
alert |
The optional thresholds associated with the alert on a metric |
|
componentName |
The scope component name that will exist for Processor, Process Group, and Connection metrics. |
string |
componentType |
The component type of the metric |
string |
metrics |
The chart metrics |
|
mirroredMetrics |
The optional mirrored metrics that only exist for certain system metrics |
|
name |
The name of the metric |
string |
unitType |
The unit type of the metric |
string |
MetricChartAlert
Thresholds associated with a metric
| Name | Description | Schema |
|---|---|---|
frequencyTolerance |
The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated |
|
thresholdLessThan |
The lessThan threshold for the alert |
number (double) |
thresholdMoreThan |
The moreThan threshold for the alert |
number (double) |
MetricChartData
Chart data of metrics
| Name | Description | Schema |
|---|---|---|
averageValue |
The average value of the data |
number (double) |
averageValueLabel |
The average value label |
string |
currentValue |
The most recent value in the list of data points |
number (double) |
currentValueLabel |
The current value label |
string |
datas |
The list of data points (in time-order) for the metric |
< MetricValue > array |
tooltipValueLabel |
The tooltip value label |
string |
MetricChartFrequencyTolerance
Frequency tolerance for a metric chart
| Name | Description | Schema |
|---|---|---|
unit |
The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated |
string |
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) |
MetricSummary
Metric summary
| Name | Description | Schema |
|---|---|---|
alertFrequencyUnit |
Units of frequency |
|
alertFrequencyValue |
Frequency value |
number (double) |
componentId |
Id of the component monitored |
string |
componentName |
The scope component name that will exist for Processor, Process Group, and Connection metrics. |
string |
componentType |
The component type of the metric |
string |
description |
The description of the metric |
string |
displayContext |
Display context of the metric |
string |
label |
The label of the metric |
string |
lowerBoundCondition |
Lower boundary condition |
|
name |
The name of the metric |
string |
unitType |
The unit type of the metric |
string |
upperBoundCondition |
Upper boundary condition |
|
values |
Values for the metric |
< MetricValue > array |
MetricUnit
Metric unit
| Name | Description | Schema |
|---|---|---|
abbreviation |
abbreviation used for this unit |
string |
conversionValue |
conversion value to use when converting between units |
integer (int64) |
displayLabel |
display label for the unit |
string |
id |
Id of the metric unit |
string |
metricUnitType |
type of unit (DURATION, RATIO, SIZE, RATE, COUNT) |
string |
name |
Name of the unit |
string |
ordinal |
ordinal used when positioning the unit in a list (sort order) |
integer (int32) |
MetricValue
A metric value
| Name | Description | Schema |
|---|---|---|
timestamp |
The timestamp of this data point |
integer (int64) |
value |
The value of this data point |
number (double) |
Notification
A notification for an event
| Name | Description | Schema |
|---|---|---|
description |
The description of the notification |
string |
eventId |
The id of the event that triggered this notification |
string |
name |
The name of the notification |
string |
referenceId |
The id of the component referenced by this notification |
string |
referenceType |
The type of component referenced by this notification |
string |
severity |
The severity of the notification |
string |
timestamp |
The timestamp of the event that triggered this notification |
integer (int64) |
username |
The user associated with the notification |
string |
Project
A Project
| Name | Description | Schema |
|---|---|---|
created |
The created timestamp. |
integer (int64) |
crn |
The Project CRN. |
string |
deleting |
Whether or not the project is currently deleting |
boolean |
description |
The Project description. |
string |
name |
The Project name. |
string |
revision |
The Project revision |
integer (int32) |
service |
The DataFlow service information of the Project |
|
updated |
The last updated timestamp. |
integer (int64) |
ProjectFilterOption
A filter option
| Name | Description | Schema |
|---|---|---|
iconClass |
The icon class |
string |
identifier |
The filter identifier |
string |
label |
The filter label |
string |
ProjectMeta
Metadata 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 |
ReadyflowDetails
A detailed representation of a ready flow.
| Name | Description | Schema |
|---|---|---|
author |
The author of the most recent version |
string |
description |
The ready flow description (long) |
string |
destination |
The ready flow data destination |
string |
destinationDataFormat |
The ready flow data destination format |
string |
documentationLink |
A link to the ready flow documentation |
string |
imported |
Whether the ready flow has been imported into the current account |
boolean |
modifiedTimestamp |
The modified timestamp. |
integer (int64) |
name |
The ready flow name |
string |
notes |
Optional notes about the ready flow |
string |
readyflowCrn |
The ready flow CRN |
string |
source |
The ready flow data source |
string |
sourceDataFormat |
The ready flow data source format |
string |
summary |
The ready flow summary (short) |
string |
ReadyflowSummary
A summarized version of a ready flow, mostly useful in listing flows
| Name | Description | Schema |
|---|---|---|
destination |
The ready flow destination |
string |
imported |
Whether the ready flow has been imported into the current account |
boolean |
importedArtifactCrn |
The crn of the imported ready flow, used to look up its details |
string |
latestVersion |
The latest version of the ready flow |
integer (int32) |
name |
The ready flow name |
string |
readyflowCrn |
The ready flow CRN |
string |
source |
The ready flow source |
string |
summary |
The ready flow summary |
string |
RenewCertificatesRequest
Request object for RenewCertificates
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
RenewCertificatesResponse
Response object for RenewCertificates
Type : object
ResetServiceRequest
Request object for ResetService
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The serviceCrn CRN. |
string |
ResetServiceResponse
Response object for ResetService
Type : object
RevokeUserKubernetesAccessRequest
The request for revoking access
| Name | Description | Schema |
|---|---|---|
cloudUserId |
The user to revoke remote access for |
string |
serviceCrn |
The service CRN. |
string |
RevokeUserKubernetesAccessResponse
The response for revoking access
| Name | Description | Schema |
|---|---|---|
cloudUserId |
The cloudUserId of the newly revoked user |
string |
RotatePasswordRequest
Request object for RotatePassword
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
RotatePasswordResponse
Response object for RotatePassword
Type : object
Service
The DataFlow view of a CDP service.
| 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) |
availableK8sVersionUpgrade |
The available kubernetes version that cluster can be upgraded to. |
string |
cloudPlatform |
The cloud platform of the service. |
string |
clusterId |
Cluster id of the service, if enabled |
string |
clusterSubnets |
Subnets to use for the Kubernetes cluster |
< string > array |
creatingK8sNodeCount |
The number of kubernetes nodes currently under creation for this service. |
integer (int32) |
crn |
The service CRN. |
string |
deploymentCount |
The deployment count. |
integer (int32) |
dfLocalUrl |
The URL of the service local DataFlow application. |
string |
encryptionParameters |
The encryption parameters used by DataFlow service for encrypting K8s secrets and EBS volumes. |
|
enforceProject |
Indicates whether to enforce project or not. |
boolean |
environmentCrn |
The CDP Environment CRN |
string |
instanceType |
The instance type of the kubernetes nodes currently in use by DataFlow for this service. |
string |
k8sServerVersion |
The kubernetes version of the cluster |
string |
kubeApiAuthorizedIpRanges |
The IP Ranges authorized to connect to the Kubernetes API Server. |
< string > array |
loadBalancerAuthorizedIpRanges |
IP Ranges that are authorized to access CDF local endpoints. |
< string > array |
loadBalancerSubnets |
Subnets to use for the Load Balancer |
< string > array |
maxK8sNodeCount |
The maximum number of kubernetes nodes that service may scale up under high-demand situations |
integer (int32) |
minK8sNodeCount |
The minimum number of Kubernetes nodes that need to be provisioned in the service |
integer (int32) |
name |
The service name. |
string |
podCidr |
CIDR range from which to assign IPs to pods in the kubernetes cluster. |
string |
privateCluster |
Whether the k8s cluster is private or not. |
boolean |
proxyName |
The name of the proxy that is configured for the CDP environment |
string |
region |
The region of the service. |
string |
runningK8sNodeCount |
The number of kubernetes nodes currently running for this service. |
integer (int32) |
serviceCidr |
CIDR range from which to assign IPs to internal services in the kubernetes cluster. |
string |
status |
The DataFlow status of the service. |
|
tags |
The tags to apply to service related resources created |
< string, string > map |
terminatingK8sNodeCount |
The number of kubernetes nodes currently terminating for this service. |
integer (int32) |
upgradeDeploymentsNiFiVersion |
The upgrade deployments NiFi version flag value of the service. |
boolean |
usePublicLoadBalancer |
Whether or not a public load balancer is exposed. |
boolean |
userDefinedRouting |
Whether User Defined Routing (UDR) mode is enabled for AKS clusters or not. |
boolean |
validActions |
Valid actions that can be applied based on the current state of the service |
< string > array |
workloadVersion |
The workload version of the service. |
string |
ServiceMeta
Metadata about a service
| Name | Description | Schema |
|---|---|---|
cloudProvider |
the cloud provider |
string |
crn |
The crn of the service |
string |
environmentCrn |
The CDP Environment CRN |
string |
name |
the name of the environment |
string |
region |
the region within the cloud provider |
string |
ServiceState
The state of the service.
Type : enum (NOT_ENABLED, ENABLING, GOOD_HEALTH, CONCERNING_HEALTH, BAD_HEALTH, UPDATING, RENEWING_CERTS, DISABLING, UNKNOWN, UPGRADING, COLLECTING_DIAGNOSTICS, ROTATING_PASSWORD)
ServiceStatus
The status of a DataFlow enabled service.
| Name | Description | Schema |
|---|---|---|
detailedState |
The detailed state of the service. |
string |
message |
A status message for the service. |
string |
state |
The state of the service. |
ServiceSummary
The summary of the DF Service enabled in a CDP Environment
| 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) |
cloudPlatform |
The cloud platform of the service. |
string |
clusterId |
Cluster id of the service, if enabled |
string |
crn |
The service CRN. |
string |
deploymentCount |
The deployment count. |
integer (int32) |
enforceProject |
Indicates whether to enforce project or not. |
boolean |
environmentCrn |
The CDP Environment CRN |
string |
instanceType |
The instance type of the kubernetes nodes currently in use by DataFlow for this service. |
string |
maxK8sNodeCount |
The maximum number of kubernetes nodes that service may scale up under high-demand situations |
integer (int32) |
name |
The service name. |
string |
proxyName |
The name of the proxy that is configured for the CDP environment |
string |
region |
The region of the service. |
string |
runningK8sNodeCount |
The number of kubernetes nodes currently running for this service. |
integer (int32) |
status |
The DataFlow status of the service. |
|
upgradeDeploymentsNiFiVersion |
The upgrade deployments NiFi version flag value of the service. |
boolean |
validActions |
Valid actions that can be applied based on the current state of the service |
< string > array |
workloadVersion |
The workload version of the service. |
string |
StartGetDiagnosticsCollectionRequest
Request to start DataFlow diagnostics bundle creation.
| Name | Description | Schema |
|---|---|---|
caseNumber |
Support case number associated with this request. |
string |
collectionScope |
Collection scope. |
|
deployments |
List of deployments to collect diagnostics from, if none are specified, all deployments will be included. |
< string > array |
description |
Description of diagnostics collection. |
string |
destination |
Destination location. |
|
dfServiceCrn |
DataFlow Service CRN from which to collect diagnostics. |
string |
endTime |
Date-time to which component logs will be collected, starting from startTime. |
string |
environmentComponents |
List of environment components for which logs should be collected. |
< DiagnosticsEnvironmentComponent > array |
includeNifiDiagnostics |
Indicates if the heap and thread dumps are needed for a flow. |
boolean |
startTime |
Date-time from which component logs will be collected, up until endTime. |
string |
StartGetDiagnosticsCollectionResponse
Response object for StartGetDiagnosticsCollection.
| Name | Description | Schema |
|---|---|---|
uuid |
UUID of the bundle request. |
string |
UpdateCollectionRequest
Request object when updating a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollectionCrn |
The catalog collection CRN. |
string |
description |
The new description of the collection. |
string |
name |
The new name of the collection. |
string |
UpdateCollectionResponse
Response object when updating a catalog collection.
| Name | Description | Schema |
|---|---|---|
catalogCollection |
The updated catalog collection |
UpdateNodeImagesRequest
Request object for UpdateNodeImages
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
UpdateNodeImagesResponse
Response object for UpdateNodeImages
Type : object
UpdateProjectRequest
A request to describe a Project
| Name | Description | Schema |
|---|---|---|
projectCrn |
The Project CRN. |
string |
projectDescription |
The new Project description. |
string |
projectName |
The new Project name. |
string |
projectRevision |
The Project revision |
integer (int32) |
UpdateProjectResponse
A response to describe a Project
| Name | Description | Schema |
|---|---|---|
project |
The Project |
UpdateServiceRequest
Request object for UpdateService
| Name | Description | Schema |
|---|---|---|
kubeApiAuthorizedIpRanges |
The IP Ranges authorized to connect to the Kubernetes API Server. |
< string > array |
loadBalancerAuthorizedIpRanges |
IP Ranges that are authorized to access CDF local endpoints. |
< string > array |
maxK8sNodeCount |
The maximum number of kubernetes nodes that service may scale up under high-demand situations. |
integer (int32) |
minK8sNodeCount |
The minimum number of kubernetes nodes needed for the service. |
integer (int32) |
serviceCrn |
The service CRN. |
string |
skipPreflightChecks |
Indicates whether to skip Liftie’s pre-flight checks. |
boolean |
UpdateServiceResponse
Response object for UpdateService
| Name | Description | Schema |
|---|---|---|
service |
The service. |
UpgradeServiceRequest
Request object for UpgradeService
| Name | Description | Schema |
|---|---|---|
serviceCrn |
The service CRN. |
string |
skipPreflightChecks |
Indicates whether or not to skip preflight checks when upgrading the workload cluster. |
boolean |
upgradeDeploymentsNifiVersion |
Indicates whether deployments NiFi version need to be upgraded; defaults to false |
boolean |
UpgradeServiceResponse
Response object for UpgradeService
| Name | Description | Schema |
|---|---|---|
service |
The service. |