kb-cloud-client-typescript 2.3.0-alpha.127 → 2.3.0-alpha.129

package/src/adminapi.yaml

@@ -19903,6 +19903,56 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sqlAnalysis:
+    get:
+      tags:
+        - diagnostics
+      summary: Get PostgreSQL SQL analysis
+      description: Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+      operationId: getDiagnosticsPostgresqlSQLAnalysis
+      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
+        - name: limit
+          in: query
+          description: Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
+          required: false
+          schema:
+            type: integer
+            format: int64
+        - name: orderBy
+          in: query
+          description: Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/postgresqlSQLAnalysis'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
     get:
       tags:
@@ -27022,14 +27072,18 @@ components:
     DmsSession:
       type: object
       required:
-        - id
         - user
         - host
       properties:
         id:
           type: integer
-          description: session ID
+          description: numeric session ID, when the database exposes one that fits in int64
           format: int64
+          nullable: true
+        sessionId:
+          type: string
+          description: native session ID used by the terminate API
+          nullable: true
         user:
           type: string
           description: user name
@@ -37319,6 +37373,102 @@ components:
         collectedAt:
           type: string
           description: Backend collection timestamp in UTC.
+    postgresqlSQLFingerprint:
+      type: object
+      required:
+        - queryID
+        - fingerprint
+        - querySummary
+        - calls
+        - totalTimeMs
+        - meanTimeMs
+        - maxTimeMs
+        - rows
+        - database
+        - user
+      properties:
+        queryID:
+          type: string
+          description: PostgreSQL pg_stat_statements queryid represented as a string.
+        fingerprint:
+          type: string
+          description: Stable SQL fingerprint identifier for UI grouping. M1 uses queryID.
+        querySummary:
+          type: string
+          description: Redacted SQL summary. Full raw SQL is intentionally not returned.
+        calls:
+          type: integer
+          format: int64
+          description: Number of executions accumulated by pg_stat_statements since statsReset.
+        totalTimeMs:
+          type: number
+          format: double
+          description: Total execution time in milliseconds accumulated by pg_stat_statements since statsReset.
+        meanTimeMs:
+          type: number
+          format: double
+          description: Mean execution time in milliseconds.
+        maxTimeMs:
+          type: number
+          format: double
+          description: Max execution time in milliseconds.
+        rows:
+          type: integer
+          format: int64
+          description: Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
+        database:
+          type: string
+          description: Database name resolved from pg_stat_statements.dbid when visible.
+        user:
+          type: string
+          description: Database user name resolved from pg_stat_statements.userid when visible.
+    postgresqlSQLAnalysis:
+      type: object
+      required:
+        - source
+        - status
+        - collectedAt
+        - limit
+        - orderBy
+        - items
+      properties:
+        source:
+          type: string
+          description: Data source. M1 uses pg_stat_statements only.
+        status:
+          type: string
+          description: Source status. Expected values are available or unavailable.
+        unavailableReason:
+          type: string
+          description: Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
+        statsReset:
+          type: string
+          description: UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
+        collectedAt:
+          type: string
+          description: Backend collection timestamp in UTC. It is not a sampling-window end time.
+        limit:
+          type: integer
+          format: int64
+          description: Effective row limit after backend normalization.
+        orderBy:
+          type: string
+          description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
+        totalTimeMsAll:
+          type: number
+          format: double
+          x-nullable: true
+          description: Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
+        callsAll:
+          type: integer
+          format: int64
+          x-nullable: true
+          description: Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
+        items:
+          type: array
+          description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
+          items:
+            $ref: '#/components/schemas/postgresqlSQLFingerprint'
     postgresqlLockRow:
       type: object
       required:

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

@@ -666,6 +666,8 @@ models/postgresql-session.ts
 models/postgresql-space-analysis.ts
 models/postgresql-space-source.ts
 models/postgresql-space-summary.ts
+models/postgresql-sqlanalysis.ts
+models/postgresql-sqlfingerprint.ts
 models/postgresql-storage-instance-usage.ts
 models/postgresql-storage-overview.ts
 models/postgresql-table-space.ts

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

@@ -26,6 +26,8 @@ import type { APIErrorResponse } from '../models';
 // @ts-ignore
 import type { PostgresqlLockAnalysis } from '../models';
 // @ts-ignore
+import type { PostgresqlSQLAnalysis } from '../models';
+// @ts-ignore
 import type { PostgresqlSession } from '../models';
 // @ts-ignore
 import type { PostgresqlSpaceAnalysis } from '../models';
@@ -35,6 +37,61 @@ import type { PostgresqlSpaceAnalysis } from '../models';
  */
 export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+         * @summary Get PostgreSQL SQL analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {number} [limit] Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
