kb-cloud-client-typescript 2.2.28 → 2.3.0-alpha.100

package/src/adminapi/apis/cluster-api.ts

@@ -59,6 +59,12 @@ import type { SqlAuditRequest } from '../models';
 import type { SqlAuditResponse } from '../models';
 // @ts-ignore
 import type { SqlAuditStatus } from '../models';
+// @ts-ignore
+import type { TdeRequest } from '../models';
+// @ts-ignore
+import type { TdeResponse } from '../models';
+// @ts-ignore
+import type { TdeStatus } from '../models';
 /**
  * ClusterApi - axios parameter creator
  * @export
@@ -299,10 +305,12 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
          * @summary Get cluster details by ID
          * @param {string} orgName name of the Org
          * @param {string} clusterID ID of the KubeBlocks cluster
+         * @param {string} [backupName] Backup name to override cluster components from its snapshot
+         * @param {string} [restoreTime] Restore time to find latest continuous backup snapshot after this time
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getClusterByID: async (orgName: string, clusterID: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getClusterByID: async (orgName: string, clusterID: string, backupName?: string, restoreTime?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('getClusterByID', 'orgName', orgName)
             // verify required parameter 'clusterID' is not null or undefined
@@ -324,6 +332,14 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
             // authentication BearerToken required
             await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
 
+            if (backupName !== undefined) {
+                localVarQueryParameter['backupName'] = backupName;
+            }
+
+            if (restoreTime !== undefined) {
+                localVarQueryParameter['restoreTime'] = restoreTime;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -540,6 +556,54 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Query the transparent data encryption switch status for a cluster component
+         * @summary Get TDE status
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the Cluster
+         * @param {string} component component type
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTDE: async (orgName: string, clusterName: string, component: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getTDE', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getTDE', 'clusterName', clusterName)
+            // verify required parameter 'component' is not null or undefined
+            assertParamExists('getTDE', 'component', component)
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/tde`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
+
+            if (component !== undefined) {
+                localVarQueryParameter['component'] = component;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -1053,6 +1117,53 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
 
 
     
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Enable transparent data encryption for a cluster component. Disabling TDE is not supported.
+         * @summary Enable TDE
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the Cluster
+         * @param {TdeRequest} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateTDE: async (orgName: string, clusterName: string, body: TdeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('updateTDE', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('updateTDE', 'clusterName', clusterName)
+            // verify required parameter 'body' is not null or undefined
+            assertParamExists('updateTDE', 'body', body)
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/tde`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            await setApiKeyToObject(localVarHeaderParameter, "authorization", configuration)
+
+
+    
             localVarHeaderParameter['Content-Type'] = 'application/json';
 
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1196,11 +1307,13 @@ export const ClusterApiFp = function(configuration?: Configuration) {
          * @summary Get cluster details by ID
          * @param {string} orgName name of the Org
          * @param {string} clusterID ID of the KubeBlocks cluster
+         * @param {string} [backupName] Backup name to override cluster components from its snapshot
+         * @param {string} [restoreTime] Restore time to find latest continuous backup snapshot after this time
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getClusterByID(orgName: string, clusterID: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cluster>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterByID(orgName, clusterID, options);
+        async getClusterByID(orgName: string, clusterID: string, backupName?: string, restoreTime?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cluster>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterByID(orgName, clusterID, backupName, restoreTime, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.getClusterByID']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1271,6 +1384,21 @@ export const ClusterApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.getSqlAudit']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Query the transparent data encryption switch status for a cluster component
+         * @summary Get TDE status
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the Cluster
+         * @param {string} component component type
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getTDE(orgName: string, clusterName: string, component: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TdeStatus>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getTDE(orgName, clusterName, component, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ClusterApi.getTDE']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary List clusters in the Org
@@ -1430,6 +1558,21 @@ export const ClusterApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.updateSqlAudit']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Enable transparent data encryption for a cluster component. Disabling TDE is not supported.
+         * @summary Enable TDE
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the Cluster
+         * @param {TdeRequest} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateTDE(orgName: string, clusterName: string, body: TdeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TdeResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateTDE(orgName, clusterName, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ClusterApi.updateTDE']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Validate cluster creation
@@ -1512,7 +1655,7 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         getClusterByID(requestParameters: ClusterApiGetClusterByIDRequest, options?: RawAxiosRequestConfig): AxiosPromise<Cluster> {
-            return localVarFp.getClusterByID(requestParameters.orgName, requestParameters.clusterID, options).then((request) => request(axios, basePath));
+            return localVarFp.getClusterByID(requestParameters.orgName, requestParameters.clusterID, requestParameters.backupName, requestParameters.restoreTime, options).then((request) => request(axios, basePath));
         },
         /**
          * read log of the specified cluster instance
@@ -1554,6 +1697,16 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
         getSqlAudit(requestParameters: ClusterApiGetSqlAuditRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlAuditStatus> {
             return localVarFp.getSqlAudit(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Query the transparent data encryption switch status for a cluster component
+         * @summary Get TDE status
+         * @param {ClusterApiGetTDERequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTDE(requestParameters: ClusterApiGetTDERequest, options?: RawAxiosRequestConfig): AxiosPromise<TdeStatus> {
+            return localVarFp.getTDE(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary List clusters in the Org
@@ -1654,6 +1807,16 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
         updateSqlAudit(requestParameters: ClusterApiUpdateSqlAuditRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlAuditResponse> {
             return localVarFp.updateSqlAudit(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Enable transparent data encryption for a cluster component. Disabling TDE is not supported.
+         * @summary Enable TDE
+         * @param {ClusterApiUpdateTDERequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateTDE(requestParameters: ClusterApiUpdateTDERequest, options?: RawAxiosRequestConfig): AxiosPromise<TdeResponse> {
+            return localVarFp.updateTDE(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Validate cluster creation
@@ -1773,6 +1936,16 @@ export interface ClusterApiInterface {
      */
     getSqlAudit(requestParameters: ClusterApiGetSqlAuditRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlAuditStatus>;
 
+    /**
+     * Query the transparent data encryption switch status for a cluster component
+     * @summary Get TDE status
+     * @param {ClusterApiGetTDERequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApiInterface
+     */
+    getTDE(requestParameters: ClusterApiGetTDERequest, options?: RawAxiosRequestConfig): AxiosPromise<TdeStatus>;
+
     /**
      * 
      * @summary List clusters in the Org
@@ -1873,6 +2046,16 @@ export interface ClusterApiInterface {
      */
     updateSqlAudit(requestParameters: ClusterApiUpdateSqlAuditRequest, options?: RawAxiosRequestConfig): AxiosPromise<SqlAuditResponse>;
 
+    /**
+     * Enable transparent data encryption for a cluster component. Disabling TDE is not supported.
+     * @summary Enable TDE
+     * @param {ClusterApiUpdateTDERequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApiInterface
+     */
+    updateTDE(requestParameters: ClusterApiUpdateTDERequest, options?: RawAxiosRequestConfig): AxiosPromise<TdeResponse>;
+
     /**
      * 
      * @summary Validate cluster creation
@@ -2030,6 +2213,20 @@ export interface ClusterApiGetClusterByIDRequest {
      * @memberof ClusterApiGetClusterByID
      */
     readonly clusterID: string
+
+    /**
+     * Backup name to override cluster components from its snapshot
+     * @type {string}
+     * @memberof ClusterApiGetClusterByID
+     */
+    readonly backupName?: string
+
+    /**
+     * Restore time to find latest continuous backup snapshot after this time
+     * @type {string}
+     * @memberof ClusterApiGetClusterByID
+     */
+    readonly restoreTime?: string
 }
 
 /**
@@ -2186,6 +2383,34 @@ export interface ClusterApiGetSqlAuditRequest {
     readonly component: string
 }
 
+/**
+ * Request parameters for getTDE operation in ClusterApi.
+ * @export
+ * @interface ClusterApiGetTDERequest
+ */
+export interface ClusterApiGetTDERequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof ClusterApiGetTDE
+     */
+    readonly orgName: string
+
+    /**
+     * name of the Cluster
+     * @type {string}
+     * @memberof ClusterApiGetTDE
+     */
+    readonly clusterName: string
+
+    /**
+     * component type
+     * @type {string}
+     * @memberof ClusterApiGetTDE
+     */
+    readonly component: string
+}
+
 /**
  * Request parameters for listCluster operation in ClusterApi.
  * @export
@@ -2529,6 +2754,34 @@ export interface ClusterApiUpdateSqlAuditRequest {
     readonly body: SqlAuditRequest
 }
 
+/**
+ * Request parameters for updateTDE operation in ClusterApi.
+ * @export
+ * @interface ClusterApiUpdateTDERequest
+ */
+export interface ClusterApiUpdateTDERequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof ClusterApiUpdateTDE
+     */
+    readonly orgName: string
+
+    /**
+     * name of the Cluster
+     * @type {string}
+     * @memberof ClusterApiUpdateTDE
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {TdeRequest}
+     * @memberof ClusterApiUpdateTDE
+     */
+    readonly body: TdeRequest
+}
+
 /**
  * Request parameters for validateClusterCreation operation in ClusterApi.
  * @export
@@ -2626,7 +2879,7 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
      * @memberof ClusterApi
      */
     public getClusterByID(requestParameters: ClusterApiGetClusterByIDRequest, options?: RawAxiosRequestConfig) {
-        return ClusterApiFp(this.configuration).getClusterByID(requestParameters.orgName, requestParameters.clusterID, options).then((request) => request(this.axios, this.basePath));
+        return ClusterApiFp(this.configuration).getClusterByID(requestParameters.orgName, requestParameters.clusterID, requestParameters.backupName, requestParameters.restoreTime, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -2677,6 +2930,18 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
         return ClusterApiFp(this.configuration).getSqlAudit(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Query the transparent data encryption switch status for a cluster component
+     * @summary Get TDE status
+     * @param {ClusterApiGetTDERequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApi
+     */
+    public getTDE(requestParameters: ClusterApiGetTDERequest, options?: RawAxiosRequestConfig) {
+        return ClusterApiFp(this.configuration).getTDE(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary List clusters in the Org
@@ -2797,6 +3062,18 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
         return ClusterApiFp(this.configuration).updateSqlAudit(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Enable transparent data encryption for a cluster component. Disabling TDE is not supported.
+     * @summary Enable TDE
+     * @param {ClusterApiUpdateTDERequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApi
+     */
+    public updateTDE(requestParameters: ClusterApiUpdateTDERequest, options?: RawAxiosRequestConfig) {
+        return ClusterApiFp(this.configuration).updateTDE(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Validate cluster creation