Skip to content

Commit e2616a5

Browse files
cloudera-sre-svccloudera-sre-svc
committed
CDP Beta API Documentation 0.9.119
1 parent 9318489 commit e2616a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+2616
-747
lines changed

‎api-docs-beta/CHANGELOG.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# CDP Control Plane Public API Changelog
22

3+
## 0.9.119 (2024-07-31)
4+
* datahub/datalake: Add new `rotate-db-certificate` command.
5+
* de: Add new `force` and `includeJobRuns` options to `create-backup` command.
6+
* dw: Add a new command to activate AWS Cluster `create-aws-cluster`.
7+
* dw: Add a new command to activate Azure Cluster `create-azure-cluster`.
8+
* dw: Add a new command to activate a Cluster on Private Cloud `create-private-cluster`.
9+
* dw: Add `privateSQLSubnetName` and `privateDNSZoneSQL` fields to the `create-cluster`, `create-azure-cluster`, `list-clusters` and `describe-cluster` commands.
10+
* dw: Add `aksPodCIDR` field to the `create-cluster`, `create-azure-cluster`, `list-clusters` and `describe-cluster` commands.
11+
* dw: Add deployed cluster `version` field to `describe-cluster` and `list-clusters` responses.
12+
* dw: Add `useOverlayNetwork` / `enablePrivateLoadBalancer` fields to `describe-cluster` and `list-clusters` response.
13+
* dw: Add `enablePrivateSQL` / `privateDNSZoneAKS` / `enablePrivateAKS` / `userAssignedManagedIdentity` in the Azure options of `describe-cluster` and `list-clusters` response.
14+
* dw: Add a new field `impalaQueryLog` to `create-vw` / `describe-vw` / `list-vws` and `update-vw` command.
15+
* dw: Add a new field `enabledPrivateEKS` to `create-cluster` / `create-aws-cluster` / `describe-cluster` and `list-clusters` command.
16+
* dw: Add a new field `enableStatestoreHighAvailability` to `create-vw` / `update-vw` / `describe-vw` and `list-vws` commands, for Impala.
17+
* dw: Deprecate `additionalInstanceTypes` field in some commands.
18+
* opdb: Remove `id` and `catalog` as required parameters for database `image` details input provided to `create-database` command.
19+
20+
BACKWARD INCOMPATIBILITIES:
21+
* cloudprivatelinks: Remove deprecated `get-private-link-endpoint-status` command.
22+
323
## 0.9.118 (2024-07-18)
424
* cloudprivatelinks: Add `cloudServiceProvider` argument to `deletePrivateLinkEndpoint` command.
525
* datalake: Add new command `cancelRestore`.
@@ -9,14 +29,14 @@
929
* environments: Add new parameters `imageId` and `allowMajorOsUpgrade` to `upgradeFreeipa` command.
1030
* ml: Add new properties `version` and `endpointPublicAccess` to `ModelRegistry` object.
1131

12-
# 0.9.117 (2024-06-26)
32+
## 0.9.117 (2024-06-26)
1333
* cloudprivatelinks: Add new property `status` to `AuthorizePrivateLinkServiceAccessResponse` object.
1434
* de: Add support for `Spark 3.5` to `createVc` command.
1535
* compute: Add new properties `isDefault` and `clusterShape` to `ListClusterItems` object.
1636
* compute: Update description of `includeDeleted` in `ListClusters` command.
1737
* dw: Deprecate properties `waitQueueSize` and `headroom` in `CreateApplicationResourcesBreakdown` object.
1838

19-
# 0.9.115 (2024-06-05)
39+
## 0.9.115 (2024-06-05)
2040
* de: Add new property `allPurposeInstanceGroupDetails` to `ServiceResources` object.
2141
* de: Add new property `sessionTimeout` to `VcDescription` object.
2242
* de: Add new parameters `allPurposeInstanceType`, `allPurposeMinimumInstances`, `allPurposeMaximumInstances`, `allPurposeMinimumSpotInstances`, `allPurposeMaximumSpotInstances`, `allPurposeInitialInstances`, `allPurposeInitialSpotInstances`, and `allPurposeRootVolumeSize` to `enableService` command.

‎api-docs-beta/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
# CDP Control Plane Public API Documentation
22

3-
*Version: 0.9.118 (BETA)*
3+
*Version: 0.9.119 (BETA)*
44

