Overview

Provisions Private Link Endpoints on the cloud environments.

Version information

Version : 0.9.152

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

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

AuthorizePrivateLinkServiceAccessResponse

default

The default response on an error.

Error

Creates Private Link endpoints.

POST /api/v1/cloudprivatelinks/createPrivateLinkEndpoint

Description

Creates the Private Link Endpoints for specified CDP service group.

Parameters

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

Deletes Private Link endpoints.

POST /api/v1/cloudprivatelinks/deletePrivateLinkEndpoint

Description

Deletes the Private Link Endpoints for specified CDP service group.

Parameters

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

Get the status of a Private Link.

POST /api/v1/cloudprivatelinks/getPrivateLinkStatus

Description

Returns the status of a Private Link.

Parameters

Type Name Schema

Body

input
required

GetPrivateLinkStatusRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

GetPrivateLinkStatusResponse

default

The default response on an error.

Error

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

POST /api/v1/cloudprivatelinks/listPrivateLinkEndpointStatuses

Description

Returns the statuses of the Private Link endpoints in creation/deletion.

Parameters

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

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

POST /api/v1/cloudprivatelinks/listPrivateLinkServicesForRegion

Description

Returns the list of Private Link service names and the mapped service components.

Parameters

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

Migrates Private Link endpoints to fallback VPCE services.

POST /api/v1/cloudprivatelinks/migratePrivateLinkEndpoints

Description

Migrates Private Link endpoints from non-control plane endpoint service to Control Plane endpoint services.

Parameters

Type Name Schema

Body

input
required

MigratePrivateLinkEndpointsRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

MigratePrivateLinkEndpointsResponse

default

The default response on an error.

Error

Revoke Private Link services access for the cloud account ID.

POST /api/v1/cloudprivatelinks/revokePrivateLinkServiceAccess

Description

Returns the Private Link revocation status.

Parameters

Type Name Schema

Body

input
required

RevokePrivateLinkServiceAccessRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

RevokePrivateLinkServiceAccessResponse

default

The default response on an error.

Error

Definitions

AWSAccountDetails

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

Name Description Schema

cloudAccountId
optional

Account ID to authorize access for Private Link.

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 Private Link 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

AuthorizePrivateLinkServiceAccessRequest

Request object for the AuthorizePrivateLinkServicesAccess method.

Name Description Schema

cloudAccountId
optional

AWS account ID to authorize access for Private Link.

string

cloudServiceProvider
optional

Cloud Service Provider. Currently supporting AWS and AZURE.

CloudServiceProvider

region
optional

Region where the Private Link service exists.

string

serviceGroup
optional

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

string

subscriptionId
optional

Azure subscription ID to authorize access for Private Link.

string

AuthorizePrivateLinkServiceAccessResponse

Response object for the AuthorizePrivateLinkServicesAccess method.

Name Description Schema

authorizePrivateLinkServiceAccessResults
optional

List of AuthorizePrivateLinkServiceAccessResult objects.

< AuthorizePrivateLinkServiceAccessResult > array

status
optional

Status of Private Link service access authorization.

string

AuthorizePrivateLinkServiceAccessResult

Authorization response containing Private Link 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

AzureAccountDetails

Details of the cloud network and the cross-account role required to create the Private Link 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 is 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 Private Link 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

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

CloudServiceProvider

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

Type : enum (AWS, AZURE)

CreatePrivateLinkEndpointRequest

Request object for the CreatePrivateLinkEndpoint method.

Name Description Schema

awsAccountDetails
optional

AWS account details where the Private Link endpoint is created.

AWSAccountDetails

azureAccountDetails
optional

Azure account details where Private Link endpoint is created.

AzureAccountDetails

cloudServiceProvider
required

Cloud Service Provider. Currently supporting AWS and AZURE.

CloudServiceProvider

enablePrivateDns
optional

Enable Private DNS for Private Link endpoint.

boolean

resourceTags
optional

Custom tags for the different cloud resources created during Private Links creation.

< ResourceTag > 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

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

DeletePrivateLinkEndpointRequest

Request object for the DeletePrivateLinkEndpoint method.

Name Description Schema

awsAccountInfo
optional

The AWS account details from which this Private Link endpoint is to be deleted.

AWSAccountInfo

azureAccountInfo
optional

