kb-cloud-client-typescript 2.4.0-alpha.88 → 2.4.0-alpha.89

package/src/internalapi/apis/shared-api.ts

@@ -24,7 +24,13 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
 // @ts-ignore
 import type { APIErrorResponse } from '../models';
 // @ts-ignore
+import type { OpsRequestName } from '../models';
+// @ts-ignore
+import type { ParameterList } from '../models';
+// @ts-ignore
 import type { PlatformParameter } from '../models';
+// @ts-ignore
+import type { ReconfigureCreate } from '../models';
 /**
  * SharedApi - axios parameter creator
  * @export
@@ -64,6 +70,106 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} [component] component type
+         * @param {boolean} [rawContent] whether to return the raw template content
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listParameterProps: async (orgName: string, clusterName: string, component?: string, rawContent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('listParameterProps', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('listParameterProps', 'clusterName', clusterName)
+            const localVarPath = `/internal/v1/organizations/{orgName}/clusters/{clusterName}/parameters`
+                .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 BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            if (component !== undefined) {
+                localVarQueryParameter['component'] = component;
+            }
+
+            if (rawContent !== undefined) {
+                localVarQueryParameter['rawContent'] = rawContent;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ReconfigureCreate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reconfigureCluster: async (orgName: string, clusterName: string, body: ReconfigureCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('reconfigureCluster', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('reconfigureCluster', 'clusterName', clusterName)
+            // verify required parameter 'body' is not null or undefined
+            assertParamExists('reconfigureCluster', 'body', body)
+            const localVarPath = `/internal/v1/organizations/{orgName}/clusters/{clusterName}/reconfigure`
+                .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 BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+
+    
+            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,
@@ -92,6 +198,37 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.getPlatformParameter']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} [component] component type
+         * @param {boolean} [rawContent] whether to return the raw template content
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listParameterProps(orgName: string, clusterName: string, component?: string, rawContent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listParameterProps(orgName, clusterName, component, rawContent, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.listParameterProps']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ReconfigureCreate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async reconfigureCluster(orgName: string, clusterName: string, body: ReconfigureCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpsRequestName>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.reconfigureCluster(orgName, clusterName, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.reconfigureCluster']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -112,6 +249,26 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         getPlatformParameter(requestParameters: SharedApiGetPlatformParameterRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlatformParameter> {
             return localVarFp.getPlatformParameter(requestParameters.platformParameterName, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {SharedApiListParameterPropsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listParameterProps(requestParameters: SharedApiListParameterPropsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParameterList> {
+            return localVarFp.listParameterProps(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.rawContent, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {SharedApiReconfigureClusterRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reconfigureCluster(requestParameters: SharedApiReconfigureClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName> {
+            return localVarFp.reconfigureCluster(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -131,6 +288,26 @@ export interface SharedApiInterface {
      */
     getPlatformParameter(requestParameters: SharedApiGetPlatformParameterRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlatformParameter>;
 
+    /**
+     * 
+     * @summary List parameter properties of the cluster
+     * @param {SharedApiListParameterPropsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    listParameterProps(requestParameters: SharedApiListParameterPropsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParameterList>;
+
+    /**
+     * 
+     * @summary Update cluster configuration
+     * @param {SharedApiReconfigureClusterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    reconfigureCluster(requestParameters: SharedApiReconfigureClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName>;
+
 }
 
 /**
@@ -147,6 +324,69 @@ export interface SharedApiGetPlatformParameterRequest {
     readonly platformParameterName: string
 }
 
+/**
+ * Request parameters for listParameterProps operation in SharedApi.
+ * @export
+ * @interface SharedApiListParameterPropsRequest
+ */
+export interface SharedApiListParameterPropsRequest {
+    /**
+     * name of the organization
+     * @type {string}
+     * @memberof SharedApiListParameterProps
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof SharedApiListParameterProps
+     */
+    readonly clusterName: string
+
+    /**
+     * component type
+     * @type {string}
+     * @memberof SharedApiListParameterProps
+     */
+    readonly component?: string
+
+    /**
+     * whether to return the raw template content
+     * @type {boolean}
+     * @memberof SharedApiListParameterProps
+     */
+    readonly rawContent?: boolean
+}
+
+/**
+ * Request parameters for reconfigureCluster operation in SharedApi.
+ * @export
+ * @interface SharedApiReconfigureClusterRequest
+ */
+export interface SharedApiReconfigureClusterRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof SharedApiReconfigureCluster
+     */
+    readonly orgName: string
+
+    /**
+     * name of the KubeBlocks cluster
+     * @type {string}
+     * @memberof SharedApiReconfigureCluster
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {ReconfigureCreate}
+     * @memberof SharedApiReconfigureCluster
+     */
+    readonly body: ReconfigureCreate
+}
+
 /**
  * SharedApi - object-oriented interface
  * @export
@@ -165,5 +405,29 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
     public getPlatformParameter(requestParameters: SharedApiGetPlatformParameterRequest, options?: RawAxiosRequestConfig) {
         return SharedApiFp(this.configuration).getPlatformParameter(requestParameters.platformParameterName, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 
+     * @summary List parameter properties of the cluster
+     * @param {SharedApiListParameterPropsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public listParameterProps(requestParameters: SharedApiListParameterPropsRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).listParameterProps(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.rawContent, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * 
+     * @summary Update cluster configuration
+     * @param {SharedApiReconfigureClusterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public reconfigureCluster(requestParameters: SharedApiReconfigureClusterRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).reconfigureCluster(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/src/internalapi/models/index.ts

@@ -41,13 +41,18 @@ export * from './ip-pool-selection';
 export * from './koordinator-reservation-resource-class';
 export * from './localized-description';
 export * from './network-mode';
+export * from './ops-request-name';
 export * from './outage-record';
 export * from './page-result';
 export * from './param-tpls-item';
+export * from './parameter-item';
+export * from './parameter-list';
+export * from './parameter-prop';
 export * from './parameter-template-partition';
 export * from './platform-parameter';
 export * from './platform-parameter-constraints';
 export * from './postable-alert';
+export * from './reconfigure-create';
 export * from './scheduling-policy-type';
 export * from './service-descriptor';
 export * from './service-ref';
@@ -55,3 +60,5 @@ export * from './static-cluster';
 export * from './storage';
 export * from './storage-create';
 export * from './tag';
+export * from './task-schedule';
+export * from './task-schedule-type';

package/src/internalapi/models/ops-request-name.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * OpsRequestName is the name of a KubeBlocks OpsRequest response
+ * @export
+ * @interface OpsRequestName
+ */
+export interface OpsRequestName {
+    /**
+     * 
+     * @type {string}
+     * @memberof OpsRequestName
+     */
+    'opsRequestName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OpsRequestName
+     */
+    'taskId': string;
+}
+

