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.149
License information
License : Apache 2.0
Terms of service : null
URI scheme
Schemes : HTTPS
Consumes
-
application/json
Produces
-
application/json
Paths
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 |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Expected response to a valid request. |
|
default |
The default response on an error. |
Definitions
Cluster
Information about a cluster.
| Name | Description | Schema |
|---|---|---|
cloudPlatform |
The cloud platform. |
string |
clusterName |
The name of the cluster. |
string |
clusterStatus |
The status of the cluster. |
string |
clusterTemplateCrn |
The CRN of the cluster template used for the cluster creation. |
string |
creationDate |
The date when the cluster was created. |
string (date-time) |
credentialCrn |
The CRN of the credential. |
string |
crn |
The CRN of the cluster. |
string |
datalakeCrn |
The CRN of the attached datalake. |
string |
environmentCrn |
The CRN of the environment. |
string |
imageDetails |
The image details. |
|
nodeCount |
The cluster node count. |
integer (int32) |
workloadType |
The workload type for the cluster. |
string |
Error
An object returned on an error.
| Name | Description | Schema |
|---|---|---|
code |
The error code. |
string |
message |
The error message. |
string |
ImageDetails
The details of the image used for cluster instances.
| Name | Description | Schema |
|---|---|---|
catalogName |
The image catalog name. |
string |
catalogUrl |
The image catalog URL. |
string |
id |
The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image. |
string |
name |
The name of the image used for cluster instances. |
string |
LaunchProfilersRequest
Launch Profilers request.
| Name | Description | Schema |
|---|---|---|
datalake |
The CRN of the Datalake. |
string |
enableHA |
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 |
List of instance types to be used for the auto-scaling node group setup (Applicable only for compute cluster enabled environments). |
< string > array |
maxNodes |
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 |
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 |
Datahub cluster details. |