55
Available documentation is listed by service below.
66

77
| Service | Version |
88
| --- | --- |
9-
| [audit](./audit/index.html) | 0.9.118 |
10-
| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.118 |
11-
| [compute](./compute/index.html) | 0.9.118 |
12-
| [consumption](./consumption/index.html) | 0.9.118 |
13-
| [datacatalog](./datacatalog/index.html) | 0.9.118 |
14-
| [datahub](./datahub/index.html) | 0.9.118 |
15-
| [datalake](./datalake/index.html) | 0.9.118 |
16-
| [de](./de/index.html) | 0.9.118 |
17-
| [df](./df/index.html) | 0.9.118 |
18-
| [dfworkload](./dfworkload/index.html) | 0.9.118 |
19-
| [drscp](./drscp/index.html) | 0.9.118 |
20-
| [dw](./dw/index.html) | 0.9.118 |
21-
| [environments](./environments/index.html) | 0.9.118 |
22-
| [iam](./iam/index.html) | 0.9.118 |
23-
| [imagecatalog](./imagecatalog/index.html) | 0.9.118 |
24-
| [metrics](./metrics/index.html) | 0.9.118 |
25-
| [ml](./ml/index.html) | 0.9.118 |
26-
| [opdb](./opdb/index.html) | 0.9.118 |
27-
| [replicationmanager](./replicationmanager/index.html) | 0.9.118 |
9+
| [audit](./audit/index.html) | 0.9.119 |
10+
| [cloudprivatelinks](./cloudprivatelinks/index.html) | 0.9.119 |
11+
| [compute](./compute/index.html) | 0.9.119 |
12+
| [consumption](./consumption/index.html) | 0.9.119 |
13+
| [datacatalog](./datacatalog/index.html) | 0.9.119 |
14+
| [datahub](./datahub/index.html) | 0.9.119 |
15+
| [datalake](./datalake/index.html) | 0.9.119 |
16+
| [de](./de/index.html) | 0.9.119 |
17+
| [df](./df/index.html) | 0.9.119 |
18+
| [dfworkload](./dfworkload/index.html) | 0.9.119 |
19+
| [drscp](./drscp/index.html) | 0.9.119 |
20+
| [dw](./dw/index.html) | 0.9.119 |
21+
| [environments](./environments/index.html) | 0.9.119 |
22+
| [iam](./iam/index.html) | 0.9.119 |
23+
| [imagecatalog](./imagecatalog/index.html) | 0.9.119 |
24+
| [metrics](./metrics/index.html) | 0.9.119 |
25+
| [ml](./ml/index.html) | 0.9.119 |
26+
| [opdb](./opdb/index.html) | 0.9.119 |
27+
| [replicationmanager](./replicationmanager/index.html) | 0.9.119 |
2828

