Cloudera CloudPrivateLinks API Service

Overview

Provisions PrivateLink Endpoints on the cloud environments.

Version information

Version : 0.9.112

License information

License : Apache 2.0
Terms of service : https://www.cloudera.com/legal/commercial-terms-and-conditions.html

URI scheme

Schemes : HTTPS

Consumes

application/json

Produces

application/json

Paths

Authorize private link services access for the cloud account id.

POST /api/v1/cloudprivatelinks/authorizePrivateLinkServiceAccess

Description

Returns the list of private link service name and its respective authorization status.

Parameters

Type	Name	Schema
Body	input required	AuthorizePrivateLinkServiceAccessRequest

Type

Name

Schema

Body

input
required

AuthorizePrivateLinkServiceAccessRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	AuthorizePrivateLinkServiceAccessResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

AuthorizePrivateLinkServiceAccessResponse

default

The default response on an error.

Error

Creates PrivateLink endpoints.

POST /api/v1/cloudprivatelinks/createPrivateLinkEndpoint

Description

Creates the PrivateLink Endpoints for specified CDP service components.

Parameters

Type	Name	Schema
Body	input required	CreatePrivateLinkEndpointRequest

Type

Name

Schema

Body

input
required

CreatePrivateLinkEndpointRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	CreatePrivateLinkEndpointResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

CreatePrivateLinkEndpointResponse

default

The default response on an error.

Error

Deletes PrivateLink endpoints.

POST /api/v1/cloudprivatelinks/deletePrivateLinkEndpoint

Description

Deletes the PrivateLink Endpoints for specified CDP service components.

Parameters

Type	Name	Schema
Body	input required	DeletePrivateLinkEndpointRequest

Type

Name

Schema

Body

input
required

DeletePrivateLinkEndpointRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	DeletePrivateLinkEndpointResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

DeletePrivateLinkEndpointResponse

default

The default response on an error.

Error

Gets the statuses of PrivateLink endpoints.

POST /api/v1/cloudprivatelinks/getPrivateLinkEndpointStatus

Description

Returns the statuses of the PrivateLink endpoints in creation/deletion. Please use ListPrivateLinkEndpointStatuses as replacement. Deprecated.

Parameters

Type	Name	Schema
Body	input required	GetPrivateLinkEndpointStatusRequest

Type

Name

Schema

Body

input
required

GetPrivateLinkEndpointStatusRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	GetPrivateLinkEndpointStatusResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

GetPrivateLinkEndpointStatusResponse

default

The default response on an error.

Error

Lists the statuses of the PrivateLink endpoints that are in creation/deletion status.

POST /api/v1/cloudprivatelinks/listPrivateLinkEndpointStatuses

Description

Returns the statuses of the PrivateLink endpoints in creation/deletion.

Parameters

Type	Name	Schema
Body	input required	ListPrivateLinkEndpointStatusesRequest

Type

Name

Schema

Body

input
required

ListPrivateLinkEndpointStatusesRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	ListPrivateLinkEndpointStatusesResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

ListPrivateLinkEndpointStatusesResponse

default

The default response on an error.

Error

Lists the PrivateLink services that are supported for the region and service group.

POST /api/v1/cloudprivatelinks/listPrivateLinkServicesForRegion

Description

Returns the list of private link service name and the mapped service component.

Parameters

Type	Name	Schema
Body	input required	ListPrivateLinkServicesForRegionRequest

Type

Name

Schema

Body

input
required

ListPrivateLinkServicesForRegionRequest

Responses

HTTP Code	Description	Schema
200	Expected response to a valid request.	ListPrivateLinkServicesForRegionResponse
default	The default response on an error.	Error

HTTP Code

Description

Schema

200

Expected response to a valid request.

ListPrivateLinkServicesForRegionResponse

default

The default response on an error.

Error

Definitions

AWSAccountDetails

Details of the cloud network and the cross-account role required to create the PrivateLink endpoint.

Name	Description	Schema
cloudAccountId optional	Account ID to authorize access for PrivateLink.	string
credentialCrn optional	CDP Credential CRN to fetch the AWS cross-account RoleArn for the account where the endpoint gets deleted.	string
crossAccountRoleDetails optional	Cross account role details.	CrossAccountRoleDetails
region optional	Region in which VPC exists.	string
subnetIds optional	IDs of the private subnets in which the private link should be created.	< string > array
vpcId optional	VPC ID in which the private link should be created.	string

Name

Description

Schema

cloudAccountId
optional

Account ID to authorize access for PrivateLink.

string

credentialCrn
optional

CDP Credential CRN to fetch the AWS cross-account RoleArn for the account where the endpoint gets deleted.

string

