Overview

Manage DataFlow Services.

Version information

Version : 0.9.126 (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
required

AddReadyflowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

AddReadyflowResponse

default

The default response on an error.

Error

Cancels deletion of a Project.

POST /api/v1/df/cancelDeleteProject

Description

Cancels deletion of a Project.

Parameters

Type Name Schema

Body

input
required

CancelDeleteProjectRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CancelDeleteProjectResponse

default

The default response on an error.

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
required

CreateFlowVersionTagRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateFlowVersionTagResponse

default

The default response on an error.

Error

Creates a Project.

POST /api/v1/df/createProject

Description

Creates a Project.

Parameters

Type Name Schema

Body

input
required

CreateProjectRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

CreateProjectResponse

default

The default response on an error.

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
required

DeleteAddedReadyflowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteAddedReadyflowResponse

default

The default response on an error.

Error

Delete flow.

POST /api/v1/df/deleteFlow

Description

Deletes the specified flow.

Parameters

Type Name Schema

Body

input
required

DeleteFlowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteFlowResponse

default

The default response on an error.

Error

Delete flow version tag.

POST /api/v1/df/deleteFlowVersionTag

Description

Deletes the specified flow version tag.

Parameters

Type Name Schema

Body

input
required

DeleteFlowVersionTagRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteFlowVersionTagResponse

default

The default response on an error.

Error

Deletes a Project.

POST /api/v1/df/deleteProject

Description

Deletes a Project.

Parameters

Type Name Schema

Body

input
required

DeleteProjectRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DeleteProjectResponse

default

The default response on an error.

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
required

DescribeAddedReadyflowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeAddedReadyflowResponse

default

The default response on an error.

Error

Describe deployment.

POST /api/v1/df/describeDeployment

Description

Describes a deployment

Parameters

Type Name Schema

Body

input
required

DescribeDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeDeploymentResponse

default

The default response on an error.

Error

Describe event detail for deployment.

POST /api/v1/df/describeDeploymentEventDetail

Description

Describe event detail for deployment.

Parameters

Type Name Schema

Body

input
required

DescribeDeploymentEventDetailRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeDeploymentEventDetailResponse

default

The default response on an error.

Error

Describe flow.

POST /api/v1/df/describeFlow

Description

Gets the details for the specified flow.

Parameters

Type Name Schema

Body

input
required

DescribeFlowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeFlowResponse

default

The default response on an error.

Error

Describes a Project.

POST /api/v1/df/describeProject

Description

Describes a Project

Parameters

Type Name Schema

Body

input
required

DescribeProjectRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeProjectResponse

default

The default response on an error.

Error

Describe ready flow.

POST /api/v1/df/describeReadyflow

Description

Gets the details for the specified ready flow.

Parameters

Type Name Schema

Body

input
required

DescribeReadyflowRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeReadyflowResponse

default

The default response on an error.

Error

Describe service.

POST /api/v1/df/describeService

Description

Describes service.

Parameters

Type Name Schema

Body

input
required

DescribeServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeServiceResponse

default

The default response on an error.

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
required

DescribeServiceEventDetailRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DescribeServiceEventDetailResponse

default

The default response on an error.

Error

Disable service.

POST /api/v1/df/disableService

Description

Disable service.

Parameters

Type Name Schema

Body

input
required

DisableServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

DisableServiceResponse

default

The default response on an error.

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
required

EnableServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

EnableServiceResponse

default

The default response on an error.

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
required

GetFlowVersionRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetFlowVersionResponse

default

The default response on an error.

Error

Get Kubeconfig.

POST /api/v1/df/getKubeconfig

Description

Gets kubernetes configuration for the environment.

Parameters

Type Name Schema

Body

input
required

GetKubeconfigRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetKubeconfigResponse

default

The default response on an error.

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
required

GrantUserKubernetesAccessRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GrantUserKubernetesAccessResponse

default

The default response on an error.

Error

Import a new flow definition.

POST /api/v1/df/importFlowDefinition

Description

Import a new flow definition.

Parameters

Type Name Schema

Body

input
required

ImportFlowDefinitionRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ImportFlowDefinitionResponse

default

The default response on an error.

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
required

ImportFlowDefinitionVersionRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ImportFlowDefinitionVersionResponse

default

The default response on an error.

Error

Initiate a deployment creation.

POST /api/v1/df/initiateDeployment

Description

Initiate a deployment creation.

Parameters

Type Name Schema

Body

input
required

InitiateDeploymentRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

InitiateDeploymentResponse

default

The default response on an error.

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
required

ListDeployableServicesForNewDeploymentsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeployableServicesForNewDeploymentsResponse

default

The default response on an error.

Error

List active alerts for deployment.

POST /api/v1/df/listDeploymentActiveAlerts

Description

List active alerts for deployment.

Parameters

Type Name Schema

Body

input
required

ListDeploymentActiveAlertsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentActiveAlertsResponse

default

The default response on an error.

Error

List event history for deployment.

POST /api/v1/df/listDeploymentEvents

Description

List event history for deployment.

Parameters

Type Name Schema

Body

input
required

ListDeploymentEventsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentEventsResponse

default

The default response on an error.

Error

List deployment KPIs.

POST /api/v1/df/listDeploymentKPIs

Description

Lists deployment KPIs.

Parameters

Type Name Schema

Body

input
required

ListDeploymentKPIsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentKPIsResponse

default

The default response on an error.

Error

List deployment System metrics.

POST /api/v1/df/listDeploymentSystemMetrics

Description

Lists deployment System metrics.

Parameters

Type Name Schema

Body

input
required

ListDeploymentSystemMetricsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentSystemMetricsResponse

default

The default response on an error.

Error

List deployments.

POST /api/v1/df/listDeployments

Description

Lists deployments.

Parameters

Type Name Schema

Body

input
required

ListDeploymentsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDeploymentsResponse

default

The default response on an error.

Error

List diagnostics.

POST /api/v1/df/listDiagnostics

Description

List diagnostics requests.

Parameters

Type Name Schema

Body

input
required

ListDiagnosticsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListDiagnosticsResponse

default

The default response on an error.

Error

List filter options.

POST /api/v1/df/listFilterOptions

Description

Lists filter options.

Parameters

Type Name Schema

Body

input
required

ListFilterOptionsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListFilterOptionsResponse

default

The default response on an error.

Error

List flow definition versions.

POST /api/v1/df/listFlowDefinitionVersions

Description

Lists flow definition versions for a flow

Parameters

Type Name Schema

Body

input
required

ListFlowDefinitionVersionsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListFlowDefinitionVersionsResponse

default

The default response on an error.

Error

List flow definitions.

POST /api/v1/df/listFlowDefinitions

Description

Lists flow definitions.

Parameters

Type Name Schema

Body

input
required

ListFlowDefinitionsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListFlowDefinitionsResponse

default

The default response on an error.

Error

List flow version tags.

POST /api/v1/df/listFlowVersionTags

Description

Lists tags for the specified flow version

Parameters

Type Name Schema

Body

input
required

ListFlowVersionTagsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListFlowVersionTagsResponse

default

The default response on an error.

Error

List notifications.

POST /api/v1/df/listNotifications

Description

Lists notifications.

Parameters

Type Name Schema

Body

input
required

ListNotificationsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListNotificationsResponse

default

The default response on an error.

Error

List filter options.

POST /api/v1/df/listProjectFilterOptions

Description

Lists filter options to be used with ListProjects.

Parameters

Type Name Schema

Body

input
required

ListProjectFilterOptionsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListProjectFilterOptionsResponse

default

The default response on an error.

Error

List Projects.

POST /api/v1/df/listProjects

Description

Lists Projects.

Parameters

Type Name Schema

Body

input
required

ListProjectsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListProjectsResponse

default

The default response on an error.

Error

List ready flows.

POST /api/v1/df/listReadyflows

Description

Lists ready flows.

Parameters

Type Name Schema

Body

input
required

ListReadyflowsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListReadyflowsResponse

default

The default response on an error.

Error

List active alerts for service.

POST /api/v1/df/listServiceActiveAlerts

Description

List active alerts for service.

Parameters

Type Name Schema

Body

input
required

ListServiceActiveAlertsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListServiceActiveAlertsResponse

default

The default response on an error.

Error

List events for service.

POST /api/v1/df/listServiceEvents

Description

List events for service.

Parameters

Type Name Schema

Body

input
required

ListServiceEventsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListServiceEventsResponse

default

The default response on an error.

Error

List service System metrics.

POST /api/v1/df/listServiceSystemMetrics

Description

List service System metrics.

Parameters

Type Name Schema

Body

input
required

ListServiceSystemMetricsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListServiceSystemMetricsResponse

default

The default response on an error.

Error

List services.

POST /api/v1/df/listServices

Description

Lists services.

Parameters

Type Name Schema

Body

input
required

ListServicesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListServicesResponse

default

The default response on an error.

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
required

ListUserKubernetesAccessRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ListUserKubernetesAccessResponse

default

The default response on an error.

Error

Renew workload UI certificates.

POST /api/v1/df/renewCertificates

Description

Renew workload UI certificates.

Parameters

Type Name Schema

Body

input
required

RenewCertificatesRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RenewCertificatesResponse

default

The default response on an error.

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
required

ResetServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

ResetServiceResponse

default

The default response on an error.

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
required

RevokeUserKubernetesAccessRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RevokeUserKubernetesAccessResponse

default

The default response on an error.

Error

Start diagnostics collection.

POST /api/v1/df/startGetDiagnosticsCollection

Description

Start diagnostics bundle creation and upload.

Parameters

Type Name Schema

Body

input
required

StartGetDiagnosticsCollectionRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

StartGetDiagnosticsCollectionResponse

default

The default response on an error.

Error

Updates a Project.

POST /api/v1/df/updateProject

Description

Updates a Project

Parameters

Type Name Schema

Body

input
required

UpdateProjectRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateProjectResponse

default

The default response on an error.

Error

Update service.

POST /api/v1/df/updateService

Description

Update service.

Parameters

Type Name Schema

Body

input
required

UpdateServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpdateServiceResponse

default

The default response on an error.

Error

Upgrade service.

POST /api/v1/df/upgradeService

Description

Upgrade an enabled DataFlow service to the latest version.

Parameters

Type Name Schema

Body

input
required

UpgradeServiceRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

UpgradeServiceResponse

default

The default response on an error.

Error

Definitions

AddReadyflowRequest

Request object for the AddReadyflow method

Name Description Schema

readyflowCrn
required

The ready flow CRN

string

AddReadyflowResponse

Response object for the AddReadyflow method

Name Description Schema

addedReadyflowDetail
optional

The added ready flow detail

AddedReadyflowDetails

AddedReadyflowDetails

A detailed representation of a ready flow as added by the current account

Name Description Schema

addedReadyflowCrn
required

The added ready flow crn

string

readyflow
optional

The ready flow name

ReadyflowDetails

versions
optional

The ready flow versions

< ArtifactVersion > array

AlertCondition

Alert condition

Name Description Schema

alertOperator
required

Operator for the condition

string

id
required

Id of the alert condition

string

unit
required

unit of measurement for the value

MetricUnit

value
required

Value used to for evaluation of this condition

number (double)

AlertFrequencyUnit

Alert frequency unit

Name Description Schema

abbreviation
required

Abbreviation used for this unit

string

id
required

Id of alert frequency unit

string

label
required

Label of the unit

string

ArtifactVersion

A representation of a artifact detail version

Name Description Schema

author
required

The author of the artifact

string

bucketIdentifier
required

The bucketIdentifier of the artifact

string

comments
optional

Comments about the version

string

crn
required

The artifact version CRN

string

deploymentCount
optional

The number of deployments of the artifactVersion

integer (int32)

draftCount
optional

The number of drafts associated with the version.

integer (int32)

timestamp
required

The timestamp of the artifactVersion

integer (int64)

version
required

The version of the artifactVersion

integer (int32)

CancelDeleteProjectRequest

A request to cancel the deletion of a Project that is deleting

Name Description Schema

projectCrn
required

The Project CRN.

string

projectRevision
required

The Project revision

integer (int32)

CancelDeleteProjectResponse

A response to cancelling the deletion of a Project

Type : object

CreateFlowVersionTagRequest

Request object for the CreateFlowVersionTag method.

Name Description Schema

flowVersionCrn
required

The flow version CRN.

string

tagColor
optional

The color of the version tag (optional).

string

tagName
required

The name of the version tag.

string

CreateFlowVersionTagResponse

Response object for the CreateVersionTag method.

Name Description Schema

flowVersionTag
required

Flow version tag details.

FlowVersionTag

CreateProjectRequest

A request to create a Project

Name Description Schema

description
optional

The Project description.

string

name
required

The Project name.

string

serviceCrn
required

The service CRN.

string

CreateProjectResponse

A response to create a Project

Name Description Schema

project
optional

The Project

Project

DeleteAddedReadyflowRequest

Request object for the DeleteAddedReadyFlow method

Name Description Schema

addedReadyflowCrn
required

The added ready flow CRN

string

DeleteAddedReadyflowResponse

Response object for the DeleteAddedReadyflow method

Name Description Schema

readyflowDetail
optional

The ready flow details

ReadyflowDetails

DeleteFlowRequest

Request object for the DeleteFlow method

Name Description Schema

flowCrn
required

The flow CRN

string

DeleteFlowResponse

Response object for the DeleteFlow method

Name Description Schema

flow
optional

The flow that was deleted

Flow

DeleteFlowVersionTagRequest

Request object for the DeleteFlowVersionTag method.

Name Description Schema

flowVersionCrn
required

The flow version CRN.

string

tagName
required

The name of the tag.

string

DeleteFlowVersionTagResponse

Response object for the DeleteVersionTag method.

Name Description Schema

flowVersionTag
required

Flow version tag details.

FlowVersionTag

DeleteProjectRequest

A request to delete a Project

Name Description Schema

projectCrn
required

The Project CRN.

string

projectRevision
required

The Project revision

integer (int32)

DeleteProjectResponse

A response to delete a Project

Type : object

Deployment

A deployment

Name Description Schema

activeErrorAlertCount
optional

Current count of active alerts classified as an error

integer (int64)

activeInfoAlertCount
optional

Current count of active alerts classified as an info

integer (int64)

activeWarningAlertCount
optional

Current count of active alerts classified as a warning

integer (int64)

autoscaleMaxNodes
optional

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
optional

The minimum number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is true.

integer (int32)

autoscalingEnabled
optional

Whether or not to autoscale the deployment.

boolean

cfmNifiVersion
optional

The version of NiFi being used by this deployment.

string

clusterSize
required

The initial size of the deployment

string

configurationVersion
optional

The version of the configuration for this deployment

integer (int64)

crn
required

The deployment CRN

string

currentNodeCount
optional

The current node count

integer (int32)

deployedByCrn
optional

The actor CRN of the person who deployed the flow

string

deployedByName
optional

The name of the person who deployed the flow

string

dfxLocalUrl
optional

Base URL to the dfx-local instance running this deployment

string

flowCrn
required

The deployment’s current flow CRN

string

flowMetricsScalingEnabled
optional

Whether or not to use Flow metrics to scale the deployment. May only be specified when autscalingEnabled is true.

boolean

flowName
optional

The name of the flow

string

flowVersion
optional

The version of the flow

integer (int32)

flowVersionCrn
required

The deployment’s current flow version CRN

string

lastUpdatedByName
optional

The name of the person who last updated the deployment

string

name
required

The deployment name

string

nifiUrl
optional

The url to open the deployed flow in NiFi

string

project
optional

The project information of the deployment

ProjectMeta

service
required

The DataFlow service information of the deployment

ServiceMeta

staticNodeCount
optional

The static number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is false.

integer (int32)

status
required

The deployment status

DeploymentStatus

updated
required

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, SUSPENDING_FLOW, SUSPENDED, UPDATING, TERMINATING, RESTARTING, UPGRADING, ROLLING_BACK, STOPPED, UNKNOWN, IMPORTING_FLOW, STOPPING_FLOW, FLOW_STOPPED, SUSPENDING, RESUMING, CHANGING_FLOW_VERSION)