2929
API documentation uses the Adoc Riak stylesheet from
3030
[https://github.com/darshandsoni/asciidoctor-skins](https://github.com/darshandsoni/asciidoctor-skins).

‎api-docs-beta/audit/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -822,7 +822,7 @@ <h2 id="_overview">Overview</h2>
822822
<div class="sect2">
823823
<h3 id="_version_information">Version information</h3>
824824
<div class="paragraph">
825-
<p><em>Version</em> : 0.9.118 (BETA)</p>
825+
<p><em>Version</em> : 0.9.119 (BETA)</p>
826826
</div>
827827
</div>
828828
<div class="sect2">
@@ -3910,7 +3910,7 @@ <h3 id="_markarchivebatchesassuccessfulresponse">MarkArchiveBatchesAsSuccessfulR
39103910
</div>
39113911
<div id="footer">
39123912
<div id="footer-text">
3913-
Last updated 2024-07-18 14:49:35 -0700
3913+
Last updated 2024-08-02 09:24:46 -0700
39143914
</div>
39153915
</div>
39163916
<br>

‎api-docs-beta/cloudprivatelinks/index.html

Lines changed: 10 additions & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -711,27 +711,20 @@ <h1>Cloudera CloudPrivateLinks API Service</h1>
711711
<li><a href="#_responses_3">Responses</a></li>
712712
</ul>
713713
</li>
714-
<li><a href="#_getprivatelinkendpointstatus">Gets the statuses of PrivateLink endpoints.</a>
714+
<li><a href="#_listprivatelinkendpointstatuses">Lists the statuses of the PrivateLink endpoints that are in creation/deletion status.</a>
715715
<ul class="sectlevel3">
716716
<li><a href="#_description_4">Description</a></li>
717717
<li><a href="#_parameters_4">Parameters</a></li>
718718
<li><a href="#_responses_4">Responses</a></li>
719719
</ul>
720720
</li>
721-
<li><a href="#_listprivatelinkendpointstatuses">Lists the statuses of the PrivateLink endpoints that are in creation/deletion status.</a>
721+
<li><a href="#_listprivatelinkservicesforregion">Lists the PrivateLink services that are supported for the region and service group.</a>
722722
<ul class="sectlevel3">
723723
<li><a href="#_description_5">Description</a></li>
724724
<li><a href="#_parameters_5">Parameters</a></li>
725725
<li><a href="#_responses_5">Responses</a></li>
726726
</ul>
727727
</li>
728-
<li><a href="#_listprivatelinkservicesforregion">Lists the PrivateLink services that are supported for the region and service group.</a>
729-
<ul class="sectlevel3">
730-
<li><a href="#_description_6">Description</a></li>
731-
<li><a href="#_parameters_6">Parameters</a></li>
732-
<li><a href="#_responses_6">Responses</a></li>
733-
</ul>
734-
</li>
735728
</ul>
736729
</li>
737730
<li><a href="#_definitions">Definitions</a>
@@ -751,8 +744,6 @@ <h1>Cloudera CloudPrivateLinks API Service</h1>
751744
<li><a href="#_deleteprivatelinkendpointrequest">DeletePrivateLinkEndpointRequest</a></li>
752745
<li><a href="#_deleteprivatelinkendpointresponse">DeletePrivateLinkEndpointResponse</a></li>
753746
<li><a href="#_error">Error</a></li>
754-
<li><a href="#_getprivatelinkendpointstatusrequest">GetPrivateLinkEndpointStatusRequest</a></li>
755-
<li><a href="#_getprivatelinkendpointstatusresponse">GetPrivateLinkEndpointStatusResponse</a></li>
756747
<li><a href="#_listprivatelinkendpointstatusesrequest">ListPrivateLinkEndpointStatusesRequest</a></li>
757748
<li><a href="#_listprivatelinkendpointstatusesresponse">ListPrivateLinkEndpointStatusesResponse</a></li>
758749
<li><a href="#_listprivatelinkservicesforregionrequest">ListPrivateLinkServicesForRegionRequest</a></li>
@@ -774,7 +765,7 @@ <h2 id="_overview">Overview</h2>
774765
<div class="sect2">
775766
<h3 id="_version_information">Version information</h3>
776767
<div class="paragraph">
777-
<p><em>Version</em> : 0.9.118 (BETA)</p>
768+
<p><em>Version</em> : 0.9.119 (BETA)</p>
778769
</div>
779770
</div>
780771
<div class="sect2">
@@ -1074,106 +1065,20 @@ <h4 id="_responses_3">Responses</h4>
10741065
</div>
10751066
</div>
10761067
<div class="sect2">
1077-
<h3 id="_getprivatelinkendpointstatus">Gets the statuses of PrivateLink endpoints.</h3>
1078-
<div class="literalblock">
1079-
<div class="content">
1080-
<pre>POST /api/v1/cloudprivatelinks/getPrivateLinkEndpointStatus</pre>
1081-
</div>
1082-
</div>
1083-
<div class="sect3">
1084-
<h4 id="_description_4">Description</h4>
1085-
<div class="paragraph">
1086-
<p>Returns the statuses of the PrivateLink endpoints in creation/deletion. Please use ListPrivateLinkEndpointStatuses as replacement. Deprecated.</p>
1087-
</div>
1088-
</div>
1089-
<div class="sect3">
1090-
<h4 id="_parameters_4">Parameters</h4>
1091-
<table class="tableblock frame-all grid-all stretch">
1092-
<colgroup>
1093-
<col style="width: 22.2222%;">
1094-
<col style="width: 33.3333%;">
1095-
<col style="width: 44.4445%;">
1096-
</colgroup>
1097-
<thead>
1098-
<tr>
1099-
<th class="tableblock halign-left valign-middle">Type</th>
1100-
<th class="tableblock halign-left valign-middle">Name</th>
1101-
<th class="tableblock halign-left valign-middle">Schema</th>
1102-
</tr>
1103-
</thead>
1104-
<tbody>
1105-
<tr>
1106-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1107-
<p><strong>Body</strong></p>
1108-
</div></div></td>
1109-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1110-
<p><strong>input</strong><br>
1111-
<em>required</em></p>
1112-
</div></div></td>
1113-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1114-
<p><a href="#_getprivatelinkendpointstatusrequest">GetPrivateLinkEndpointStatusRequest</a></p>
1115-
</div></div></td>
1116-
</tr>
1117-
</tbody>
1118-
</table>
1119-
</div>
1120-
<div class="sect3">
1121-
<h4 id="_responses_4">Responses</h4>
1122-
<table class="tableblock frame-all grid-all stretch">
1123-
<colgroup>
1124-
<col style="width: 10%;">
1125-
<col style="width: 70%;">
1126-
<col style="width: 20%;">
1127-
</colgroup>
1128-
<thead>
1129-
<tr>
1130-
<th class="tableblock halign-left valign-middle">HTTP Code</th>
1131-
<th class="tableblock halign-left valign-middle">Description</th>
1132-
<th class="tableblock halign-left valign-middle">Schema</th>
1133-
</tr>
1134-
</thead>
1135-
<tbody>
1136-
<tr>
1137-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1138-
<p><strong>200</strong></p>
1139-
</div></div></td>
1140-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1141-
<p>Expected response to a valid request.</p>
1142-
</div></div></td>
1143-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1144-
<p><a href="#_getprivatelinkendpointstatusresponse">GetPrivateLinkEndpointStatusResponse</a></p>
1145-
</div></div></td>
1146-
</tr>
1147-
<tr>
1148-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1149-
<p><strong>default</strong></p>
1150-
</div></div></td>
1151-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1152-
<p>The default response on an error.</p>
1153-
</div></div></td>
1154-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
1155-
<p><a href="#_error">Error</a></p>
1156-
</div></div></td>
1157-
</tr>
1158-
</tbody>
1159-
</table>
1160-
</div>
1161-
</div>
1162-
<div class="sect2">
11631068
<h3 id="_listprivatelinkendpointstatuses">Lists the statuses of the PrivateLink endpoints that are in creation/deletion status.</h3>
11641069
<div class="literalblock">
11651070
<div class="content">
11661071
<pre>POST /api/v1/cloudprivatelinks/listPrivateLinkEndpointStatuses</pre>
11671072
</div>
11681073
</div>
11691074
<div class="sect3">
1170-
<h4 id="_description_5">Description</h4>
1075+
<h4 id="_description_4">Description</h4>
11711076
<div class="paragraph">
11721077
<p>Returns the statuses of the PrivateLink endpoints in creation/deletion.</p>
11731078
</div>
11741079
</div>
11751080
<div class="sect3">
1176-
<h4 id="_parameters_5">Parameters</h4>
1081+
<h4 id="_parameters_4">Parameters</h4>
11771082
<table class="tableblock frame-all grid-all stretch">
11781083
<colgroup>
11791084
<col style="width: 22.2222%;">
@@ -1204,7 +1109,7 @@ <h4 id="_parameters_5">Parameters</h4>
12041109
</table>
12051110
</div>
12061111
<div class="sect3">
1207-
<h4 id="_responses_5">Responses</h4>
1112+
<h4 id="_responses_4">Responses</h4>
12081113
<table class="tableblock frame-all grid-all stretch">
12091114
<colgroup>
12101115
<col style="width: 10%;">
@@ -1253,13 +1158,13 @@ <h3 id="_listprivatelinkservicesforregion">Lists the PrivateLink services that a
12531158
</div>
12541159
</div>
12551160
<div class="sect3">
1256-
<h4 id="_description_6">Description</h4>
1161+
<h4 id="_description_5">Description</h4>
12571162
<div class="paragraph">
12581163
<p>Returns the list of private link service name and the mapped service component.</p>
12591164
</div>
12601165
</div>
12611166
<div class="sect3">
1262-
<h4 id="_parameters_6">Parameters</h4>
1167+
<h4 id="_parameters_5">Parameters</h4>
12631168
<table class="tableblock frame-all grid-all stretch">
12641169
<colgroup>
12651170
<col style="width: 22.2222%;">
@@ -1290,7 +1195,7 @@ <h4 id="_parameters_6">Parameters</h4>
12901195
</table>
12911196
</div>
12921197
<div class="sect3">
1293-
<h4 id="_responses_6">Responses</h4>
1198+
<h4 id="_responses_5">Responses</h4>
12941199
<table class="tableblock frame-all grid-all stretch">
12951200
<colgroup>
12961201
<col style="width: 10%;">
@@ -2291,74 +2196,6 @@ <h3 id="_error">Error</h3>
22912196
</table>
22922197
</div>
22932198
<div class="sect2">
2294-
<h3 id="_getprivatelinkendpointstatusrequest">GetPrivateLinkEndpointStatusRequest</h3>
2295-
<div class="paragraph">
2296-
<p>Request object for GetPrivateLinkEndpointStatus method. Please use ListPrivateLinkEndpointStatusesRequest as replacement. Deprecated.</p>
2297-
</div>
2298-
<table class="tableblock frame-all grid-all stretch">
2299-
<colgroup>
2300-
<col style="width: 16.6666%;">
2301-
<col style="width: 61.1111%;">
2302-
<col style="width: 22.2223%;">
2303-
</colgroup>
2304-
<thead>
2305-
<tr>
2306-
<th class="tableblock halign-left valign-middle">Name</th>
2307-
<th class="tableblock halign-left valign-middle">Description</th>
2308-
<th class="tableblock halign-left valign-middle">Schema</th>
2309-
</tr>
2310-
</thead>
2311-
<tbody>
2312-
<tr>
2313-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2314-
<p><strong>trackingId</strong><br>
2315-
<em>required</em></p>
2316-
</div></div></td>
2317-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2318-
<p>Tracking ID of the create endpoint request.</p>
2319-
</div></div></td>
2320-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2321-
<p>string</p>
2322-
</div></div></td>
2323-
</tr>
2324-
</tbody>
2325-
</table>
2326-
</div>
2327-
<div class="sect2">
2328-
<h3 id="_getprivatelinkendpointstatusresponse">GetPrivateLinkEndpointStatusResponse</h3>
2329-
<div class="paragraph">
2330-
<p>Response object for GetPrivateLinkEndpointStatus method. Please use ListPrivateLinkEndpointStatusesResponse as replacement. Deprecated.</p>
2331-
</div>
2332-
<table class="tableblock frame-all grid-all stretch">
2333-
<colgroup>
2334-
<col style="width: 16.6666%;">
2335-
<col style="width: 61.1111%;">
2336-
<col style="width: 22.2223%;">
2337-
</colgroup>
2338-
<thead>
2339-
<tr>
2340-
<th class="tableblock halign-left valign-middle">Name</th>
2341-
<th class="tableblock halign-left valign-middle">Description</th>
2342-
<th class="tableblock halign-left valign-middle">Schema</th>
2343-
</tr>
2344-
</thead>
2345-
<tbody>
2346-
<tr>
2347-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2348-
<p><strong>privatelinkEndpoints</strong><br>
2349-
<em>optional</em></p>
2350-
</div></div></td>
2351-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2352-
<p>List of statuses of PrivateLink endpoints.</p>
2353-
</div></div></td>
2354-
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
2355-
<p>&lt; <a href="#_privatelinkendpointstatus">PrivateLinkEndpointStatus</a> &gt; array</p>
2356-
</div></div></td>
2357-
</tr>
2358-
</tbody>
2359-
</table>
2360-
</div>
2361-
<div class="sect2">
23622199
<h3 id="_listprivatelinkendpointstatusesrequest">ListPrivateLinkEndpointStatusesRequest</h3>
23632200
<div class="paragraph">
23642201
<p>Request object for listPrivateLinkEndpointStatuses method.</p>
@@ -2687,7 +2524,7 @@ <h3 id="_privatelinkendpointstatus">PrivateLinkEndpointStatus</h3>
26872524
</div>
26882525
<div id="footer">
26892526
<div id="footer-text">
2690-
Last updated 2024-07-18 14:49:35 -0700
2527+
Last updated 2024-08-02 09:24:46 -0700
26912528
</div>
26922529
</div>
26932530
<br>

0 commit comments

Comments
 (0)