crossAccountRoleDetails
optional

Cross account role details.

CrossAccountRoleDetails

region
optional

Region in which VPC exists.

string

subnetIds
optional

IDs of the private subnets in which the private link should be created.

< string > array

vpcId
optional

VPC ID in which the private link should be created.

string

AWSAccountInfo

Details of the cloud network and the cross-account role required to delete the PrivateLink endpoint.

Name	Description	Schema
credentialCrn optional	CDP Credential CRN to fetch the AWS cross-account roleArn for the account where the endpoint gets deleted.	string
crossAccountRoleDetails optional	Cross account role details.	CrossAccountRoleDetails
region optional	Region in which VPC exists.	string
vpcId optional	VPC ID in which the vpc endpoint should be deleted.	string

Name

Description

Schema

credentialCrn
optional

CDP Credential CRN to fetch the AWS cross-account roleArn for the account where the endpoint gets deleted.

string

crossAccountRoleDetails
optional

Cross account role details.

CrossAccountRoleDetails

region
optional

Region in which VPC exists.

string

vpcId
optional

VPC ID in which the vpc endpoint should be deleted.

string

AuthorizePrivateLinkServiceAccessRequest

Request object for the AuthorizePrivateLinkServicesAccess method.

Name	Description	Schema
cloudAccountId optional	Account ID to authorize access for PrivateLink.	string
region optional	Region where the private link service exists.	string
serviceComponents optional	CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].	< string > array
serviceGroup optional	CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS.	string

Name

Description

Schema

cloudAccountId
optional

Account ID to authorize access for PrivateLink.

string

region
optional

Region where the private link service exists.

string

serviceComponents
optional

CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].

< string > array

serviceGroup
optional

CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS.

string

AuthorizePrivateLinkServiceAccessResponse

Response object for the AuthorizePrivateLinkServicesAccess method.

Name	Description	Schema
authorizePrivateLinkServiceAccessResults optional	List of AuthorizePrivateLinkServiceAccessResult objects.	< AuthorizePrivateLinkServiceAccessResult > array

Name

Description

Schema

authorizePrivateLinkServiceAccessResults
optional

List of AuthorizePrivateLinkServiceAccessResult objects.

< AuthorizePrivateLinkServiceAccessResult > array

AuthorizePrivateLinkServiceAccessResult

Authorization response containing PrivateLink service name, service component and its authorization status.

Name	Description	Schema
authorizationStatus optional	Authorization status for the private link service.	string
availabilityZoneList optional	Availability zone list.	string
hostname optional	Hostname of the Private Link Service.	string
privateLinkService optional	Name of the Private link service.	string
serviceComponent optional	CDP service component.	string
vpceClientTcpPortList optional	VPCE Client TCP port list.	string

Name

Description

Schema

authorizationStatus
optional

Authorization status for the private link service.

string

availabilityZoneList
optional

Availability zone list.

string

hostname
optional

Hostname of the Private Link Service.

string

privateLinkService
optional

Name of the Private link service.

string

serviceComponent
optional

CDP service component.

string

vpceClientTcpPortList
optional

VPCE Client TCP port list.

string

AzureAccountDetails

Details of the cloud network and the cross-account role required to create the PrivateLink endpoint.

Name	Description	Schema
azureClientSecretCredential optional	Azure client secret credential, either this or credential CRN should be passed.	AzureClientSecretCredential
credentialCrn optional	CDP Credential CRN to fetch the Azure client secret credentials, either this or AzureClientSecretCredential should be passed.	string
location optional	Azure location where endpoint should be created.	string
resourceGroup optional	The Resource group under which the Private endpoint to be created.	string
subnetId optional	ID of the private subnet in which the private link should be created.	string
subscriptionId optional	The Subscription for which the Private link service to be allowed/accessible.	string
vNetId optional	vNet ID in which the private link should be created.	string

Name

Description

Schema

azureClientSecretCredential
optional

Azure client secret credential, either this or credential CRN should be passed.

AzureClientSecretCredential

credentialCrn
optional

CDP Credential CRN to fetch the Azure client secret credentials, either this or AzureClientSecretCredential should be passed.

string

location
optional

Azure location where endpoint should be created.

string

resourceGroup
optional

The Resource group under which the Private endpoint to be created.

string

subnetId
optional

ID of the private subnet in which the private link should be created.

string

subscriptionId
optional

The Subscription for which the Private link service to be allowed/accessible.

string

vNetId
optional

vNet ID in which the private link should be created.

string

AzureAccountInfo

Details of the cloud network and the cross-account role required to delete the PrivateLink endpoint.

