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

package/src/adminapi/models/postgresql-storage-overview.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlStorageOverview
+ */
+export interface PostgresqlStorageOverview {
+    /**
+     * Current total PVC capacity in bytes when backend-owned metrics are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
+     */
+    'totalBytes'?: number;
+    /**
+     * Current PVC used bytes when backend-owned metrics are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
+     */
+    'usedBytes'?: number;
+    /**
+     * Current available PVC bytes derived from totalBytes - usedBytes when both values are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
+     */
+    'availableBytes'?: number;
+    /**
+     * Current usedBytes / totalBytes ratio when both values are available.
+     * @type {number}
+     * @memberof PostgresqlStorageOverview
+     */
+    'usageRatio'?: number;
+    /**
+     * Metrics collection timestamp in UTC.
+     * @type {string}
+     * @memberof PostgresqlStorageOverview
+     */
+    'updatedAt'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlStorageOverview
+     */
+    'source': string;
+}
+

package/src/adminapi/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/adminapi/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;
 }
 

package/src/adminapi.yaml

@@ -3363,6 +3363,47 @@ paths:
       tags:
         - cluster
         - shared
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/storageUsageHistory:
+    get:
+      description: Get cluster storage usage history from backend-owned fixed metrics.
+      operationId: getClusterStorageUsageHistory
+      summary: Get cluster storage usage history
+      parameters:
+        - description: name of the Org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - name: timeRange
+          in: query
+          description: Requested history range. Supported values are 24h and 7d. Defaults to 24h.
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterStorageUsageHistory'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - cluster
+        - shared
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/instances/metrics:
     get:
       operationId: getInstacesMetrics
@@ -19088,7 +19129,7 @@ paths:
       tags:
         - diagnostics
       summary: Get PostgreSQL space analysis
-      description: Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+      description: Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
       operationId: getDiagnosticsPostgresqlSpaceAnalysis
       parameters:
         - name: orgName
@@ -23615,6 +23656,55 @@ components:
             type: array
             items: {}
             nullable: true
+    clusterStorageUsageHistoryPoint:
+      type: object
+      required:
+        - timestamp
+        - usedBytes
+        - totalBytes
+        - usageRatio
+      properties:
+        timestamp:
+          type: string
+        usedBytes:
+          type: integer
+          format: int64
+        totalBytes:
+          type: integer
+          format: int64
+        usageRatio:
+          type: number
+          format: double
+    clusterStorageUsageHistory:
+      type: object
+      description: Cluster storage usage history collected from backend-owned fixed metrics.
+      required:
+        - timeRange
+        - start
+        - end
+        - points
+        - source
+        - collectedAt
+      properties:
+        timeRange:
+          type: string
+          description: Requested history range. Supported values are 24h and 7d.
+        start:
+          type: string
+          description: History query start timestamp in UTC.
+        end:
+          type: string
+          description: History query end timestamp in UTC.
+        points:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterStorageUsageHistoryPoint'
+        source:
+          type: string
+          description: Metrics source used to build the history.
+        collectedAt:
+          type: string
+          description: Backend collection timestamp in UTC.
     instanceDiskUsageItem:
       description: disk usage with volume name.
       properties:
@@ -35663,8 +35753,6 @@ components:
         - toastRelationCount
         - tableListTruncated
         - indexListTruncated
-        - noHistoryYet
-        - cannotProveGrowth
       properties:
         databaseName:
           type: string
@@ -35690,47 +35778,42 @@ components:
           type: boolean
         indexListTruncated:
           type: boolean
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
-    postgresqlSpacePVC:
+    postgresqlStorageOverview:
       type: object
       required:
-        - noHistoryYet
-        - cannotProveGrowth
         - source
       properties:
-        currentUsedBytes:
+        totalBytes:
           type: integer
           format: int64