+         * @param {string} [orderBy] Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSQLAnalysis: async (orgName: string, clusterName: string, limit?: number, orderBy?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSQLAnalysis', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSQLAnalysis', 'clusterName', clusterName)
+            const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sqlAnalysis`
+                .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 (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get one PostgreSQL session basic diagnostics record by backend pid.
          * @summary Get PostgreSQL session basic diagnostics
@@ -243,6 +300,22 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
 export const DiagnosticsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DiagnosticsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+         * @summary Get PostgreSQL SQL analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {number} [limit] Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
+         * @param {string} [orderBy] Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDiagnosticsPostgresqlSQLAnalysis(orgName: string, clusterName: string, limit?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSQLAnalysis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSQLAnalysis(orgName, clusterName, limit, orderBy, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSQLAnalysis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get one PostgreSQL session basic diagnostics record by backend pid.
          * @summary Get PostgreSQL session basic diagnostics
@@ -313,6 +386,16 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
 export const DiagnosticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = DiagnosticsApiFp(configuration)
     return {
+        /**
+         * Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+         * @summary Get PostgreSQL SQL analysis
+         * @param {DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSQLAnalysis> {
+            return localVarFp.getDiagnosticsPostgresqlSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get one PostgreSQL session basic diagnostics record by backend pid.
          * @summary Get PostgreSQL session basic diagnostics
@@ -362,6 +445,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
  * @interface DiagnosticsApi
  */
 export interface DiagnosticsApiInterface {
+    /**
+     * Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+     * @summary Get PostgreSQL SQL analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsPostgresqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSQLAnalysis>;
+
     /**
      * Get one PostgreSQL session basic diagnostics record by backend pid.
      * @summary Get PostgreSQL session basic diagnostics
@@ -404,6 +497,41 @@ export interface DiagnosticsApiInterface {
 
 }
 
+/**
+ * Request parameters for getDiagnosticsPostgresqlSQLAnalysis operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysis
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysis
+     */
+    readonly clusterName: string
+
+    /**
+     * Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
+     * @type {number}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysis
+     */
+    readonly limit?: number
+
+    /**
+     * Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysis
+     */
+    readonly orderBy?: string
+}
+
 /**
  * Request parameters for getDiagnosticsPostgresqlSession operation in DiagnosticsApi.
  * @export
@@ -523,6 +651,18 @@ export interface DiagnosticsApiListDiagnosticsPostgresqlSessionsRequest {
  * @extends {BaseAPI}
  */
 export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
+    /**
+     * Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
+     * @summary Get PostgreSQL SQL analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    public getDiagnosticsPostgresqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSQLAnalysisRequest, options?: RawAxiosRequestConfig) {
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get one PostgreSQL session basic diagnostics record by backend pid.
      * @summary Get PostgreSQL session basic diagnostics

package/src/openapi/models/dms-session.ts

@@ -21,11 +21,17 @@
  */
 export interface DmsSession {
     /**
-     * session ID
+     * numeric session ID, when the database exposes one that fits in int64
      * @type {number}
      * @memberof DmsSession
      */
-    'id': number;
+    'id'?: number | null;
+    /**
+     * native session ID used by the terminate API
+     * @type {string}
+     * @memberof DmsSession
+     */
+    'sessionId'?: string | null;
     /**
      * user name
      * @type {string}

package/src/openapi/models/index.ts

@@ -575,6 +575,8 @@ export * from './postgresql-deadlock-evidence';
 export * from './postgresql-index-space';
 export * from './postgresql-lock-analysis';
 export * from './postgresql-lock-row';
+export * from './postgresql-sqlanalysis';
+export * from './postgresql-sqlfingerprint';
 export * from './postgresql-session';
 export * from './postgresql-space-analysis';
 export * from './postgresql-space-source';

package/src/openapi/models/postgresql-sqlanalysis.ts

@@ -0,0 +1,87 @@
+/* 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 { PostgresqlSQLFingerprint } from './postgresql-sqlfingerprint';
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlSQLAnalysis
+ */
+export interface PostgresqlSQLAnalysis {
+    /**
+     * Data source. M1 uses pg_stat_statements only.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'source': string;
+    /**
+     * Source status. Expected values are available or unavailable.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'status': string;
+    /**
+     * Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'unavailableReason'?: string;
+    /**
+     * UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'statsReset'?: string;
+    /**
+     * Backend collection timestamp in UTC. It is not a sampling-window end time.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'collectedAt': string;
+    /**
+     * Effective row limit after backend normalization.
+     * @type {number}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'limit': number;
+    /**
+     * Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
+     * @type {string}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'orderBy': string;
+    /**
+     * Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
+     * @type {number}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'totalTimeMsAll'?: number | null;
+    /**
+     * Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
+     * @type {number}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'callsAll'?: number | null;
+    /**
+     * SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
+     * @type {Array<PostgresqlSQLFingerprint>}
+     * @memberof PostgresqlSQLAnalysis
+     */
+    'items': Array<PostgresqlSQLFingerprint>;
+}
+

package/src/openapi/models/postgresql-sqlfingerprint.ts

@@ -0,0 +1,84 @@
+/* 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 PostgresqlSQLFingerprint
+ */
+export interface PostgresqlSQLFingerprint {
+    /**
+     * PostgreSQL pg_stat_statements queryid represented as a string.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'queryID': string;
+    /**
+     * Stable SQL fingerprint identifier for UI grouping. M1 uses queryID.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'fingerprint': string;
+    /**
+     * Redacted SQL summary. Full raw SQL is intentionally not returned.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'querySummary': string;
+    /**
+     * Number of executions accumulated by pg_stat_statements since statsReset.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'calls': number;
+    /**
+     * Total execution time in milliseconds accumulated by pg_stat_statements since statsReset.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'totalTimeMs': number;
+    /**
+     * Mean execution time in milliseconds.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'meanTimeMs': number;
+    /**
+     * Max execution time in milliseconds.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'maxTimeMs': number;
+    /**
+     * Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'rows': number;
+    /**
+     * Database name resolved from pg_stat_statements.dbid when visible.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'database': string;
+    /**
+     * Database user name resolved from pg_stat_statements.userid when visible.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'user': string;
+}
+