Name	Description	Schema
azureClientSecretCredential optional	Azure client secret credential, either this or credential CRN should be passed.	AzureClientSecretCredential
credentialCrn optional	CDP Credential CRN to fetch the Azure client secret credentials, either this or AzureClientSecretCredential should be passed.	string
location optional	Region in which VPC exists.	string
vNetId optional	vNet ID in which the private link should be created.	string

Name

Description

Schema

azureClientSecretCredential
optional

Azure client secret credential, either this or credential CRN should be passed.

AzureClientSecretCredential

credentialCrn
optional

CDP Credential CRN to fetch the Azure client secret credentials, either this or AzureClientSecretCredential should be passed.

string

location
optional

Region in which VPC exists.

string

vNetId
optional

vNet ID in which the private link should be created.

string

AzureClientSecretCredential

Azure client secret credential, either this or credential CRN should be passed.

Name	Description	Schema
clientId optional	The client (application) ID of the service principal	string
clientSecret optional	A client secret that was generated for the App Registration used to authenticate the client.	string
tenantId optional	The Azure Active Directory tenant (directory) Id of the service principal.	string

Name

Description

Schema

clientId
optional

The client (application) ID of the service principal

string

clientSecret
optional

A client secret that was generated for the App Registration used to authenticate the client.

string

tenantId
optional

The Azure Active Directory tenant (directory) Id of the service principal.

string

CloudServiceProvider

Supported cloud providers AWS - A value indicating AWS as supported cloud provider for creating privatelinks. AZURE - A value indicating Azure as supported cloud provider for creating privatelinks.

Type : enum (AWS, AZURE)

CreatePrivateLinkEndpointRequest

Request object for the CreatePrivateLinkEndpoint method.

Name	Description	Schema
awsAccountDetails optional	AWS account details where the PrivateLink endpoint is created.	AWSAccountDetails
azureAccountDetails optional	Azure account details where PrivateLink endpoint is created.	AzureAccountDetails
cloudServiceProvider optional	Cloud Service Provider. Currently supporting AWS and Azure.	CloudServiceProvider
enablePrivateDns optional	Enable Private DNS for PrivateLink endpoint.	boolean
environmentCrn optional	CRN of the CDP environment in AWS cloud where the PrivateLink endpoint is created.	string
serviceComponents optional	CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].	< string > array
serviceGroup optional	CDP service group.	string

Name

Description

Schema

awsAccountDetails
optional

AWS account details where the PrivateLink endpoint is created.

AWSAccountDetails

azureAccountDetails
optional

Azure account details where PrivateLink endpoint is created.

AzureAccountDetails

cloudServiceProvider
optional

Cloud Service Provider. Currently supporting AWS and Azure.

CloudServiceProvider

enablePrivateDns
optional

Enable Private DNS for PrivateLink endpoint.

boolean

environmentCrn
optional

CRN of the CDP environment in AWS cloud where the PrivateLink endpoint is created.

string

serviceComponents
optional

CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].

< string > array

serviceGroup
optional

CDP service group.

string

CreatePrivateLinkEndpointResponse

Response object for the CreatePrivateLinkEndpoint method.

Name	Description	Schema
trackingId optional	Tracking ID of the create endpoint request.	string

Name

Description

Schema

trackingId
optional

Tracking ID of the create endpoint request.

string

CrossAccountRoleDetails

Customer cross account role details.

Name	Description	Schema
crossAccountRole optional	Cross-account role.	string
externalId optional	External ID associated with the cross-account role.	string

Name

Description

Schema

crossAccountRole
optional

Cross-account role.

string

externalId
optional

External ID associated with the cross-account role.

string

DeletePrivateLinkEndpointRequest

Request object for the DeletePrivateLinkEndpoint method.

Name	Description	Schema
awsAccountInfo optional	AWS account details to delete the PrivateLink endpoint from.	AWSAccountInfo
azureAccountInfo optional	Azure account details to delete the PrivateLink endpoint from.	AzureAccountInfo
environmentCrn optional	CRN of the CDP environment in AWS cloud that this PrivateLink endpoint gets deleted from.	string
serviceComponents optional	CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH]	< string > array

Name

Description

Schema

awsAccountInfo
optional

AWS account details to delete the PrivateLink endpoint from.

AWSAccountInfo

azureAccountInfo
optional

Azure account details to delete the PrivateLink endpoint from.

AzureAccountInfo

environmentCrn
optional

CRN of the CDP environment in AWS cloud that this PrivateLink endpoint gets deleted from.

string

serviceComponents
optional

CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH]

< string > array

DeletePrivateLinkEndpointResponse

Response object for the DeletePrivateLinkEndpoint method.

Name	Description	Schema
trackingId optional	Tracking ID of the delete endpoint request.	string

Name

Description

Schema

trackingId
optional