DeploymentStatus

The status of a deployment

Name Description Schema

detailedState
required

The detailed state that the deployment is currently in

string

message
required

Detail message relating to the current status of the deployment

string

state
required

The state that the deployment is currently in

DeploymentState

DeploymentSummary

A deployment summary

Name Description Schema

activeErrorAlertCount
optional

Current count of active alerts classified as an error

integer (int64)

activeInfoAlertCount
optional

Current count of active alerts classified as an info

integer (int64)

activeWarningAlertCount
optional

Current count of active alerts classified as a warning

integer (int64)

crn
required

The deployment CRN

string

name
required

The deployment name

string

project
optional

The project information of the deployment.

ProjectMeta

service
required

The DataFlow service information of the deployment

ServiceMeta

status
required

The deployment status

DeploymentStatus

updated
required

Timestamp of the last time the deployment was modified

integer (int64)

DescribeAddedReadyflowRequest

Request object for the DescribeAddedReadyflow method

Name Description Schema

addedReadyflowCrn
required

The added ready flow CRN

string

DescribeAddedReadyflowResponse

Response object for the DescribeAddedReadyflow method

Name Description Schema

addedReadyflowDetail
optional

The added ready flow detail

AddedReadyflowDetails

DescribeDeploymentEventDetailRequest

