Overview

Cloudera DataCatalog Service is a web service, using this service a user can execute operations like launching profilers in DataCatalog.

Version information

Version : 0.9.151

License information

License : Apache 2.0
Terms of service : null

URI scheme

Schemes : HTTPS

Consumes

  • application/json

Produces

  • application/json

Paths

Get Suggested tags by the Data Compliance profiler.

POST /api/v1/datacatalog/getSuggestedTags

Description

Get the tags suggested by the Data Compliance profiler.

Parameters

Type Name Schema

Body

input
required

GetSuggestedTagsRequest

Responses

HTTP Code Description Schema

200

List of suggested tags.

GetSuggestedTagsResponse

default

The default response on an error.

Error

Launches DataCatalog profilers in a given datalake.

POST /api/v1/datacatalog/launchProfilers

Description

Launches DataCatalog profilers in a given datalake.

Parameters

Type Name Schema

Body

input
required

LaunchProfilersRequest

Responses

HTTP Code Description Schema

200

Expected response to a valid request.

LaunchProfilersResponse

default

The default response on an error.

Error

Review tags suggested by Data Compliance Profiler

POST /api/v1/datacatalog/reviewSuggestedTags

Description

Review the tags suggested by the Data Compliance profiler.

Parameters

Type Name Schema

Body

input
required

ReviewSuggestedTagsRequest

Responses

HTTP Code Description Schema

200

Accept or Reject tags suggested by Data Compliance Profiler.

ReviewSuggestedTagsResponse

default

The default response on an error.

Error

Definitions

AssetsToReviewRequest

Asset details for which tags are being reviewed.

Name Description Schema

qualifiedName
required

The fully qualified name of the asset.

string

tags
required

List of tags to be reviewed.

< string > array

Cluster

Information about a cluster.

Name Description Schema

cloudPlatform
optional

The cloud platform.

string

clusterName
optional

The name of the cluster.

string

clusterStatus
optional

The status of the cluster.

string

clusterTemplateCrn
optional

The CRN of the cluster template used for the cluster creation.

string

creationDate
optional

The date when the cluster was created.

string (date-time)

credentialCrn
optional

The CRN of the credential.

string

crn
optional

The CRN of the cluster.

string

datalakeCrn
optional

The CRN of the attached datalake.

string

environmentCrn
optional

The CRN of the environment.

string

imageDetails
optional

The image details.

ImageDetails

nodeCount
optional

The cluster node count.

integer (int32)

workloadType
optional

The workload type for the cluster.

string

Error

An object returned on an error.

Name Description Schema

code
optional

The error code.

string

message
optional

The error message.

string

GetSuggestedTagsRequest

Get the tags suggested by the Data Compliance Profiler.

Name Description Schema

columnFQN
optional

The fully qualified name of the column.

string

datalakeCrn
required

The CRN of the Datalake.

string

profiledSince
optional

Tags suggested by the profiler since this date.

string (date-time)

tableFQN
optional

The fully qualified name of the table.

string

GetSuggestedTagsResponse

Tags suggested by the Data Compliance Profiler.

Name Description Schema

suggestedTags
optional

List of suggested tags.

< suggestedTags > array

suggestedTags

Name Description Schema

qualifiedName
optional

The fully qualified name of the asset.

string

tags
optional

List of suggested tags.

< string > array

ImageDetails

The details of the image used for cluster instances.

Name Description Schema

catalogName
optional

The image catalog name.

string

catalogUrl
optional

The image catalog URL.

string

id
optional

The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image.

string

name
optional

The name of the image used for cluster instances.

string

LaunchProfilersRequest

Launch Profilers request.

Name Description Schema

datalake
required

The CRN of the Datalake.

string

enableHA
optional

Enables High Availability (HA) for datacatalog profilers (default value is false). The High Availability (HA) Profiler cluster provides failure resilience and scalability but incurs additional cost.

boolean

instanceTypes
optional

List of instance types to be used for the auto-scaling node group setup (Applicable only for compute cluster enabled environments).

< string > array

maxNodes
optional

Maximum number of nodes that can be spawned inside the auto-scaling node group, in the range of 30 to 100 (both inclusive). (Applicable only for compute cluster enabled environments).

integer (int64)

profilers
optional

List of profiler names that need to be launched. (Applicable only for compute cluster enabled environments).

< string > array

LaunchProfilersResponse

Profiler launch operation response.

Name Description Schema

datahubCluster
optional

Datahub cluster details.

Cluster

ReviewSuggestedTagsRequest

Request to review suggested tags.

Name Description Schema

action
required

Action to be taken on the suggested tags. (ACCEPT, REJECT)

enum (ACCEPT, REJECT)

assets
required

List of assets for which tags are being reviewed.

< AssetsToReviewRequest > array

datalakeCrn
required

The CRN of the Datalake.

string

ReviewSuggestedTagsResponse

Review suggested tags response.

Name Description Schema

reviewedTags
optional

List of reviewed tags.

< reviewedTags > array

reviewedTags

Name Description Schema

qualifiedName
optional

The fully qualified name of the asset.

string

status
optional

The current status of the tags. (ACCEPTED, REJECTED, FAILED)

enum (ACCEPTED, REJECTED, FAILED)

tagsUpdated
optional

List of tags on which have been reviewed.

< string > array

Copyright © 2025 Cloudera, Inc. All rights reserved.