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

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

@@ -0,0 +1,72 @@
+/* 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 PostgresqlToastRelationSpace
+ */
+export interface PostgresqlToastRelationSpace {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'database'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'schema'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'table'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'tableRelationOid'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'toastRelationOid'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'toastBytes'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'noHistoryYet': boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlToastRelationSpace
+     */
+    'cannotProveGrowth': boolean;
+}
+

package/src/adminapi.yaml

@@ -19083,6 +19083,41 @@ paths:
           $ref: '#/components/responses/403'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/spaceAnalysis:
+    get:
+      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.
+      operationId: getDiagnosticsPostgresqlSpaceAnalysis
+      parameters:
+        - name: orgName
+          in: path
+          description: Organization name
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: Cluster name
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/postgresqlSpaceAnalysis'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
     get:
       tags:
@@ -35620,6 +35655,300 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/postgresqlSession'
+    postgresqlSpaceSummary:
+      type: object
+      required:
+        - tableCount
+        - indexCount
+        - toastRelationCount
+        - tableListTruncated
+        - indexListTruncated
+        - noHistoryYet
+        - cannotProveGrowth
+      properties:
+        databaseName:
+          type: string
+        databaseSizeBytes:
+          type: integer
+          format: int64
+        tableCount:
+          type: integer
+          format: int64
+        indexCount:
+          type: integer
+          format: int64
+        toastRelationCount:
+          type: integer
+          format: int64
+        largestTableBytes:
+          type: integer
+          format: int64
+        largestIndexBytes:
+          type: integer
+          format: int64
+        tableListTruncated:
+          type: boolean
+        indexListTruncated:
+          type: boolean
+        noHistoryYet:
+          type: boolean
+        cannotProveGrowth:
+          type: boolean
+    postgresqlSpacePVC:
+      type: object
+      required:
+        - noHistoryYet
+        - cannotProveGrowth
+        - source
+      properties:
+        currentUsedBytes:
+          type: integer
+          format: int64
+          description: Current PVC used bytes from backend-owned metrics when available.
+        noHistoryYet:
+          type: boolean
+        cannotProveGrowth:
+          type: boolean
+        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
+        schema:
+          type: string
+        name:
+          type: string
+        relationOid:
+          type: integer
+          format: int64
+        totalBytes:
+          type: integer
+          format: int64
+        tableBytes:
+          type: integer
+          format: int64
+        indexBytes:
+          type: integer
+          format: int64
+        toastBytes:
+          type: integer
+          format: int64
+        toastRelationOid:
+          type: integer
+          format: int64
+        liveTuples:
+          type: integer
+          format: int64
+        deadTuples:
+          type: integer
+          format: int64
+        seqScan:
+          type: integer
+          format: int64
+        indexScan:
+          type: integer
+          format: int64
+        lastVacuum:
+          type: string
+        lastAutoVacuum:
+          type: string
+        lastAnalyze:
+          type: string
+        lastAutoAnalyze:
+          type: string
+        noHistoryYet:
+          type: boolean
+        cannotProveGrowth:
+          type: boolean
+    postgresqlIndexSpace:
+      type: object
+      required:
+        - noHistoryYet
+        - cannotProveGrowth
+      properties:
+        database:
+          type: string
+        schema:
+          type: string
+        table:
+          type: string
+        name:
+          type: string
+        tableRelationOid:
+          type: integer
+          format: int64
+        relationOid:
+          type: integer
+          format: int64
+        sizeBytes:
+          type: integer
+          format: int64
+        isPrimary:
+          type: boolean
+        isUnique:
+          type: boolean
+        scanCount:
+          type: integer
+          format: int64
+        tuplesRead:
+          type: integer
+          format: int64
+        tuplesFetch:
+          type: integer
+          format: int64
+        noHistoryYet:
+          type: boolean
+        cannotProveGrowth:
+          type: boolean
+    postgresqlToastRelationSpace:
+      type: object
+      required:
+        - noHistoryYet
+        - cannotProveGrowth
+      properties:
+        database:
+          type: string
+        schema:
+          type: string
+        table:
+          type: string
+        tableRelationOid:
+          type: integer
+          format: int64
+        toastRelationOid:
+          type: integer
+          format: int64
+        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:
+        - name
+        - kind
+        - status
+        - collectedAt
+      properties:
+        name:
+          type: string
+        kind:
+          type: string
+        status:
+          type: string
+        collectedAt:
+          type: string
+        message:
+          type: string
+    postgresqlSpaceAnalysis:
+      type: object
+      required:
+        - summary
+        - pvc
+        - databases
+        - tables
+        - indexes
+        - toastRelations
+        - riskHints
+        - cannotProve
+        - sources
+        - collectedAt
+      properties:
+        summary:
+          $ref: '#/components/schemas/postgresqlSpaceSummary'
+        pvc:
+          $ref: '#/components/schemas/postgresqlSpacePVC'
+        databases:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlDatabaseSpace'
+        tables:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlTableSpace'
+        indexes:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlIndexSpace'
+        toastRelations:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlToastRelationSpace'
+        riskHints:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlSpaceRiskHint'
+        cannotProve:
+          $ref: '#/components/schemas/postgresqlSpaceCannotProve'
+        sources:
+          type: array
+          items:
+            $ref: '#/components/schemas/postgresqlSpaceSource'
+        collectedAt:
+          type: string
+          description: Backend collection timestamp in UTC.
     postgresqlLockRow:
       type: object
       required:

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