-          description: Current PVC used bytes from backend-owned metrics when available.
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
+          description: Current total PVC capacity in bytes when backend-owned metrics are available.
+        usedBytes:
+          type: integer
+          format: int64
+          description: Current PVC used bytes when backend-owned metrics are available.
+        availableBytes:
+          type: integer
+          format: int64
+          description: Current available PVC bytes derived from totalBytes - usedBytes when both values are available.
+        usageRatio:
+          type: number
+          format: double
+          description: Current usedBytes / totalBytes ratio when both values are available.
+        updatedAt:
+          type: string
+          description: Metrics collection timestamp in UTC.
         source:
           type: string
     postgresqlDatabaseSpace:
       type: object
-      required:
-        - noHistoryYet
-        - cannotProveGrowth
       properties:
         name:
           type: string
         sizeBytes:
           type: integer
           format: int64
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
     postgresqlTableSpace:
       type: object
-      required:
-        - noHistoryYet
-        - cannotProveGrowth
       properties:
         database:
           type: string
@@ -35776,15 +35859,8 @@ components:
           type: string
         lastAutoAnalyze:
           type: string
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
     postgresqlIndexSpace:
       type: object
-      required:
-        - noHistoryYet
-        - cannotProveGrowth
       properties:
         database:
           type: string
@@ -35816,15 +35892,8 @@ components:
         tuplesFetch:
           type: integer
           format: int64
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
     postgresqlToastRelationSpace:
       type: object
-      required:
-        - noHistoryYet
-        - cannotProveGrowth
       properties:
         database:
           type: string
@@ -35841,49 +35910,6 @@ components:
         toastBytes:
           type: integer
           format: int64
-        noHistoryYet:
-          type: boolean
-        cannotProveGrowth:
-          type: boolean
-    postgresqlSpaceRiskHint:
-      type: object
-      required:
-        - type
-        - severity
-        - message
-      properties:
-        type:
-          type: string
-        severity:
-          type: string
-        message:
-          type: string
-        objectKind:
-          type: string
-        schema:
-          type: string
-        objectName:
-          type: string
-        reason:
-          type: string
-    postgresqlSpaceCannotProve:
-      type: object
-      required:
-        - growth
-        - pvc
-        - objectHistory
-        - reasons
-      properties:
-        growth:
-          type: boolean
-        pvc:
-          type: boolean
-        objectHistory:
-          type: boolean
-        reasons:
-          type: array
-          items:
-            type: string
     postgresqlSpaceSource:
       type: object
       required:
@@ -35906,20 +35932,18 @@ components:
       type: object
       required:
         - summary
-        - pvc
+        - storageOverview
         - databases
         - tables
         - indexes
         - toastRelations
-        - riskHints
-        - cannotProve
         - sources
         - collectedAt
       properties:
         summary:
           $ref: '#/components/schemas/postgresqlSpaceSummary'
-        pvc:
-          $ref: '#/components/schemas/postgresqlSpacePVC'
+        storageOverview:
+          $ref: '#/components/schemas/postgresqlStorageOverview'
         databases:
           type: array
           items:
@@ -35936,12 +35960,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/postgresqlToastRelationSpace'
-        riskHints:
-          type: array
-          items:
-            $ref: '#/components/schemas/postgresqlSpaceRiskHint'
-        cannotProve:
-          $ref: '#/components/schemas/postgresqlSpaceCannotProve'
         sources:
           type: array
           items:

package/src/openapi/.openapi-generator/FILES

@@ -256,6 +256,8 @@ models/cluster-slow-log-explain-response.ts
 models/cluster-slow-log-stats.ts
 models/cluster-slow-log-template-list.ts
 models/cluster-slow-log-template.ts
+models/cluster-storage-usage-history-point.ts
+models/cluster-storage-usage-history.ts
 models/cluster-tags.ts
 models/cluster-termination-policy.ts
 models/cluster-type.ts
@@ -657,11 +659,9 @@ models/postgresql-lock-analysis.ts
 models/postgresql-lock-row.ts
 models/postgresql-session.ts
 models/postgresql-space-analysis.ts
-models/postgresql-space-cannot-prove.ts
-models/postgresql-space-pvc.ts
-models/postgresql-space-risk-hint.ts
 models/postgresql-space-source.ts
 models/postgresql-space-summary.ts