A request to describe event details for development

Name Description Schema

deploymentCrn
required

The CRN of the deployment

string

eventCrn
required

The CRN of the event

string

DescribeDeploymentEventDetailResponse

A response to describe event details for development

Name Description Schema

eventDetail
optional

The event details

EventDetail

DescribeDeploymentRequest

A request to describe a deployment

Name Description Schema

deploymentCrn
required

The deployment CRN

string

DescribeDeploymentResponse

A response to describe a deployment

Name Description Schema

deployment
optional

The deployment

Deployment

DescribeFlowRequest

Request object for the DescribeFlow method

Name Description Schema

flowCrn
required

The flow CRN

string

DescribeFlowResponse

Response object for the DescribeFlow method

Name Description Schema

flowDetail
optional

The flow detail

Flow

DescribeProjectRequest

A request to describe a Project

Name Description Schema

projectCrn
required

The Project CRN.

string

DescribeProjectResponse

A response to describe a Project

Name Description Schema

project
required

The Project

Project

DescribeReadyflowRequest

Request object for the DescribeReadyflow method

Name Description Schema

readyflowCrn
required

The ready flow CRN

string

DescribeReadyflowResponse

Response object for the DescribeReadyflow method

Name Description Schema

readyflowDetail
optional

the ready flow detail

ReadyflowDetails

DescribeServiceEventDetailRequest

Request object for DescribeServiceEventDetail

Name Description Schema

