kb-cloud-client-typescript 0.0.0-bugfix-list-database-parameters-e2e.20260616.802 → 0.0.0-bugfix-mysql-parameter-migration-conflicts.20260910.559

package/dist/adminapi/apis/cluster-api.js

@@ -341,6 +341,48 @@ const ClusterApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get cluster storage usage history from backend-owned fixed metrics.
+         * @summary Get cluster storage usage history
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the cluster
+         * @param {string} [timeRange] Requested history range. Supported values are 24h and 7d. Defaults to 24h.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getClusterStorageUsageHistory: async (orgName, clusterName, timeRange, options = {}) => {
+            // verify required parameter 'orgName' is not null or undefined
+            (0, common_1.assertParamExists)('getClusterStorageUsageHistory', 'orgName', orgName);
+            // verify required parameter 'clusterName' is not null or undefined
+            (0, common_1.assertParamExists)('getClusterStorageUsageHistory', 'clusterName', clusterName);
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/storageUsageHistory`
+                .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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerToken required
+            // http bearer authentication required
+            await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication DigestAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            if (timeRange !== undefined) {
+                localVarQueryParameter['timeRange'] = timeRange;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Get instaces metrics in cluster
@@ -534,10 +576,12 @@ const ClusterApiAxiosParamCreator = function (configuration) {
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCluster: async (orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, options = {}) => {
+        listCluster: async (orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, endpointHost, includeEndpoints, options = {}) => {
             // verify required parameter 'orgName' is not null or undefined
             (0, common_1.assertParamExists)('listCluster', 'orgName', orgName);
             const localVarPath = `/admin/v1/organizations/{orgName}/clusters`
@@ -583,6 +627,12 @@ const ClusterApiAxiosParamCreator = function (configuration) {
             if (refClusterName !== undefined) {
                 localVarQueryParameter['refClusterName'] = refClusterName;
             }
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -597,10 +647,12 @@ const ClusterApiAxiosParamCreator = function (configuration) {
          * @param {string} [orgName] Organization name, if envName is provided, orgName is required
          * @param {string} [envName] Environment name
          * @param {boolean} [withStatic] Whether to include static clusters
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listClusters: async (orgName, envName, withStatic, options = {}) => {
+        listClusters: async (orgName, envName, withStatic, endpointHost, includeEndpoints, options = {}) => {
             const localVarPath = `/admin/v1/clusters`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -625,6 +677,12 @@ const ClusterApiAxiosParamCreator = function (configuration) {
             if (withStatic !== undefined) {
                 localVarQueryParameter['withStatic'] = withStatic;
             }
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -944,6 +1002,49 @@ const ClusterApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Validates the mode transition, updates the cluster spec, and creates an hscale task when required. Returns the resulting OpsRequest name and task ID.
+         * @summary Transition cluster engine mode
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ClusterModeTransition} body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        transitionClusterMode: async (orgName, clusterName, body, options = {}) => {
+            // verify required parameter 'orgName' is not null or undefined
+            (0, common_1.assertParamExists)('transitionClusterMode', 'orgName', orgName);
+            // verify required parameter 'clusterName' is not null or undefined
+            (0, common_1.assertParamExists)('transitionClusterMode', 'clusterName', clusterName);
+            // verify required parameter 'body' is not null or undefined
+            (0, common_1.assertParamExists)('transitionClusterMode', 'body', body);
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/modeTransition`
+                .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, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication BearerToken required
+            // http bearer authentication required
+            await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            // authentication DigestAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Enable or disable SQL audit log for a cluster component
          * @summary Update SQL audit log status
@@ -1194,6 +1295,22 @@ const ClusterApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.getClusterInstanceLog']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get cluster storage usage history from backend-owned fixed metrics.
+         * @summary Get cluster storage usage history
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the cluster
+         * @param {string} [timeRange] Requested history range. Supported values are 24h and 7d. Defaults to 24h.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getClusterStorageUsageHistory(orgName, clusterName, timeRange, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterStorageUsageHistory(orgName, clusterName, timeRange, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.getClusterStorageUsageHistory']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary Get instaces metrics in cluster
@@ -1273,12 +1390,14 @@ const ClusterApiFp = function (configuration) {
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
          * @param {string} [refClusterName] list clusters referenced by this cluster
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, options) {
+        async listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, endpointHost, includeEndpoints, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, refClusterName, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.listCluster']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1289,12 +1408,14 @@ const ClusterApiFp = function (configuration) {
          * @param {string} [orgName] Organization name, if envName is provided, orgName is required
          * @param {string} [envName] Environment name
          * @param {boolean} [withStatic] Whether to include static clusters
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listClusters(orgName, envName, withStatic, options) {
+        async listClusters(orgName, envName, withStatic, endpointHost, includeEndpoints, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listClusters(orgName, envName, withStatic, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listClusters(orgName, envName, withStatic, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.listClusters']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1413,6 +1534,22 @@ const ClusterApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.restartInstance']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Validates the mode transition, updates the cluster spec, and creates an hscale task when required. Returns the resulting OpsRequest name and task ID.
+         * @summary Transition cluster engine mode
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ClusterModeTransition} body
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async transitionClusterMode(orgName, clusterName, body, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.transitionClusterMode(orgName, clusterName, body, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClusterApi.transitionClusterMode']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Enable or disable SQL audit log for a cluster component
          * @summary Update SQL audit log status
@@ -1540,6 +1677,16 @@ const ClusterApiFactory = function (configuration, basePath, axios) {
         getClusterInstanceLog(requestParameters, options) {
             return localVarFp.getClusterInstanceLog(requestParameters.orgName, requestParameters.clusterName, requestParameters.workloadName, requestParameters.workloadType, requestParameters.previous, requestParameters.sinceSeconds, requestParameters.tailLines, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get cluster storage usage history from backend-owned fixed metrics.
+         * @summary Get cluster storage usage history
+         * @param {ClusterApiGetClusterStorageUsageHistoryRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getClusterStorageUsageHistory(requestParameters, options) {
+            return localVarFp.getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Get instaces metrics in cluster
@@ -1588,7 +1735,7 @@ const ClusterApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listCluster(requestParameters, options) {
-            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(axios, basePath));
+            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          * Get cluster list
@@ -1598,7 +1745,7 @@ const ClusterApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         listClusters(requestParameters = {}, options) {
-            return localVarFp.listClusters(requestParameters.orgName, requestParameters.envName, requestParameters.withStatic, options).then((request) => request(axios, basePath));
+            return localVarFp.listClusters(requestParameters.orgName, requestParameters.envName, requestParameters.withStatic, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -1670,6 +1817,16 @@ const ClusterApiFactory = function (configuration, basePath, axios) {
         restartInstance(requestParameters, options) {
             return localVarFp.restartInstance(requestParameters.orgName, requestParameters.clusterName, requestParameters.instanceName, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Validates the mode transition, updates the cluster spec, and creates an hscale task when required. Returns the resulting OpsRequest name and task ID.
+         * @summary Transition cluster engine mode
+         * @param {ClusterApiTransitionClusterModeRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        transitionClusterMode(requestParameters, options) {
+            return localVarFp.transitionClusterMode(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(axios, basePath));
+        },
         /**
          * Enable or disable SQL audit log for a cluster component
          * @summary Update SQL audit log status
@@ -1787,6 +1944,17 @@ class ClusterApi extends base_1.BaseAPI {
     getClusterInstanceLog(requestParameters, options) {
         return (0, exports.ClusterApiFp)(this.configuration).getClusterInstanceLog(requestParameters.orgName, requestParameters.clusterName, requestParameters.workloadName, requestParameters.workloadType, requestParameters.previous, requestParameters.sinceSeconds, requestParameters.tailLines, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Get cluster storage usage history from backend-owned fixed metrics.
+     * @summary Get cluster storage usage history
+     * @param {ClusterApiGetClusterStorageUsageHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApi
+     */
+    getClusterStorageUsageHistory(requestParameters, options) {
+        return (0, exports.ClusterApiFp)(this.configuration).getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Get instaces metrics in cluster
@@ -1840,7 +2008,7 @@ class ClusterApi extends base_1.BaseAPI {
      * @memberof ClusterApi
      */
     listCluster(requestParameters, options) {
-        return (0, exports.ClusterApiFp)(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.ClusterApiFp)(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Get cluster list
@@ -1851,7 +2019,7 @@ class ClusterApi extends base_1.BaseAPI {
      * @memberof ClusterApi
      */
     listClusters(requestParameters = {}, options) {
-        return (0, exports.ClusterApiFp)(this.configuration).listClusters(requestParameters.orgName, requestParameters.envName, requestParameters.withStatic, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.ClusterApiFp)(this.configuration).listClusters(requestParameters.orgName, requestParameters.envName, requestParameters.withStatic, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -1930,6 +2098,17 @@ class ClusterApi extends base_1.BaseAPI {
     restartInstance(requestParameters, options) {
         return (0, exports.ClusterApiFp)(this.configuration).restartInstance(requestParameters.orgName, requestParameters.clusterName, requestParameters.instanceName, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Validates the mode transition, updates the cluster spec, and creates an hscale task when required. Returns the resulting OpsRequest name and task ID.
+     * @summary Transition cluster engine mode
+     * @param {ClusterApiTransitionClusterModeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ClusterApi
+     */
+    transitionClusterMode(requestParameters, options) {
+        return (0, exports.ClusterApiFp)(this.configuration).transitionClusterMode(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Enable or disable SQL audit log for a cluster component
      * @summary Update SQL audit log status