@@ -650,10 +650,20 @@ models/phone-verification-request.ts
 models/platform-parameter-constraints.ts
 models/platform-parameter-list.ts
 models/platform-parameter.ts
+models/postgresql-database-space.ts
 models/postgresql-deadlock-evidence.ts
+models/postgresql-index-space.ts
 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-table-space.ts
+models/postgresql-toast-relation-space.ts
 models/postgresql-wait-graph-edge-evidence.ts
 models/postgresql-wait-graph-edge.ts
 models/postgresql-wait-graph-node.ts

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

@@ -27,6 +27,8 @@ import type { APIErrorResponse } from '../models';
 import type { PostgresqlLockAnalysis } from '../models';
 // @ts-ignore
 import type { PostgresqlSession } from '../models';
+// @ts-ignore
+import type { PostgresqlSpaceAnalysis } from '../models';
 /**
  * DiagnosticsApi - axios parameter creator
  * @export
@@ -122,6 +124,51 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 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.
+         * @summary Get PostgreSQL space analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSpaceAnalysis: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSpaceAnalysis', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSpaceAnalysis', 'clusterName', clusterName)
+            const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/spaceAnalysis`
+                .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)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -221,6 +268,20 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSessionLockAnalysis']?.[localVarOperationServerIndex]?.url;
             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.
+         * @summary Get PostgreSQL space analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDiagnosticsPostgresqlSpaceAnalysis(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSpaceAnalysis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSpaceAnalysis(orgName, clusterName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSpaceAnalysis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * List PostgreSQL session basic diagnostics records. The response includes waitEventType and waitEvent so clients can identify lock-waiting sessions without loading lock rows.
          * @summary List PostgreSQL session basic diagnostics
@@ -266,6 +327,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
         getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlLockAnalysis> {
             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.
+         * @summary Get PostgreSQL space analysis
+         * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSpaceAnalysis> {
+            return localVarFp.getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
+        },
         /**
          * List PostgreSQL session basic diagnostics records. The response includes waitEventType and waitEvent so clients can identify lock-waiting sessions without loading lock rows.
          * @summary List PostgreSQL session basic diagnostics
@@ -305,6 +376,16 @@ 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.
+     * @summary Get PostgreSQL space analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSpaceAnalysis>;
+
     /**
      * List PostgreSQL session basic diagnostics records. The response includes waitEventType and waitEvent so clients can identify lock-waiting sessions without loading lock rows.
      * @summary List PostgreSQL session basic diagnostics
@@ -373,6 +454,27 @@ export interface DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisReques
     readonly pid: number
 }
 
+/**
+ * Request parameters for getDiagnosticsPostgresqlSpaceAnalysis operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysis
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysis
+     */
+    readonly clusterName: string
+}
+
 /**
  * Request parameters for listDiagnosticsPostgresqlSessions operation in DiagnosticsApi.
  * @export
@@ -432,6 +534,18 @@ export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
         return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(this.axios, this.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.
+     * @summary Get PostgreSQL space analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    public getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig) {
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * List PostgreSQL session basic diagnostics records. The response includes waitEventType and waitEvent so clients can identify lock-waiting sessions without loading lock rows.
      * @summary List PostgreSQL session basic diagnostics

package/src/openapi/models/index.ts

@@ -563,10 +563,20 @@ export * from './phone-verification-request';
 export * from './platform-parameter';
 export * from './platform-parameter-constraints';
 export * from './platform-parameter-list';
+export * from './postgresql-database-space';
 export * from './postgresql-deadlock-evidence';
+export * from './postgresql-index-space';
 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-table-space';
+export * from './postgresql-toast-relation-space';
 export * from './postgresql-wait-graph';
 export * from './postgresql-wait-graph-edge';
 export * from './postgresql-wait-graph-edge-evidence';

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

@@ -0,0 +1,48 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlDatabaseSpace
+ */
+export interface PostgresqlDatabaseSpace {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlDatabaseSpace
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlDatabaseSpace
+     */
+    'sizeBytes'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlDatabaseSpace
+     */
+    'noHistoryYet': boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlDatabaseSpace
+     */
+    'cannotProveGrowth': boolean;
+}
+