eventCrn
required

The event CRN

string

serviceCrn
required

The service CRN

string

DescribeServiceEventDetailResponse

Response object for DescribeServiceEventDetail

Name Description Schema

event
optional

The events for the specified service

Event

DescribeServiceRequest

Request object for the DescribeService method.

Name Description Schema

serviceCrn
required

The service CRN

string

DescribeServiceResponse

Response object for the DescribeService method.

Name Description Schema

service
optional

The service

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)

DiagnosticsStatus

Diagnostics status enum.

Type : enum (INPROGRESS, FAILED, SUCCESS)

DisableServiceRequest

Request object for DisableService

Name Description Schema

persist
optional

Whether or not to retain the database records of related entities

boolean

serviceCrn
required

The service CRN.

string

terminateDeployments
optional

Whether or not to terminate all deployments associated with this DataFlow service

boolean

DisableServiceResponse

Response object for DisableService

Name Description Schema

status
optional

The DataFlow status of the service.

ServiceStatus

EnableServiceRequest

Request object for EnableService

Name Description Schema

clusterSubnets
optional

Subnets to use for the Kubernetes cluster

< string > array

environmentCrn
required

The CDP environment CRN

string

instanceType
optional

Indicates custom instance type to be used

string

kubeApiAuthorizedIpRanges
optional

The IP ranges authorized to connect to the Kubernetes API server.

< string > array

loadBalancerAuthorizedIpRanges
optional

IP Ranges that are authorized to access DF local endpoints.

< string > array

loadBalancerSubnets
optional

Subnets to use for the Load Balancer

< string > array

maxK8sNodeCount
required

The maximum number of kubernetes nodes that service may scale up under high-demand situations.

integer (int32)

minK8sNodeCount
required

The minimum number of kubernetes nodes needed for the service.

integer (int32)

podCidr
optional

CIDR range from which to assign IPs to pods in the kubernetes cluster.

string

privateCluster
optional

Indicates whether to provision private k8s cluster.

boolean

serviceCidr
optional

CIDR range from which to assign IPs to internal services in the kubernetes cluster.

string

skipPreflightChecks
optional

Indicates whether to skip Liftie’s pre-flight checks.

boolean

tags
optional

The tags to apply to service-related resources created.

< string, string > map

usePublicLoadBalancer
required

Indicates whether or not to use a public load balancer when deploying dependencies stack, such as Nginx Ingress Controller.

boolean

userDefinedRouting
optional

Indicates whether User Defined Routing (UDR) mode is enabled for AKS clusters.

boolean

EnableServiceResponse

Response object for EnableService

Name Description Schema

service
optional

The service

Service

EncryptionParameters

The encryption parameters used by the DataFlow service for K8s secret encryption and EBS volume encryption.

Name Description Schema

encryptionKeyArn
optional

The AWS KMS key ARN used for encryption of Kubernetes secrets and EBS volumes.

string

encryptionStrategy
required

The encryption strategy used by the DataFlow service.

EncryptionStrategy

EncryptionStrategy

The encryption strategy used by the DataFlow service.

Type : enum (ENVIRONMENT_LEVEL)

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

Event

An event

Name Description Schema

alertType
optional

Optional value for alerts

string

crn
required

The CRN of the event

string

description
optional

Description of the event

string

eventType
required

The type of event that occurred

string

eventValue
optional

Optional value of the event when it was triggered

number (double)

firstOccurrence
required

Timestamp of the first occurrence of this event

integer (int64)

lastOccurrence
optional

Timestamp of the last occurrence of this event

integer (int64)

lowerThreshold
optional

Optional value of the low end of the threshold that defines the event triggering condition

number (double)

lowerThresholdUnit
optional

Optional value of the units for the lower bound of the threshold

string

name
required

Name of the event

string

referenceType
required

Type of component that is identified by the referenceId.

string

severity
required

The severity of the event

string

timeToleranceMillis
optional

Optional number of milliseconds tolerated outside the threshold bounds before the event is triggered

integer (int64)

upperThreshold
optional

Optional value of the high end of the threshold that defines the event triggering condition

number (double)

upperThresholdUnit
optional

Optional value of the units for the upper bound of the threshold

string

userName
optional

The user associated with creating the event. Null for user-agnostic events.

string

EventDetail

Event details

Name Description Schema

event
optional

The event

Event

metricSummary
optional

the metric summary

MetricSummary

EventSummary

An event summary

Name Description Schema

alertType
optional

Optional value for alerts

string

crn
required

The CRN of the event

string

eventType
required

The type of event that occurred

string

firstOccurrence
required

Timestamp of the first occurrence of this event

integer (int64)

name
required

Name of the event

string

severity
required

The severity of the event

string

FilterOption

A filter option

Name Description Schema

iconClass
optional

The icon class

string

identifier
required

The filter identifier

string

label
required

The filter label

string

Flow

A representation of a versioned data flow.

Name Description Schema

author
optional

Author of the most recent version

string

createdTimestamp
optional

The created timestamp.

integer (int64)

crn
required

The artifact CRN

string

description
optional

The artifact description.

string

modifiedTimestamp
optional

The modified timestamp.

integer (int64)

name
required

The artifact name.

string

versionCount
required

The number of versions uploaded to the catalog.

integer (int32)

versions
optional

The list of artifactDetail versions

< FlowVersion > array

FlowDefinitionTagData

A representation of an artifact version tag.

Name Description Schema

tagColor
optional

The color of the version tag (optional).

string

tagName
required

The name of the version tag.

string

FlowDefinitionVersionTagData

A representation of an artifact version tag.

Name Description Schema

tagColor
optional

The color of the version tag (optional).

string

tagName
required

The name of the version tag.

string

FlowSummary

A summarized version of a flow, mostly useful in listing flows

Name Description Schema

artifactType
required

The type of artifact

string

crn
required

The artifact CRN

string

modifiedTimestamp
optional

The modified timestamp.

integer (int64)

name
required

The artifact name.

string

versionCount
required

The number of versions uploaded to the catalog.

integer (int32)

FlowVersion

A representation of a flow detail version

Name Description Schema

author
optional

The author of the flow

string

bucketIdentifier
optional

The bucketIdentifier of the flow

string

comments
optional

Comments about the flow

string

crn
required

The flow version CRN

string

deploymentCount
optional

The number of deployments of the flow

integer (int32)

draftCount
optional

