kb-cloud-client-typescript 2.3.0-alpha.118 → 2.3.0-alpha.120

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

@@ -106,6 +106,8 @@ import type { ClusterSlowLogTemplate } from '../models';
 // @ts-ignore
 import type { ClusterSlowLogTemplateList } from '../models';
 // @ts-ignore
+import type { ClusterStorageUsageHistory } from '../models';
+// @ts-ignore
 import type { ClusterTags } from '../models';
 // @ts-ignore
 import type { ClusterUpdate } from '../models';
@@ -5056,6 +5058,56 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                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: string, clusterName: string, timeRange?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getClusterStorageUsageHistory', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getClusterStorageUsageHistory', 'clusterName', clusterName)
+            const localVarPath = `/api/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, 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
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (timeRange !== undefined) {
+                localVarQueryParameter['timeRange'] = timeRange;
+            }
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -15371,6 +15423,21 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.getClusterParameterTemplate']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, 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: string, clusterName: string, timeRange?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterStorageUsageHistory>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getClusterStorageUsageHistory(orgName, clusterName, timeRange, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.getClusterStorageUsageHistory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary get the datasource
@@ -18817,6 +18884,16 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         getClusterParameterTemplate(requestParameters: SharedApiGetClusterParameterTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParamTplApplyToClusterList> {
             return localVarFp.getClusterParameterTemplate(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.engineName, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get cluster storage usage history from backend-owned fixed metrics.
+         * @summary Get cluster storage usage history
+         * @param {SharedApiGetClusterStorageUsageHistoryRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getClusterStorageUsageHistory(requestParameters: SharedApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterStorageUsageHistory> {
+            return localVarFp.getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary get the datasource
@@ -21292,6 +21369,16 @@ export interface SharedApiInterface {
      */
     getClusterParameterTemplate(requestParameters: SharedApiGetClusterParameterTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParamTplApplyToClusterList>;
 
+    /**
+     * Get cluster storage usage history from backend-owned fixed metrics.
+     * @summary Get cluster storage usage history
+     * @param {SharedApiGetClusterStorageUsageHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    getClusterStorageUsageHistory(requestParameters: SharedApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterStorageUsageHistory>;
+
     /**
      * 
      * @summary get the datasource
@@ -25797,6 +25884,34 @@ export interface SharedApiGetClusterParameterTemplateRequest {
     readonly engineName?: string
 }
 
+/**
+ * Request parameters for getClusterStorageUsageHistory operation in SharedApi.
+ * @export
+ * @interface SharedApiGetClusterStorageUsageHistoryRequest
+ */
+export interface SharedApiGetClusterStorageUsageHistoryRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof SharedApiGetClusterStorageUsageHistory
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof SharedApiGetClusterStorageUsageHistory
+     */
+    readonly clusterName: string
+
+    /**
+     * Requested history range. Supported values are 24h and 7d. Defaults to 24h.
+     * @type {string}
+     * @memberof SharedApiGetClusterStorageUsageHistory
+     */
+    readonly timeRange?: string
+}
+
 /**
  * Request parameters for getDataSourceV2 operation in SharedApi.
  * @export
@@ -32444,6 +32559,18 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
         return SharedApiFp(this.configuration).getClusterParameterTemplate(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.engineName, 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 {SharedApiGetClusterStorageUsageHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public getClusterStorageUsageHistory(requestParameters: SharedApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary get the datasource

package/src/openapi/models/{postgresql-space-pvc.ts → cluster-storage-usage-history-point.ts}

@@ -17,32 +17,32 @@
 /**
  * 
  * @export
- * @interface PostgresqlSpacePVC
+ * @interface ClusterStorageUsageHistoryPoint
  */
-export interface PostgresqlSpacePVC {
+export interface ClusterStorageUsageHistoryPoint {
     /**
-     * Current PVC used bytes from backend-owned metrics when available.
-     * @type {number}
-     * @memberof PostgresqlSpacePVC
+     * 
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryPoint
      */
-    'currentUsedBytes'?: number;
+    'timestamp': string;
     /**
      * 
-     * @type {boolean}
-     * @memberof PostgresqlSpacePVC
+     * @type {number}
+     * @memberof ClusterStorageUsageHistoryPoint
      */
-    'noHistoryYet': boolean;
+    'usedBytes': number;
     /**
      * 
-     * @type {boolean}
-     * @memberof PostgresqlSpacePVC
+     * @type {number}
+     * @memberof ClusterStorageUsageHistoryPoint
      */
-    'cannotProveGrowth': boolean;
+    'totalBytes': number;
     /**
      * 
-     * @type {string}
-     * @memberof PostgresqlSpacePVC
+     * @type {number}
+     * @memberof ClusterStorageUsageHistoryPoint
      */
-    'source': string;
+    'usageRatio': number;
 }
 

package/src/openapi/models/cluster-storage-usage-history.ts

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 { ClusterStorageUsageHistoryPoint } from './cluster-storage-usage-history-point';
+
+/**
+ * Cluster storage usage history collected from backend-owned fixed metrics.
+ * @export
+ * @interface ClusterStorageUsageHistory
+ */
+export interface ClusterStorageUsageHistory {
+    /**
+     * Requested history range. Supported values are 24h and 7d.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'timeRange': string;
+    /**
+     * History query start timestamp in UTC.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'start': string;
+    /**
+     * History query end timestamp in UTC.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'end': string;
+    /**
+     * 
+     * @type {Array<ClusterStorageUsageHistoryPoint>}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'points': Array<ClusterStorageUsageHistoryPoint>;
+    /**
+     * Metrics source used to build the history.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'source': string;
+    /**
+     * Backend collection timestamp in UTC.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistory
+     */
+    'collectedAt': string;
+}
+

package/src/openapi/models/index.ts

@@ -172,6 +172,8 @@ export * from './cluster-slow-log-explain-response';
 export * from './cluster-slow-log-stats';
 export * from './cluster-slow-log-template';
 export * from './cluster-slow-log-template-list';
+export * from './cluster-storage-usage-history';
+export * from './cluster-storage-usage-history-point';
 export * from './cluster-tags';
 export * from './cluster-termination-policy';
 export * from './cluster-type';
@@ -570,11 +572,9 @@ export * from './postgresql-lock-analysis';
 export * from './postgresql-lock-row';
 export * from './postgresql-session';
 export * from './postgresql-space-analysis';
-export * from './postgresql-space-cannot-prove';
-export * from './postgresql-space-pvc';
-export * from './postgresql-space-risk-hint';
 export * from './postgresql-space-source';
 export * from './postgresql-space-summary';
+export * from './postgresql-storage-overview';
 export * from './postgresql-table-space';
 export * from './postgresql-toast-relation-space';
 export * from './postgresql-wait-graph';

package/src/openapi/models/postgresql-database-space.ts

@@ -32,17 +32,5 @@ export interface PostgresqlDatabaseSpace {
      * @memberof PostgresqlDatabaseSpace
      */
     'sizeBytes'?: number;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlDatabaseSpace
-     */
-    'noHistoryYet': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlDatabaseSpace
-     */
-    'cannotProveGrowth': boolean;
 }
 

package/src/openapi/models/postgresql-index-space.ts

@@ -92,17 +92,5 @@ export interface PostgresqlIndexSpace {
      * @memberof PostgresqlIndexSpace
      */
     'tuplesFetch'?: number;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlIndexSpace
-     */
-    'noHistoryYet': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlIndexSpace
-     */
-    'cannotProveGrowth': boolean;
 }
 

package/src/openapi/models/postgresql-space-analysis.ts

@@ -21,21 +21,15 @@ import type { PostgresqlDatabaseSpace } from './postgresql-database-space';
 import type { PostgresqlIndexSpace } from './postgresql-index-space';
 // May contain unused imports in some cases
 // @ts-ignore
-import type { PostgresqlSpaceCannotProve } from './postgresql-space-cannot-prove';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { PostgresqlSpacePVC } from './postgresql-space-pvc';
-// May contain unused imports in some cases
-// @ts-ignore
-import type { PostgresqlSpaceRiskHint } from './postgresql-space-risk-hint';
-// May contain unused imports in some cases
-// @ts-ignore
 import type { PostgresqlSpaceSource } from './postgresql-space-source';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { PostgresqlSpaceSummary } from './postgresql-space-summary';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { PostgresqlStorageOverview } from './postgresql-storage-overview';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { PostgresqlTableSpace } from './postgresql-table-space';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -55,10 +49,10 @@ export interface PostgresqlSpaceAnalysis {
     'summary': PostgresqlSpaceSummary;
     /**
      * 
-     * @type {PostgresqlSpacePVC}
+     * @type {PostgresqlStorageOverview}
      * @memberof PostgresqlSpaceAnalysis
      */
-    'pvc': PostgresqlSpacePVC;
+    'storageOverview': PostgresqlStorageOverview;
     /**
      * 
      * @type {Array<PostgresqlDatabaseSpace>}
@@ -83,18 +77,6 @@ export interface PostgresqlSpaceAnalysis {
      * @memberof PostgresqlSpaceAnalysis
      */
     'toastRelations': Array<PostgresqlToastRelationSpace>;
-    /**
-     * 
-     * @type {Array<PostgresqlSpaceRiskHint>}
-     * @memberof PostgresqlSpaceAnalysis
-     */
-    'riskHints': Array<PostgresqlSpaceRiskHint>;
-    /**
-     * 
-     * @type {PostgresqlSpaceCannotProve}
-     * @memberof PostgresqlSpaceAnalysis
-     */
-    'cannotProve': PostgresqlSpaceCannotProve;
     /**
      * 
      * @type {Array<PostgresqlSpaceSource>}

package/src/openapi/models/postgresql-space-summary.ts

@@ -74,17 +74,5 @@ export interface PostgresqlSpaceSummary {
      * @memberof PostgresqlSpaceSummary
      */
     'indexListTruncated': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlSpaceSummary
-     */
-    'noHistoryYet': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlSpaceSummary
-     */
-    'cannotProveGrowth': boolean;
 }
 

package/src/openapi/models/{postgresql-space-risk-hint.ts → postgresql-storage-overview.ts}

@@ -17,50 +17,44 @@
 /**
  * 
  * @export
- * @interface PostgresqlSpaceRiskHint
+ * @interface PostgresqlStorageOverview
  */
-export interface PostgresqlSpaceRiskHint {
+export interface PostgresqlStorageOverview {
     /**
-     * 
-     * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * Current total PVC capacity in bytes when backend-owned metrics are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
      */
-    'type': string;
+    'totalBytes'?: number;
     /**
-     * 
-     * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * Current PVC used bytes when backend-owned metrics are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
      */
-    'severity': string;
+    'usedBytes'?: number;
     /**
-     * 
-     * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * Current available PVC bytes derived from totalBytes - usedBytes when both values are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
      */
-    'message': string;
+    'availableBytes'?: number;
     /**
-     * 
-     * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
-     */
-    'objectKind'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * Current usedBytes / totalBytes ratio when both values are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
      */
-    'schema'?: string;
+    'usageRatio'?: number;
     /**
-     * 
+     * Metrics collection timestamp in UTC.
      * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * @memberof PostgresqlStorageOverview
      */
-    'objectName'?: string;
+    'updatedAt'?: string;
     /**
      * 
      * @type {string}
-     * @memberof PostgresqlSpaceRiskHint
+     * @memberof PostgresqlStorageOverview
      */
-    'reason'?: string;
+    'source': string;
 }
 

package/src/openapi/models/postgresql-table-space.ts

@@ -122,17 +122,5 @@ export interface PostgresqlTableSpace {
      * @memberof PostgresqlTableSpace
      */
     'lastAutoAnalyze'?: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlTableSpace
-     */
-    'noHistoryYet': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlTableSpace
-     */
-    'cannotProveGrowth': boolean;
 }
 

package/src/openapi/models/postgresql-toast-relation-space.ts

@@ -56,17 +56,5 @@ export interface PostgresqlToastRelationSpace {
      * @memberof PostgresqlToastRelationSpace
      */
     'toastBytes'?: number;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlToastRelationSpace
-     */
-    'noHistoryYet': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof PostgresqlToastRelationSpace
-     */
-    'cannotProveGrowth': boolean;
 }