package/src/internalapi/models/parameter-item.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ParameterProp } from './parameter-prop';
+
+/**
+ * With the list of parameter properties and the configuration file name
+ * @export
+ * @interface ParameterItem
+ */
+export interface ParameterItem {
+    /**
+     * The list of parameters properties
+     * @type {Array<ParameterProp>}
+     * @memberof ParameterItem
+     */
+    'props'?: Array<ParameterProp>;
+    /**
+     * The additional properties of the parameter
+     * @type {Array<ParameterProp>}
+     * @memberof ParameterItem
+     */
+    'additionalProps'?: Array<ParameterProp>;
+    /**
+     * The name of the configuration file
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'fileName'?: string;
+    /**
+     * The name of the config spec
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'specName'?: string;
+    /**
+     * The raw content of the configuration file, return only when raw is true in the query.
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'rawContent'?: string;
+}
+

package/src/internalapi/models/parameter-list.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ParameterItem } from './parameter-item';
+
+/**
+ * A list of cluster parameter
+ * @export
+ * @interface ParameterList
+ */
+export interface ParameterList {
+    /**
+     * Name of database engine
+     * @type {string}
+     * @memberof ParameterList
+     */
+    'engine': string;
+    /**
+     * Name of component
+     * @type {string}
+     * @memberof ParameterList
+     */
+    'component': string;
+    /**
+     * 
+     * @type {Array<ParameterItem>}
+     * @memberof ParameterList
+     */
+    'items'?: Array<ParameterItem>;
+}
+

package/src/internalapi/models/parameter-prop.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ParameterProp
+ */
+export interface ParameterProp {
+    /**
+     * The name of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'name': string;
+    /**
+     * The description of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'description'?: string;
+    /**
+     * The type of the parameter value
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'type': string;
+    /**
+     * The value of the parameter, if parameter is not set in tpl, it\'s value equal to cue default value.
+     * @type {object}
+     * @memberof ParameterProp
+     */
+    'value'?: object;
+    /**
+     * The value of the parameter, if parameter is not set in tpl, it\'s value equal to cue default value.
+     * @type {object}
+     * @memberof ParameterProp
+     */
+    'default'?: object;
+    /**
+     * Whether the parameter requires a restart to take effect
+     * @type {boolean}
+     * @memberof ParameterProp
+     */
+    'needRestart': boolean;
+    /**
+     * Whether the parameter is an immutable parameter, immutable parameters cannot be modified
+     * @type {boolean}
+     * @memberof ParameterProp
+     */
+    'immutable': boolean;
+    /**
+     * The maximum value of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'maximum'?: string;
+    /**
+     * The minimum value of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'minimum'?: string;
+    /**
+     * The value options of the parameter
+     * @type {Array<any>}
+     * @memberof ParameterProp
+     */
+    'enum'?: Array<any>;
+    /**
+     * The unit of the parameter value (e.g., seconds, bytes, ms, percentage)
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'unit'?: string;
+}
+

package/src/internalapi/models/reconfigure-create.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TaskSchedule } from './task-schedule';
+
+/**
+ * ReconfigureCreate is the payload to reconfigure a KubeBlocks cluster
+ * @export
+ * @interface ReconfigureCreate
+ */
+export interface ReconfigureCreate {
+    /**
+     * component type
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'component': string;
+    /**
+     * config file name
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'configFileName'?: string;
+    /**
+     * Specify parameters list to be updated
+     * @type {{ [key: string]: string; }}
+     * @memberof ReconfigureCreate
+     */
+    'parameters'?: { [key: string]: string; };
+    /**
+     * The raw content of the configuration file
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'rawContent'?: string;
+    /**
+     * 
+     * @type {TaskSchedule}
+     * @memberof ReconfigureCreate
+     */
+    'schedule'?: TaskSchedule;
+}
+

package/src/internalapi/models/task-schedule-type.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schedule type for task execution
+ * @export
+ * @enum {string}
+ */
+
+export const TaskScheduleType = {
+    immediate: 'immediate',
+    scheduled: 'scheduled',
+    maintenanceWindow: 'maintenanceWindow'
+} as const;
+
+export type TaskScheduleType = typeof TaskScheduleType[keyof typeof TaskScheduleType];
+
+
+