The number of draft flows associated with the version.

integer (int32)

tags
optional

The list of tags associated with the flow version.

< FlowVersionTag > array

timestamp
optional

The timestamp of the flow

integer (int64)

version
optional

The version of the flow

integer (int32)

FlowVersionTag

A representation of an artifact version tag.

Name Description Schema

tagColor
optional

The color of the version tag (optional).

string

tagName
required

The name of the version tag.

string

GetFlowVersionRequest

Request object for the GetFlowVersion method.

Name Description Schema

flowVersionCrn
required

The Flow Version CRN.

string

GetFlowVersionResponse

Response object for the GetFlowVersion method.

Name Description Schema

flowDefinition
optional

the flow definition.
Pattern : "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

string (byte)

GetKubeconfigRequest

Request object for GetKubeconfig.

Name Description Schema

serviceCrn
required

The service CRN.

string

GetKubeconfigResponse

Response object for GetKubeconfig.

Name Description Schema

kubeconfig
required

The kubernetes configuration of the environment.

string

GrantUserKubernetesAccessRequest

The request for granting access

Name Description Schema

cloudUserId
required

The user to grant remote access for

string

serviceCrn
required

The service CRN.

string

GrantUserKubernetesAccessResponse

The response for granting access

Name Description Schema

cloudUserId
required

The cloudUserId for the newly granted user

string

ImportFlowDefinitionRequest

Request object for ImportFlowDefinition

Name Description Schema

comments
optional

The comments of the flow.

string

description
optional

The description of the flow.

string

file
required

The file to be uploaded.

string

name
required

The name of the flow.

string

tags
optional

The list of tags for the initial flow definition version

< FlowDefinitionTagData > array

ImportFlowDefinitionResponse

Response object for ImportFlowDefinition

Name Description Schema

author
optional

Author of the most recent version

string

createdTimestamp
optional

The created timestamp.

integer (int64)

crn
required

The artifact CRN

string

description
optional

The artifact description.

string

modifiedTimestamp
optional

The modified timestamp.

integer (int64)

name
required

The artifact name.

string

versionCount
required

The number of versions uploaded to the catalog.

integer (int32)

versions
optional

The list of artifactDetail versions

< FlowVersion > array

ImportFlowDefinitionVersionRequest

Request object for ImportFlowDefinitionVersion

Name Description Schema

comments
optional

The comments of the flow version.

string

file
required

The file to be uploaded.

string

flowCrn
required

The CRN of the previously uploaded flow.

string

tags
optional

The tags for the flow version.

< FlowDefinitionVersionTagData > array

ImportFlowDefinitionVersionResponse

Response object for ImportFlowDefinitionVersion

Name Description Schema

author
optional

The author of the flow

string

bucketIdentifier
optional

The bucketIdentifier of the flow

string

comments
optional

Comments about the flow

string

crn
required

The flow version CRN

string

deploymentCount
optional

The number of deployments of the flow

integer (int32)

tags
optional

The tags for the flow version.

< FlowVersionTag > array

timestamp
optional

The timestamp of the flow

integer (int64)

version
optional

The version of the flow

integer (int32)

InitiateDeploymentRequest

A request to initiate a deployment

Name Description Schema

deploymentCrn
optional

The deployment CRN for a deployment where change flow version is being performed.

string

flowVersionCrn
required

The flow version CRN.

string

serviceCrn
required

The service CRN.

string

InitiateDeploymentResponse

A response from initiating a deployment

Name Description Schema

deploymentRequestCrn
required

The newly created deployment request CRN.

string

dfxLocalUrl
required

Base URL to the dfx-local instance running an eventually created deployment

string

ListDeployableServicesForNewDeploymentsRequest

Request object for the ListDeployableServicesForNewDeploymentsRequest method.

Type : object

ListDeployableServicesForNewDeploymentsResponse

Response object for the ListDeployableServicesForNewDeploymentsRequest method.

Name Description Schema

services
optional

The services.

< ServiceSummary > array

ListDeploymentActiveAlertsRequest

A request to list active alerts for deployment

Name Description Schema

deploymentCrn
required

The deployment CRN

string

sort
optional

Sort criteria

string

ListDeploymentActiveAlertsResponse

A response to list active alerts for deployment

Name Description Schema

eventSummaries
optional

The events for the specified deployment

< EventSummary > array

ListDeploymentEventsRequest

A request to list event history for deployment

Name Description Schema

deploymentCrn
required

The deployment CRN

string

filters
optional

Filter criteria

< string > array

rows
optional

Max number of rows to return

integer (int32)

timestampFrom
optional

Timestamp from when to list events prior

integer (int64)

ListDeploymentEventsResponse

A response to list event history for deployment

Name Description Schema

eventSummaries
optional

The events

< EventSummary > array

ListDeploymentKPIsRequest

A request to list deployment KPIs

Name Description Schema

deploymentCrn
required

The deployment CRN

string

metricsTimePeriod
required

The metrics time period

string

ListDeploymentKPIsResponse

A response to list deployment KPIs

Name Description Schema

metricCharts
optional

The metrics for the configured KPIs

< MetricChart > array

ListDeploymentSystemMetricsRequest

A request to list deployment system metrics

Name Description Schema

deploymentCrn
required

The deployment CRN

string

metricsTimePeriod
required

The metrics time period

string

ListDeploymentSystemMetricsResponse

A response to list deployment system metrics

Name Description Schema

metricCharts
optional

The metrics for the configured KPIs

< MetricChart > array

ListDeploymentsRequest

A request to list deployments

Name Description Schema

filters
optional

The filter criteria

< string > array

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

sorts
optional

The sort criteria

< string > array

startingToken
optional

The token pointing to the next element to be retrieved.

string

ListDeploymentsResponse

A response from listing deployments

Name Description Schema

deployments
optional

The listing of deployments in this page

< DeploymentSummary > array

nextToken
optional

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
required

DataFlow Service CRN from which to list diagnostics.

string

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

startingToken
optional

The token pointing to the next element to be retrieved.

string

uuids
optional

List of UUIDs to list in the response.

< string > array

ListDiagnosticsResponse

Response object for ListDiagnostics.

Name Description Schema

diagnostics
optional

List of previous and current diagnostics requests for a given DataFlow Service.

< ListDiagnosticsResponseItem > array

nextToken
optional

The page token for requesting the next page of results.

string

ListDiagnosticsResponseItem