Tracking ID of the delete endpoint request.

string

Error

An object returned on an error.

Name	Description	Schema
code optional	The error code.	string
message optional	The error message.	string

Name

Description

Schema

code
optional

The error code.

string

message
optional

The error message.

string

GetPrivateLinkEndpointStatusRequest

Request object for GetPrivateLinkEndpointStatus method. Please use ListPrivateLinkEndpointStatusesRequest as replacement. Deprecated.

Name	Description	Schema
trackingId required	Tracking ID of the create endpoint request.	string

Name

Description

Schema

trackingId
required

Tracking ID of the create endpoint request.

string

GetPrivateLinkEndpointStatusResponse

Response object for GetPrivateLinkEndpointStatus method. Please use ListPrivateLinkEndpointStatusesResponse as replacement. Deprecated.

Name	Description	Schema
privatelinkEndpoints optional	List of statuses of PrivateLink endpoints.	< PrivateLinkEndpointStatus > array

Name

Description

Schema

privatelinkEndpoints
optional

List of statuses of PrivateLink endpoints.

< PrivateLinkEndpointStatus > array

ListPrivateLinkEndpointStatusesRequest

Request object for listPrivateLinkEndpointStatuses method.

Name	Description	Schema
trackingId required	Tracking ID of the create endpoint request.	string

Name

Description

Schema

trackingId
required

Tracking ID of the create endpoint request.

string

ListPrivateLinkEndpointStatusesResponse

Response object for listPrivateLinkEndpointStatuses method.

Name	Description	Schema
privatelinkEndpoints optional	List of statuses of PrivateLink endpoints.	< PrivateLinkEndpointStatus > array

Name

Description

Schema

privatelinkEndpoints
optional

List of statuses of PrivateLink endpoints.

< PrivateLinkEndpointStatus > array

ListPrivateLinkServicesForRegionRequest

Request object for the ListPrivateLinkServicesForTheRegion method.

Name	Description	Schema
region required	Region for which the private link services to be queried.	string
serviceGroup optional	CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS.	string

Name

Description

Schema

region
required

Region for which the private link services to be queried.

string

serviceGroup
optional

CDP service group. Currently supported "CDP-CONTROL-PLANE" for PaaS.

string

ListPrivateLinkServicesForRegionResponse

Response object for the ListPrivateLinkServicesForTheRegion method.

Name	Description	Schema
listPrivateLinkServicesForRegionResults optional	List of ListPrivateLinkServicesForTheRegionResult objects to be returned.	< ListPrivateLinkServicesForRegionResult > array

Name

Description

Schema

listPrivateLinkServicesForRegionResults
optional

List of ListPrivateLinkServicesForTheRegionResult objects to be returned.

< ListPrivateLinkServicesForRegionResult > array

ListPrivateLinkServicesForRegionResult

Response object containing PL service name and CDP service component.

Name	Description	Schema
availabilityZoneList optional	Availability zone list.	string
hostname optional	Hostname of the Private Link Service.	string
privateLinkService optional	Name of the Private link service.	string
serviceComponent optional	The CDP Service component.	string
vpceClientTcpPortList optional	VPCE Client tcp port list.	string

Name

Description

Schema

availabilityZoneList
optional

Availability zone list.

string

hostname
optional

Hostname of the Private Link Service.

string

privateLinkService
optional

Name of the Private link service.

string

serviceComponent
optional

The CDP Service component.

string

vpceClientTcpPortList
optional

VPCE Client tcp port list.

string

PrivateLinkEndpointStatus

Details of the PrivateLink endpoints.

Name	Description	Schema
creationTimestamp optional	Endpoint creation timestamp.	string
dnsNames optional	List of PrivateLink endpoint DNS names on successful creation.	< string > array
endpointId optional	PrivateLink endpoint ID on success.	string
error optional	Error message on failure.	string
serviceComponent optional	CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].	string
status optional	Status of the PrivateLink endpoints. The status is set to SUCCESS on successful creation of endpoint, IN_PROGRESS on endpoint creation is in progress and ERROR on failing to create the endpoint.	string

Name

Description

Schema

creationTimestamp
optional

Endpoint creation timestamp.

string

dnsNames
optional

List of PrivateLink endpoint DNS names on successful creation.

< string > array

endpointId
optional

PrivateLink endpoint ID on success.

string

error
optional

Error message on failure.

string

serviceComponent
optional

CDP service component name [API/DBUSAPI/IAMAPI/CCMV2/CONSOLEAUTH].

string

status
optional

Status of the PrivateLink endpoints. The status is set to SUCCESS on successful creation of endpoint, IN_PROGRESS on endpoint creation is in progress and ERROR on failing to create the endpoint.

string