kb-cloud-client-typescript 2.3.0-alpha.194 → 2.3.0-alpha.196

package/src/adminapi.yaml

@@ -21195,6 +21195,56 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/sqlAnalysis:
+    get:
+      tags:
+        - diagnostics
+      summary: Get MySQL SQL analysis
+      description: Get a read-only MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+      operationId: getDiagnosticsMysqlSQLAnalysis
+      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/mysqlSQLAnalysis'
+        '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/performanceTrends:
     get:
       tags:
@@ -30537,6 +30587,9 @@ components:
         location:
           type: string
           description: Deployment location
+        operationTaskId:
+          type: string
+          description: ID of the asynchronous task associated with the module's current operation state. It is omitted when the current state is not associated with a task.
         clusterInfo:
           $ref: '#/components/schemas/clusterInfo'
           description: Cluster information
@@ -40036,6 +40089,165 @@ components:
           description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
           items:
             $ref: '#/components/schemas/postgresqlSQLFingerprint'
+    mysqlSQLFingerprint:
+      type: object
+      required:
+        - queryID
+        - fingerprint
+        - querySummary
+        - calls
+        - totalTimeMs
+        - meanTimeMs
+        - maxTimeMs
+        - rows
+        - rowsSent
+        - rowsAffected
+        - rowsExamined
+        - lockTimeMs
+        - errors
+        - warnings
+        - tmpTables
+        - tmpDiskTables
+        - noIndexUsed
+        - noGoodIndexUsed
+        - database
+      properties:
+        queryID:
+          type: string
+          description: MySQL Performance Schema DIGEST value.
+        fingerprint:
+          type: string
+          description: Stable SQL fingerprint identifier. M1 uses DIGEST.
+        querySummary:
+          type: string
+          description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
+        calls:
+          type: integer
+          format: int64
+          description: Number of executions accumulated in the current digest row.
+        totalTimeMs:
+          type: number
+          format: double
+          description: Total statement wait time in milliseconds.
+        meanTimeMs:
+          type: number
+          format: double
+          description: Mean statement wait time in milliseconds.
+        maxTimeMs:
+          type: number
+          format: double
+          description: Maximum statement wait time in milliseconds.
+        rows:
+          type: integer
+          format: int64
+          description: Sum of rows sent and rows affected.
+        rowsSent:
+          type: integer
+          format: int64
+          description: Total rows sent to clients.
+        rowsAffected:
+          type: integer
+          format: int64
+          description: Total rows affected by statements.
+        rowsExamined:
+          type: integer
+          format: int64
+          description: Total rows examined by statements.
+        lockTimeMs:
+          type: number
+          format: double
+          description: Total statement lock time in milliseconds.
+        errors:
+          type: integer
+          format: int64
+          description: Total statement errors.
+        warnings:
+          type: integer
+          format: int64
+          description: Total statement warnings.
+        tmpTables:
+          type: integer
+          format: int64
+          description: Total internal temporary tables created.
+        tmpDiskTables:
+          type: integer
+          format: int64
+          description: Total internal on-disk temporary tables created.
+        noIndexUsed:
+          type: integer
+          format: int64
+          description: Executions that used no index.
+        noGoodIndexUsed:
+          type: integer
+          format: int64
+          description: Executions for which no good index was found.
+        database:
+          type: string
+          description: Default schema name associated with the digest row.
+        firstSeen:
+          type: string
+          description: UTC timestamp when the digest was first observed.
+        lastSeen:
+          type: string
+          description: UTC timestamp when the digest was most recently observed.
+    mysqlSQLAnalysis:
+      type: object
+      required:
+        - source
+        - status
+        - collectedAt
+        - limit
+        - orderBy
+        - items
+      properties:
+        source:
+          type: string
+          description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
+        status:
+          type: string
+          description: Source status. Expected values are available or unavailable.
+        unavailableReason:
+          type: string
+          description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
+        message:
+          type: string
+          description: User-facing recovery guidance when SQL analysis is unavailable.
+        collectedAt:
+          type: string
+          description: Backend collection timestamp in UTC. It is not a sampling-window end time.
+        firstSeen:
+          type: string
+          description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
+        lastSeen:
+          type: string
+          description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
+        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 digest rows, not limited to the returned top-N items.
+        callsAll:
+          type: integer
+          format: int64
+          x-nullable: true
+          description: Total execution count across all visible digest rows, not limited to the returned top-N items.
+        digestLost:
+          type: integer
+          format: int64
+          x-nullable: true
+          description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
+        items:
+          type: array
+          description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
+          items:
+            $ref: '#/components/schemas/mysqlSQLFingerprint'
     performanceTrendRange:
       type: object
       required:

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

@@ -621,6 +621,8 @@ models/mongo-update-request.ts
 models/mongo-validation-info.ts
 models/mongo-write-response.ts
 models/mongo-write-result.ts
+models/mysql-sqlanalysis.ts
+models/mysql-sqlfingerprint.ts
 models/network-config.ts
 models/network-mode-option-inner.ts
 models/network-mode.ts

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

@@ -34,6 +34,8 @@ import type { DamengSessionListItem } from '../models';
 // @ts-ignore
 import type { DamengSpaceAnalysis } from '../models';
 // @ts-ignore
+import type { MysqlSQLAnalysis } from '../models';
+// @ts-ignore
 import type { PerformanceTrends } from '../models';
 // @ts-ignore
 import type { PostgresqlLockAnalysis } from '../models';