Object representation of a diagnostics request list item.

Name Description Schema

bundleCloudPath
optional

Cloud storage path of the bundle, only populated for CLOUD_STORAGE destinations.

string

caseNumber
optional

Support case number associated with the collection.

string

collectionScope
optional

Collection scope.

DiagnosticsCollectionScope

deployments
optional

List of Flow deployments included in the collection.

< string > array

description
required

User provided description of request.

string

destination
required

Upload destination.

DiagnosticsDestination

dfServiceCrn
required

DataFlow Service CRN.

string

endTime
optional

Time to which to collect logs.

string

environmentComponents
optional

List of environment components included in the collection.

< DiagnosticsEnvironmentComponent > array

requestedTime
optional

Time at which the collection was requested.

string

startTime
optional

Time from which to collect logs.

string

status
required

Status of request.

DiagnosticsStatus

uuid
optional

Uuid of the collection.

string

ListFilterOptionsRequest

A request to list filter options

Name Description Schema

filterType
required

The type of filter

string

ListFilterOptionsResponse

A response to list filter options

Name Description Schema

filterOptions
optional

The filter options

< FilterOption > array

ListFlowDefinitionVersionsRequest

Request object for the ListFlowDefinitionVersions method.

Name Description Schema

flowCrn
required

The flow CRN

string

searchTerm
optional

Search term to use in the list of tags

string

ListFlowDefinitionVersionsResponse

Response object for the ListFlowDefinitionVersions method.

Name Description Schema

flowVersions
optional

The list of matching flow versions

< FlowVersion > array

ListFlowDefinitionsRequest

Request object for the ListFlowDefinitions method.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

searchTerm
optional

Search term to filter by name

string

sorts
optional

The sort criteria

< string > array

startingToken
optional

The token pointing to the next element to be retrieved.

string

ListFlowDefinitionsResponse

Response object for the ListFlowDefinitions method.

Name Description Schema

flows
optional

The flows.

< FlowSummary > array

nextToken
optional

The page token for requesting the next page of results.

string

ListFlowVersionTagsRequest

Request object for the ListFlowVersionTags method.

Name Description Schema

flowVersionCrn
required

The flow version CRN.

string

ListFlowVersionTagsResponse

Response object for the ListFlowVersionTags method.

Name Description Schema

flowVersionTags
optional

The flow version tag data.

< FlowVersionTag > array

ListNotificationsRequest

The request for retrieving notifications

Name Description Schema

timestampAfter
required

Timestamp from when to list notifications since

integer (int64)

ListNotificationsResponse

The response for retrieving notifications

Name Description Schema

notifications
optional

The notifications

< Notification > array

ListProjectFilterOptionsRequest

A request to list filter options

Name Description Schema

filterType
required

The type of filter

string

ListProjectFilterOptionsResponse

A response to list filter options

Name Description Schema

filterOptions
optional

The filter options

< ProjectFilterOption > array

ListProjectsRequest

A request to list Projects

Name Description Schema

filters
optional

The filter criteria

< string > array

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

sorts
optional

The sort criteria

< string > array

startingToken
optional

The token pointing to the next element to be retrieved.

string

ListProjectsResponse

A response to list Projects

Name Description Schema

nextToken
optional

The page token for requesting the next page of results.

string

projects
optional

The listing of Projects.

< Project > array

ListReadyflowsRequest

Request object for the ListReadyflows method.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

searchTerm
optional

Search term by which to filter (optional)

string

startingToken
optional

The token pointing to the next element to be retrieved.

string

ListReadyflowsResponse

Response object for the ListReadyflows method.

Name Description Schema

nextToken
optional

The page token for requesting the next page of results.

string

readyflows
optional

The ready flows

< ReadyflowSummary > array

ListServiceActiveAlertsRequest

Request object for ListServiceActiveAlerts

Name Description Schema

serviceCrn
required

The service CRN

string

sort
optional

Sort criteria

string

ListServiceActiveAlertsResponse

Response object for ListServiceActiveAlerts

Name Description Schema

eventSummaries
optional

The events for the specified service

< EventSummary > array

ListServiceEventsRequest

Request object for ListServiceEvents

Name Description Schema

filters
optional

Filter criteria

< string > array

rows
optional

Max number of rows to return

integer (int32)

serviceCrn
required

The service CRN

string

timestampFrom
optional

Timestamp from when to list events prior

integer (int64)

ListServiceEventsResponse

Response object for ListServiceEvents

Name Description Schema

eventSummaries
optional

The events for the specified service

< EventSummary > array

ListServiceSystemMetricsRequest

A request to list service system metrics

Name Description Schema

metricsTimePeriod
required

The metrics time period

string

serviceCrn
required

The service CRN

string

ListServiceSystemMetricsResponse

A response to list service system metrics

Name Description Schema

metricCharts
optional

The system metrics for the service

< MetricChart > array

ListServicesRequest

Request object for the ListServices method.

Name Description Schema

pageSize
optional

The page size.
Minimum value : 1
Maximum value : 100

integer (int32)

searchTerm
optional

Search term to filter by name

string

sorts
optional

The sort criteria

< string > array

startingToken
optional

The token pointing to the next element to be retrieved.

string

ListServicesResponse

Response object for the ListServices method.

Name Description Schema

nextToken
optional

The page token for requesting the next page of results.

string

services
optional

The services.

< ServiceSummary > array

ListUserKubernetesAccessRequest

The request for listing the users that have access to a cluster

Name Description Schema

serviceCrn
required

The service CRN.

string

ListUserKubernetesAccessResponse

The response for listing the users that have access to a cluster

Name Description Schema

cloudUserIds
optional

The cloudUserId for the newly granted user

< string > array

MetricChart

A metric chart

Name Description Schema

alert
required

The optional thresholds associated with the alert on a metric

MetricChartAlert

componentName
optional

The scope component name that will exist for Processor, Process Group, and Connection metrics.

string

componentType
required

The component type of the metric

string

metrics
required

The chart metrics

MetricChartData

mirroredMetrics
required

The optional mirrored metrics that only exist for certain system metrics

MetricChartData

name
required

The name of the metric

string

unitType
required

The unit type of the metric

string

MetricChartAlert

Thresholds associated with a metric

Name Description Schema

frequencyTolerance
required

The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated

MetricChartFrequencyTolerance

thresholdLessThan
optional

