-
Notifications
You must be signed in to change notification settings - Fork 3
/
datacatalog.yaml
129 lines (129 loc) · 3.9 KB
/
datacatalog.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
swagger: '2.0'
x-endpoint-name: datacatalog
x-products: CDP
x-form-factors: public
x-cdp-releases: PUBLIC
x-audit: true
info:
version: 0.9.124
title: Cloudera DataCatalog Service
license:
name: Apache 2.0
description: Cloudera DataCatalog Service is a web service, using this service a user can execute operations like launching profilers in DataCatalog.
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
/api/v1/datacatalog/launchProfilers:
post:
summary: Launches DataCatalog profilers in a given datalake.
description: Launches DataCatalog profilers in a given datalake.
operationId: launchProfilers
x-entitlement: DATA_CATALOG_ENABLE_API_SERVICE
x-mutating: true
parameters:
- name: input
in: body
required: true
schema:
$ref: '#/definitions/LaunchProfilersRequest'
responses:
200:
description: Expected response to a valid request.
schema:
$ref: '#/definitions/LaunchProfilersResponse'
default:
description: The default response on an error.
schema:
$ref: '#/definitions/Error'
definitions:
Error:
type: object
description: An object returned on an error.
properties:
code:
type: string
description: The error code.
message:
type: string
description: The error message.
LaunchProfilersRequest:
type: object
description: Launch Profilers request.
required:
- datalake
properties:
datalake:
type: string
description: The CRN of the Datalake.
enableHA:
type: boolean
description: 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.
LaunchProfilersResponse:
type: object
description: Profiler launch operation response.
properties:
datahubCluster:
$ref: '#/definitions/Cluster'
description: Datahub cluster details.
Cluster:
type: object
description: Information about a cluster.
properties:
clusterName:
type: string
description: The name of the cluster.
crn:
type: string
description: The CRN of the cluster.
creationDate:
type: string
format: date-time
description: The date when the cluster was created.
clusterStatus:
type: string
description: The status of the cluster.
nodeCount:
type: integer
format: int32
description: The cluster node count.
workloadType:
type: string
description: The workload type for the cluster.
cloudPlatform:
type: string
description: The cloud platform.
imageDetails:
$ref: '#/definitions/ImageDetails'
description: The image details.
environmentCrn:
type: string
description: The CRN of the environment.
credentialCrn:
type: string
description: The CRN of the credential.
datalakeCrn:
type: string
description: The CRN of the attached datalake.
clusterTemplateCrn:
type: string
description: The CRN of the cluster template used for the cluster creation.
ImageDetails:
type: object
description: The details of the image used for cluster instances.
properties:
name:
type: string
description: The name of the image used for cluster instances.
id:
type: string
description: The ID of the image used for cluster instances. This is internally generated by the cloud provider to uniquely identify the image.
catalogUrl:
type: string
description: The image catalog URL.
catalogName:
type: string
description: The image catalog name.