The Azure account details from which this Private Link endpoint is to be deleted.

AzureAccountInfo

cloudServiceProvider
required

Cloud Service Provider. Currently supporting AWS and AZURE.

CloudServiceProvider

DeletePrivateLinkEndpointResponse

Response object for the DeletePrivateLinkEndpoint method.

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

GetPrivateLinkStatusRequest

Request object for retrieving the status of a Private Link.

Name Description Schema

cloudServiceProvider
optional

Cloud Service Provider. Supports AWS and AZURE.

CloudServiceProvider

subnetIds
optional

List of subnets in the given cloud network to query Private Link status. This field has been deprecated.

< string > array

vNetId
optional

Virtual Network Id to query the status of Private Link in Azure.

string

vpcId
optional

VPC ID to query the status of Private Link in AWS.

string

GetPrivateLinkStatusResponse

Response object for GetPrivateLinkStatus method.

Name Description Schema

status
optional

Status of Private Link - enabled or disabled.

PrivateLinkStatus

ListPrivateLinkEndpointStatusesRequest

Request object for listPrivateLinkEndpointStatuses method.

Name Description Schema

trackingId
required

Tracking ID of the create or delete endpoint request.

string

ListPrivateLinkEndpointStatusesResponse

Response object for listPrivateLinkEndpointStatuses method.

Name Description Schema

privatelinkEndpoints
optional

List of statuses of Private Link endpoints.

< PrivateLinkEndpointStatus > array

ListPrivateLinkServicesForRegionRequest

Request object for the ListPrivateLinkServicesForTheRegion method.

Name Description Schema

region
required

Region for which the Private Link services are to be queried.

string

serviceGroup
optional

CDP service group. Currently supports "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

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

MigratePrivateLinkEndpointsRequest

Request object for the MigratePrivateLinkEndpoints method.

Name Description Schema

awsAccountInfo
required

Migration is AWS-only. AWS account information for the Private Link endpoint migration. Only the VPC ID, region, and credentials are required; subnet and other details are retrieved from the database.

AWSAccountInfo

MigratePrivateLinkEndpointsResponse

Response object for the MigratePrivateLinkEndpoints method.

Name Description Schema

trackingId
optional

Tracking ID of the migration request.

string

PrivateLinkEndpointStatus

Details of the Private Link endpoints.

Name Description Schema

creationTimestamp
optional

Endpoint creation timestamp.

string

dnsNames
optional

List of Private Link endpoint DNS names on successful creation.

< string > array

endpointId
optional

Private Link 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 Private Link endpoints. The status is set to SUCCESS when endpoint is created successfully, IN_PROGRESS when the endpoint creation is underway and ERROR when endpoint creation fails.

string

PrivateLinkStatus

Status of the Private Link. ENABLED - Private Link is enabled. DISABLED - Private Link is disabled. ERROR - Error while retrieving the Private Link status.

Type : enum (ENABLED, DISABLED, ERROR)

ResourceTag

Tag object which can be passed to add custom tags for the cloud resources.

Name Description Schema

key
required

Key value for the tag.

string

value
required

Value for the tag.

string

RevokePrivateLinkServiceAccessRequest

Request object for the RevokePrivateLinkServiceAccess method.

Name Description Schema

cloudAccountId
optional

AWS account ID to authorize access for Private Link.

string

cloudServiceProvider
optional

Cloud Service Provider. Currently supporting AWS and AZURE.

CloudServiceProvider

region
optional

Region where the Private Link service exists.

string

serviceGroup
optional

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

string

subscriptionId
optional

Azure subscription ID to authorize access for Private Link.

string

RevokePrivateLinkServiceAccessResponse

Response object for the RevokePrivateLinkServiceAccess method.

Name Description Schema

revokePrivateLinkServiceAccessResults
optional

List of RevokePrivateLinkServiceAccessResult objects.

< RevokePrivateLinkServiceAccessResult > array

status
optional

Status of Private Link service access revoke.

string

RevokePrivateLinkServiceAccessResult

Revoke response containing PrivateLink service name, service component and its revocation status.

Name Description Schema

privateLinkService
optional

Name of the Private Link service.

string

revocationStatus
optional

Revocation status for the Private Link service.

string

serviceComponent
optional

CDP service component.

string

Copyright © 2025 Cloudera, Inc. All rights reserved.