The lessThan threshold for the alert

number (double)

thresholdMoreThan
optional

The moreThan threshold for the alert

number (double)

MetricChartData

Chart data of metrics

Name Description Schema

averageValue
required

The average value of the data

number (double)

averageValueLabel
required

The average value label

string

currentValue
required

The most recent value in the list of data points

number (double)

currentValueLabel
required

The current value label

string

datas
optional

The list of data points (in time-order) for the metric

< MetricValue > array

tooltipValueLabel
required

The tooltip value label

string

MetricChartFrequencyTolerance

Frequency tolerance for a metric chart

Name Description Schema

unit
required

The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated

string

value
required

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
optional

Units of frequency

AlertFrequencyUnit

alertFrequencyValue
optional

Frequency value

number (double)

componentId
optional

Id of the component monitored

string

componentName
optional

The scope component name that will exist for Processor, Process Group, and Connection metrics.

string

componentType
optional

The component type of the metric

string

description
optional

The description of the metric

string

displayContext
optional

Display context of the metric

string

label
required

The label of the metric

string

lowerBoundCondition
optional

Lower boundary condition

AlertCondition

name
required

The name of the metric

string

unitType
optional

The unit type of the metric

string

upperBoundCondition
optional

Upper boundary condition

AlertCondition

values
optional

Values for the metric

< MetricValue > array

MetricUnit

Metric unit

Name Description Schema

abbreviation
optional

abbreviation used for this unit

string

conversionValue
optional

conversion value to use when converting between units

integer (int64)

displayLabel
required

display label for the unit

string

id
required

Id of the metric unit

string

metricUnitType
optional

type of unit (DURATION, RATIO, SIZE, RATE, COUNT)

string

name
required

Name of the unit

string

ordinal
optional

ordinal used when positioning the unit in a list (sort order)

integer (int32)

MetricValue

A metric value

Name Description Schema

timestamp
required

The timestamp of this data point

integer (int64)

value
required

The value of this data point

number (double)

Notification

A notification for an event

Name Description Schema

description
required

The description of the notification

string

eventId
required

The id of the event that triggered this notification

string

name
required

The name of the notification

string

referenceId
required

The id of the component referenced by this notification

string

referenceType
required

The type of component referenced by this notification

string

severity
required

The severity of the notification

string

timestamp
required

The timestamp of the event that triggered this notification

integer (int64)

username
required

The user associated with the notification

string

Project

A Project

Name Description Schema

created
required

The created timestamp.

integer (int64)

crn
required

The Project CRN.

string

deleting
optional

Whether or not the project is currently deleting

boolean

description
optional

The Project description.

string

name
required

The Project name.

string

revision
required

The Project revision

integer (int32)

service
required

The DataFlow service information of the Project

ServiceMeta

updated
required

The last updated timestamp.

integer (int64)

ProjectFilterOption

A filter option

Name Description Schema

iconClass
optional

The icon class

string

identifier
required

The filter identifier

string

label
required

The filter label

string

ProjectMeta

Metadata about a project.

Name Description Schema

crn
required

The crn of the project.

string

id
required

The id of the project.

string

name
required

The name of the group.

string

ReadyflowDetails

A detailed representation of a ready flow.

Name Description Schema

author
required

The author of the most recent version

string

description
optional

The ready flow description (long)

string

destination
optional

The ready flow data destination

string

destinationDataFormat
optional

The ready flow data destination format

string

documentationLink
optional

A link to the ready flow documentation

string

imported
optional

Whether the ready flow has been imported into the current account

boolean

modifiedTimestamp
optional

The modified timestamp.

integer (int64)

name
required

The ready flow name

string

notes
optional

Optional notes about the ready flow

string

readyflowCrn
required

The ready flow CRN

string

source
optional

The ready flow data source

string

sourceDataFormat
optional

The ready flow data source format

string

summary
optional

The ready flow summary (short)

string

ReadyflowSummary

A summarized version of a ready flow, mostly useful in listing flows

Name Description Schema

destination
optional

The ready flow destination

string

imported
optional

Whether the ready flow has been imported into the current account

boolean

importedArtifactCrn
optional

The crn of the imported ready flow, used to look up its details

string

latestVersion
optional

The latest version of the ready flow

integer (int32)

name
required

The ready flow name

string

readyflowCrn
required

The ready flow CRN

string

source
optional

The ready flow source

string

summary
optional

The ready flow summary

string

RenewCertificatesRequest

Request object for RenewCertificates

Name Description Schema

serviceCrn
required

The service CRN.

string

RenewCertificatesResponse

Response object for RenewCertificates

Type : object

ResetServiceRequest

Request object for ResetService

Name Description Schema

serviceCrn
required

The serviceCrn CRN.

string

ResetServiceResponse

Response object for ResetService

Type : object

RevokeUserKubernetesAccessRequest

The request for revoking access

Name Description Schema

cloudUserId
required

The user to revoke remote access for

string

serviceCrn
required

The service CRN.

string

RevokeUserKubernetesAccessResponse

The response for revoking access

Name Description Schema

cloudUserId
required

The cloudUserId of the newly revoked user

string

Service

The DataFlow view of a CDP service.

Name Description Schema

activeErrorAlertCount
optional

Current count of active alerts classified as an error

integer (int64)

activeInfoAlertCount
optional

Current count of active alerts classified as an info

integer (int64)

activeWarningAlertCount
optional

Current count of active alerts classified as a warning

integer (int64)

availableK8sVersionUpgrade
optional

The available kubernetes version that cluster can be upgraded to.

string

cloudPlatform
required

The cloud platform of the service.

string

clusterId
optional

Cluster id of the service, if enabled

string

clusterSubnets
optional

Subnets to use for the Kubernetes cluster

< string > array

clusterUsable
optional

Whether or not a successfully created and usable cluster exists. Deprecated. Use 'validActions' instead.

boolean

creatingK8sNodeCount
optional

The number of kubernetes nodes currently under creation for this service.

integer (int32)

crn
required

The service CRN.

string

deploymentCount
required

The deployment count.

integer (int32)

dfLocalUrl
optional

The URL of the service local DataFlow application.

string

encryptionParameters
optional

The encryption parameters used by DataFlow service for encrypting K8s secrets and EBS volumes.

EncryptionParameters

environmentCrn
required

The CDP Environment CRN

string

instanceType
optional

The instance type of the kubernetes nodes currently in use by DataFlow for this service.