@@ -253,6 +255,61 @@ 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 MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+         * @summary Get MySQL 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}
+         */
+        getDiagnosticsMysqlSQLAnalysis: async (orgName: string, clusterName: string, limit?: number, orderBy?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsMysqlSQLAnalysis', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsMysqlSQLAnalysis', 'clusterName', clusterName)
+            const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/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};
@@ -698,6 +755,22 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsDamengSpaceAnalysis']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get a read-only MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+         * @summary Get MySQL 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 getDiagnosticsMysqlSQLAnalysis(orgName: string, clusterName: string, limit?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MysqlSQLAnalysis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsMysqlSQLAnalysis(orgName, clusterName, limit, orderBy, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsMysqlSQLAnalysis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
          * @summary Get PostgreSQL performance trends
@@ -856,6 +929,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
         getDiagnosticsDamengSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsDamengSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<DamengSpaceAnalysis> {
             return localVarFp.getDiagnosticsDamengSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.tableLimit, requestParameters.indexLimit, requestParameters.schema, requestParameters.skipBasic, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get a read-only MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+         * @summary Get MySQL SQL analysis
+         * @param {DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsMysqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<MysqlSQLAnalysis> {
+            return localVarFp.getDiagnosticsMysqlSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
          * @summary Get PostgreSQL performance trends
@@ -975,6 +1058,16 @@ export interface DiagnosticsApiInterface {
      */
     getDiagnosticsDamengSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsDamengSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<DamengSpaceAnalysis>;
 
+    /**
+     * Get a read-only MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+     * @summary Get MySQL SQL analysis
+     * @param {DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsMysqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<MysqlSQLAnalysis>;
+
     /**
      * Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
      * @summary Get PostgreSQL performance trends
@@ -1180,6 +1273,41 @@ export interface DiagnosticsApiGetDiagnosticsDamengSpaceAnalysisRequest {
     readonly skipBasic?: boolean
 }
 
+/**
+ * Request parameters for getDiagnosticsMysqlSQLAnalysis operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsMysqlSQLAnalysis
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsMysqlSQLAnalysis
+     */
+    readonly clusterName: string
+
+    /**
+     * Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
+     * @type {number}
+     * @memberof DiagnosticsApiGetDiagnosticsMysqlSQLAnalysis
+     */
+    readonly limit?: number
+
+    /**
+     * Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsMysqlSQLAnalysis
+     */
+    readonly orderBy?: string
+}
+
 /**
  * Request parameters for getDiagnosticsPostgresqlPerformanceTrends operation in DiagnosticsApi.
  * @export
@@ -1452,6 +1580,18 @@ export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
         return DiagnosticsApiFp(this.configuration).getDiagnosticsDamengSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.tableLimit, requestParameters.indexLimit, requestParameters.schema, requestParameters.skipBasic, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get a read-only MySQL SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
+     * @summary Get MySQL SQL analysis
+     * @param {DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    public getDiagnosticsMysqlSQLAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsMysqlSQLAnalysisRequest, options?: RawAxiosRequestConfig) {
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsMysqlSQLAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.limit, requestParameters.orderBy, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
      * @summary Get PostgreSQL performance trends

package/src/openapi/models/environment-module.ts

@@ -59,6 +59,12 @@ export interface EnvironmentModule {
      * @memberof EnvironmentModule
      */
     'location'?: string;
+    /**
+     * ID of the asynchronous task associated with the module\'s current operation state. It is omitted when the current state is not associated with a task.
+     * @type {string}
+     * @memberof EnvironmentModule
+     */
+    'operationTaskId'?: string;
     /**
      * 
      * @type {ClusterInfo}

package/src/openapi/models/index.ts

@@ -533,6 +533,8 @@ export * from './mongo-update-request';
 export * from './mongo-validation-info';
 export * from './mongo-write-response';
 export * from './mongo-write-result';
+export * from './mysql-sqlanalysis';
+export * from './mysql-sqlfingerprint';
 export * from './network-config';
 export * from './network-mode';
 export * from './network-mode-option-inner';

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

@@ -0,0 +1,105 @@
+/* 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 { MysqlSQLFingerprint } from './mysql-sqlfingerprint';
+
+/**
+ * 
+ * @export
+ * @interface MysqlSQLAnalysis
+ */
+export interface MysqlSQLAnalysis {
+    /**
+     * Data source. M1 uses performance_schema.events_statements_summary_by_digest.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'source': string;
+    /**
+     * Source status. Expected values are available or unavailable.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'status': string;
+    /**
+     * Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'unavailableReason'?: string;
+    /**
+     * User-facing recovery guidance when SQL analysis is unavailable.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'message'?: string;
+    /**
+     * Backend collection timestamp in UTC. It is not a sampling-window end time.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'collectedAt': string;
+    /**
+     * Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'firstSeen'?: string;
+    /**
+     * Latest LAST_SEEN timestamp across currently visible digest rows, when available.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'lastSeen'?: string;
+    /**
+     * Effective row limit after backend normalization.
+     * @type {number}
+     * @memberof MysqlSQLAnalysis
+     */
+    'limit': number;
+    /**
+     * Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
+     * @type {string}
+     * @memberof MysqlSQLAnalysis
+     */
+    'orderBy': string;
+    /**
+     * Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
+     * @type {number}
+     * @memberof MysqlSQLAnalysis
+     */
+    'totalTimeMsAll'?: number | null;
+    /**
+     * Total execution count across all visible digest rows, not limited to the returned top-N items.
+     * @type {number}
+     * @memberof MysqlSQLAnalysis
+     */
+    'callsAll'?: number | null;
+    /**
+     * Number of statement digests not recorded because the digest table was full, when exposed by the server.
+     * @type {number}
+     * @memberof MysqlSQLAnalysis
+     */
+    'digestLost'?: number | null;
+    /**
+     * SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
+     * @type {Array<MysqlSQLFingerprint>}
+     * @memberof MysqlSQLAnalysis
+     */
+    'items': Array<MysqlSQLFingerprint>;
+}
+