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

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

@@ -679,6 +679,8 @@ models/monitor-data-sink-create.ts
 models/monitor-data-sink-list.ts
 models/monitor-data-sink-update.ts
 models/monitor-data-sink.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/adminapi/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 = `/admin/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/adminapi/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/adminapi/models/index.ts

@@ -579,6 +579,8 @@ export * from './monitor-data-sink';
 export * from './monitor-data-sink-create';
 export * from './monitor-data-sink-list';
 export * from './monitor-data-sink-update';
+export * from './mysql-sqlanalysis';
+export * from './mysql-sqlfingerprint';
 export * from './network-config';
 export * from './network-mode';
 export * from './network-mode-option-inner';

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

@@ -0,0 +1,105 @@
+/* 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.
+ */
+
+
+// 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>;
+}
+

package/src/adminapi/models/mysql-sqlfingerprint.ts

@@ -0,0 +1,150 @@
+/* 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 MysqlSQLFingerprint
+ */
+export interface MysqlSQLFingerprint {
+    /**
+     * MySQL Performance Schema DIGEST value.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'queryID': string;
+    /**
+     * Stable SQL fingerprint identifier. M1 uses DIGEST.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'fingerprint': string;
+    /**
+     * Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'querySummary': string;
+    /**
+     * Number of executions accumulated in the current digest row.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'calls': number;
+    /**
+     * Total statement wait time in milliseconds.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'totalTimeMs': number;
+    /**
+     * Mean statement wait time in milliseconds.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'meanTimeMs': number;
+    /**
+     * Maximum statement wait time in milliseconds.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'maxTimeMs': number;
+    /**
+     * Sum of rows sent and rows affected.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'rows': number;
+    /**
+     * Total rows sent to clients.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'rowsSent': number;
+    /**
+     * Total rows affected by statements.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'rowsAffected': number;
+    /**
+     * Total rows examined by statements.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'rowsExamined': number;
+    /**
+     * Total statement lock time in milliseconds.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'lockTimeMs': number;
+    /**
+     * Total statement errors.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'errors': number;
+    /**
+     * Total statement warnings.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'warnings': number;
+    /**
+     * Total internal temporary tables created.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'tmpTables': number;
+    /**
+     * Total internal on-disk temporary tables created.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'tmpDiskTables': number;
+    /**
+     * Executions that used no index.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'noIndexUsed': number;
+    /**
+     * Executions for which no good index was found.
+     * @type {number}
+     * @memberof MysqlSQLFingerprint
+     */
+    'noGoodIndexUsed': number;
+    /**
+     * Default schema name associated with the digest row.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'database': string;
+    /**
+     * UTC timestamp when the digest was first observed.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'firstSeen'?: string;
+    /**
+     * UTC timestamp when the digest was most recently observed.
+     * @type {string}
+     * @memberof MysqlSQLFingerprint
+     */
+    'lastSeen'?: string;
+}
+