string

k8sServerVersion
optional

The kubernetes version of the cluster

string

kubeApiAuthorizedIpRanges
optional

The IP Ranges authorized to connect to the Kubernetes API Server.

< string > array

loadBalancerAuthorizedIpRanges
optional

IP Ranges that are authorized to access CDF local endpoints.

< string > array

loadBalancerSubnets
optional

Subnets to use for the Load Balancer

< string > array

maxK8sNodeCount
required

The maximum number of kubernetes nodes that service may scale up under high-demand situations

integer (int32)

minK8sNodeCount
required

The minimum number of Kubernetes nodes that need to be provisioned in the service

integer (int32)

name
required

The service name.

string

podCidr
optional

CIDR range from which to assign IPs to pods in the kubernetes cluster.

string

privateCluster
optional

Whether the k8s cluster is private or not.

boolean

proxyName
optional

The name of the proxy that is configured for the CDP environment

string

region
required

The region of the service.

string

runningK8sNodeCount
optional

The number of kubernetes nodes currently running for this service.

integer (int32)

serviceCidr
optional

CIDR range from which to assign IPs to internal services in the kubernetes cluster.

string

status
required

The DataFlow status of the service.

ServiceStatus

tags
optional

The tags to apply to service related resources created

< string, string > map

terminatingK8sNodeCount
optional

The number of kubernetes nodes currently terminating for this service.

integer (int32)

usePublicLoadBalancer
optional

Whether or not a public load balancer is exposed.

boolean

userDefinedRouting
optional

Whether User Defined Routing (UDR) mode is enabled for AKS clusters or not.

boolean

validActions
optional

Valid actions that can be applied based on the current state of the service

< string > array

workloadVersion
required

The workload version of the service.

string

ServiceMeta

Metadata about a service

Name Description Schema

cloudProvider
required

the cloud provider

string

crn
required

The crn of the service

string

environmentCrn
required

The CDP Environment CRN

string

name
required

the name of the environment

string

region
required

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)

ServiceStatus

The status of a DataFlow enabled service.

Name Description Schema

detailedState
optional

The detailed state of the service.

string

message
optional

A status message for the service.

string

state
required

The state of the service.

ServiceState

ServiceSummary

The summary of the DF Service enabled in a CDP Environment

Name Description Schema

activeErrorAlertCount
optional

Current count of active alerts classified as an error

integer (int64)

activeInfoAlertCount
optional

Current count of active alerts classified as an info

integer (int64)

activeWarningAlertCount
optional

Current count of active alerts classified as a warning

integer (int64)

cloudPlatform
required

The cloud platform of the service.

string

clusterId
optional

Cluster id of the service, if enabled

string

clusterUsable
optional

Whether or not a successfully created and usable cluster exists. Deprecated. Use 'validActions' instead.

boolean

crn
required

The service CRN.

string

deploymentCount
required

The deployment count.

integer (int32)

environmentCrn
required

The CDP Environment CRN

string

instanceType
optional

The instance type of the kubernetes nodes currently in use by DataFlow for this service.

string

maxK8sNodeCount
required

The maximum number of kubernetes nodes that service may scale up under high-demand situations

integer (int32)

name
required

The service name.

string

proxyName
optional

The name of the proxy that is configured for the CDP environment

string

region
required

The region of the service.

string

runningK8sNodeCount
optional

The number of kubernetes nodes currently running for this service.

integer (int32)

status
required

The DataFlow status of the service.

ServiceStatus

validActions
optional

Valid actions that can be applied based on the current state of the service

< string > array

workloadVersion
required

The workload version of the service.

string

StartGetDiagnosticsCollectionRequest

Request to start DataFlow diagnostics bundle creation.

Name Description Schema

caseNumber
optional

Support case number associated with this request.

string

collectionScope
optional

Collection scope.

DiagnosticsCollectionScope

deployments
optional

List of deployments to collect diagnostics from, if none are specified, all deployments will be included.

< string > array

description
required

Description of diagnostics collection.

string

destination
required

Destination location.

DiagnosticsDestination

dfServiceCrn
required

DataFlow Service CRN from which to collect diagnostics.

string

endTime
optional

Date-time to which component logs will be collected, starting from startTime.

string

environmentComponents
optional

List of environment components for which logs should be collected.

< DiagnosticsEnvironmentComponent > array

includeNifiDiagnostics
optional

Indicates if the heap and thread dumps are needed for a flow.

boolean

startTime
optional

Date-time from which component logs will be collected, up until endTime.

string

StartGetDiagnosticsCollectionResponse

Response object for StartGetDiagnosticsCollection.

Name Description Schema

uuid
required

UUID of the bundle request.

string

UpdateProjectRequest

A request to describe a Project

Name Description Schema

projectCrn
required

The Project CRN.

string

projectDescription
optional

The new Project description.

string

projectName
optional

The new Project name.

string

projectRevision
required

The Project revision

integer (int32)

UpdateProjectResponse

A response to describe a Project

Name Description Schema

project
required

The Project

Project

UpdateServiceRequest

Request object for UpdateService

Name Description Schema

kubeApiAuthorizedIpRanges
optional

The IP Ranges authorized to connect to the Kubernetes API Server.

< string > array

loadBalancerAuthorizedIpRanges
optional

IP Ranges that are authorized to access CDF local endpoints.

< string > array

maxK8sNodeCount
required

The maximum number of kubernetes nodes that service may scale up under high-demand situations.

integer (int32)

minK8sNodeCount
required

The minimum number of kubernetes nodes needed for the service.

integer (int32)

serviceCrn
required

The service CRN.

string

skipPreflightChecks
optional

Indicates whether to skip Liftie’s pre-flight checks.

boolean

UpdateServiceResponse

Response object for UpdateService

Name Description Schema

service
optional

The service.

Service

UpgradeServiceRequest

Request object for UpgradeService

Name Description Schema

serviceCrn
required

The service CRN.

string

skipPreflightChecks
optional

Indicates whether or not to skip preflight checks when upgrading the workload cluster.

boolean

upgradeDeploymentsNifiVersion
optional

Indicates whether deployments NiFi version need to be upgraded; defaults to false
Default : false

boolean

UpgradeServiceResponse

Response object for UpgradeService

Name Description Schema

service
optional

The service.

Service

Copyright © 2024 Cloudera, Inc. All rights reserved.