+models/postgresql-storage-overview.ts
 models/postgresql-table-space.ts
 models/postgresql-toast-relation-space.ts
 models/postgresql-wait-graph-edge-evidence.ts

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

@@ -36,6 +36,8 @@ import type { ClusterMetrics } from '../models';
 // @ts-ignore
 import type { ClusterModeTransition } from '../models';
 // @ts-ignore
+import type { ClusterStorageUsageHistory } from '../models';
+// @ts-ignore
 import type { ClusterUpdate } from '../models';
 // @ts-ignore
 import type { EndpointList } from '../models';
@@ -443,6 +445,56 @@ 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,
+            };
+        },
+        /**
+         * 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};
@@ -1437,6 +1489,21 @@ export const ClusterApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.getClusterInstanceLog']?.[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['ClusterApi.getClusterStorageUsageHistory']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Get instaces metrics in cluster
@@ -1767,6 +1834,16 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
         getClusterInstanceLog(requestParameters: ClusterApiGetClusterInstanceLogRequest, options?: RawAxiosRequestConfig): AxiosPromise<string> {
             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: ClusterApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterStorageUsageHistory> {
+            return localVarFp.getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Get instaces metrics in cluster
@@ -2006,6 +2083,16 @@ export interface ClusterApiInterface {
      */
     getClusterInstanceLog(requestParameters: ClusterApiGetClusterInstanceLogRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
 
+    /**
+     * 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 ClusterApiInterface
+     */
+    getClusterStorageUsageHistory(requestParameters: ClusterApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterStorageUsageHistory>;
+
     /**
      * 
      * @summary Get instaces metrics in cluster
@@ -2392,6 +2479,34 @@ export interface ClusterApiGetClusterInstanceLogRequest {
     readonly tailLines?: number
 }
 
+/**
+ * Request parameters for getClusterStorageUsageHistory operation in ClusterApi.
+ * @export
+ * @interface ClusterApiGetClusterStorageUsageHistoryRequest
+ */
+export interface ClusterApiGetClusterStorageUsageHistoryRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof ClusterApiGetClusterStorageUsageHistory
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof ClusterApiGetClusterStorageUsageHistory
+     */
+    readonly clusterName: string
+
+    /**
+     * Requested history range. Supported values are 24h and 7d. Defaults to 24h.
+     * @type {string}
+     * @memberof ClusterApiGetClusterStorageUsageHistory
+     */
+    readonly timeRange?: string
+}
+
 /**
  * Request parameters for getInstacesMetrics operation in ClusterApi.
  * @export
@@ -3001,6 +3116,18 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
         return 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
+     */
+    public getClusterStorageUsageHistory(requestParameters: ClusterApiGetClusterStorageUsageHistoryRequest, options?: RawAxiosRequestConfig) {
+        return ClusterApiFp(this.configuration).getClusterStorageUsageHistory(requestParameters.orgName, requestParameters.clusterName, requestParameters.timeRange, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Get instaces metrics in cluster

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

@@ -134,7 +134,7 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
             };
         },
         /**
-         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
          * @summary Get PostgreSQL space analysis
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
@@ -269,7 +269,7 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
          * @summary Get PostgreSQL space analysis
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
@@ -328,7 +328,7 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
             return localVarFp.getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(axios, basePath));
         },
         /**
-         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+         * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
          * @summary Get PostgreSQL space analysis
          * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -377,7 +377,7 @@ export interface DiagnosticsApiInterface {
     getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlLockAnalysis>;
 
     /**
-     * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+     * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
      * @summary Get PostgreSQL space analysis
      * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -535,7 +535,7 @@ export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
     }
 
     /**
-     * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, or remediation actions.
+     * Get a read-only PostgreSQL space snapshot from DMS and fixed backend-owned storage metrics. The response does not expose SQL, PromQL, storage history, or remediation actions.
      * @summary Get PostgreSQL space analysis
      * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.