kb-cloud-client-typescript 2.3.0-alpha.130 → 2.3.0-alpha.131

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

@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
 // @ts-ignore
 import type { APIErrorResponse } from '../models';
 // @ts-ignore
+import type { PerformanceTrends } from '../models';
+// @ts-ignore
 import type { PostgresqlLockAnalysis } from '../models';
 // @ts-ignore
 import type { PostgresqlSQLAnalysis } from '../models';
@@ -37,6 +39,61 @@ import type { PostgresqlSpaceAnalysis } from '../models';
  */
 export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * 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
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
+         * @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlPerformanceTrends: async (orgName: string, clusterName: string, range?: string, step?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlPerformanceTrends', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlPerformanceTrends', 'clusterName', clusterName)
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/performanceTrends`
+                .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 (range !== undefined) {
+                localVarQueryParameter['range'] = range;
+            }
+
+            if (step !== undefined) {
+                localVarQueryParameter['step'] = step;
+            }
+
+
+    
+            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 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
@@ -300,6 +357,22 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
 export const DiagnosticsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DiagnosticsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * 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
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
+         * @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDiagnosticsPostgresqlPerformanceTrends(orgName: string, clusterName: string, range?: string, step?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceTrends>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlPerformanceTrends(orgName, clusterName, range, step, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlPerformanceTrends']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 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
@@ -386,6 +459,16 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
 export const DiagnosticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = DiagnosticsApiFp(configuration)
     return {
+        /**
+         * 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
+         * @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PerformanceTrends> {
+            return localVarFp.getDiagnosticsPostgresqlPerformanceTrends(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.step, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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
@@ -445,6 +528,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
  * @interface DiagnosticsApi
  */
 export interface DiagnosticsApiInterface {
+    /**
+     * 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
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PerformanceTrends>;
+
     /**
      * 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
@@ -497,6 +590,41 @@ export interface DiagnosticsApiInterface {
 
 }
 
+/**
+ * Request parameters for getDiagnosticsPostgresqlPerformanceTrends operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
+     */
+    readonly clusterName: string
+
+    /**
+     * Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
+     */
+    readonly range?: string
+
+    /**
+     * Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
+     */
+    readonly step?: string
+}
+
 /**
  * Request parameters for getDiagnosticsPostgresqlSQLAnalysis operation in DiagnosticsApi.
  * @export
@@ -651,6 +779,18 @@ export interface DiagnosticsApiListDiagnosticsPostgresqlSessionsRequest {
  * @extends {BaseAPI}
  */
 export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
+    /**
+     * 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
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    public getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig) {
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlPerformanceTrends(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.step, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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

package/src/adminapi/models/cdc-settings.ts

@@ -39,17 +39,17 @@ export interface CdcSettings {
      */
     'config'?: CdcClusterConfig;
     /**
-     * 
-     * @type {CdcClusterAccount}
+     * engine mode and account setting mappings. \'_default\' key means default mode setting
+     * @type {{ [key: string]: CdcClusterAccount; }}
      * @memberof CdcSettings
      */
-    'account'?: CdcClusterAccount;
+    'account'?: { [key: string]: CdcClusterAccount; };
     /**
-     * 
-     * @type {CdcClusterEndpoint}
+     * engine mode and account setting mappings. \'_default\' key means default mode setting
+     * @type {{ [key: string]: CdcClusterEndpoint; }}
      * @memberof CdcSettings
      */
-    'endpoint'?: CdcClusterEndpoint;
+    'endpoint'?: { [key: string]: CdcClusterEndpoint; };
     /**
      * 
      * @type {CdcLifecycle}

package/src/adminapi/models/cdc-sql-executor.ts

@@ -38,5 +38,11 @@ export interface CdcSqlExecutor {
      * @memberof CdcSqlExecutor
      */
     'authDatabase'?: string | null;
+    /**
+     * A regular expression containing named groups, used to extract the named groups from the SQL result and match them to the names defined in result
+     * @type {string}
+     * @memberof CdcSqlExecutor
+     */
+    'nameGroupExpression'?: string | null;
 }
 

package/src/adminapi/models/engine-mapping.ts

@@ -25,6 +25,9 @@ import type { MappingDescription } from './mapping-description';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ReplicationMetadataObject } from './replication-metadata-object';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SelectModuleMode } from './select-module-mode';
 
 /**
  * 
@@ -50,6 +53,12 @@ export interface EngineMapping {
      * @memberof EngineMapping
      */
     'modules'?: Array<string>;
+    /**
+     * 
+     * @type {SelectModuleMode}
+     * @memberof EngineMapping
+     */
+    'moduleSelectMode'?: SelectModuleMode;
     /**
      * 
      * @type {Array<Array<EventObject>>}
@@ -82,3 +91,5 @@ export interface EngineMapping {
     'parameterTemplate'?: { [key: string]: Array<DataChannelParameter>; };
 }
 
+
+

package/src/adminapi/models/index.ts

@@ -608,6 +608,12 @@ export * from './parameters-value-value';
 export * from './partition';
 export * from './partition-info';
 export * from './password';
+export * from './performance-trend-point';
+export * from './performance-trend-range';
+export * from './performance-trend-series';
+export * from './performance-trend-source';
+export * from './performance-trend-summary';
+export * from './performance-trends';
 export * from './permission';
 export * from './permission-list';
 export * from './persistent-volume-claim';
@@ -743,6 +749,7 @@ export * from './slacluster';
 export * from './slasettings';
 export * from './scheduling-config';
 export * from './scheduling-policy-type';
+export * from './select-module-mode';
 export * from './selected-object-option';
 export * from './selected-object-option-convert-to-parameters-inner';
 export * from './selected-object-option-tree';

package/src/adminapi/models/performance-trend-point.ts

@@ -0,0 +1,36 @@
+/* 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 PerformanceTrendPoint
+ */
+export interface PerformanceTrendPoint {
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendPoint
+     */
+    'timestamp': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendPoint
+     */
+    'value': number;
+}
+

package/src/adminapi/models/performance-trend-range.ts

@@ -0,0 +1,48 @@
+/* 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 PerformanceTrendRange
+ */
+export interface PerformanceTrendRange {
+    /**
+     * Controlled query range label. Values are 1h, 6h, or 24h.
+     * @type {string}
+     * @memberof PerformanceTrendRange
+     */
+    'label': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendRange
+     */
+    'start': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendRange
+     */
+    'end': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendRange
+     */
+    'durationSeconds': number;
+}
+

package/src/adminapi/models/performance-trend-series.ts

@@ -0,0 +1,90 @@
+/* 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 { LocalizedDescription } from './localized-description';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PerformanceTrendPoint } from './performance-trend-point';
+
+/**
+ * 
+ * @export
+ * @interface PerformanceTrendSeries
+ */
+export interface PerformanceTrendSeries {
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSeries
+     */
+    'metric': string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof PerformanceTrendSeries
+     */
+    'displayName': LocalizedDescription;
+    /**
+     * Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+     * @type {string}
+     * @memberof PerformanceTrendSeries
+     */
+    'category': string;
+    /**
+     * Optional series dimension. Values include cluster, instance, pvc, and database.
+     * @type {string}
+     * @memberof PerformanceTrendSeries
+     */
+    'dimension'?: string;
+    /**
+     * Optional dimension labels, for example instance, pvc, role, or datname.
+     * @type {{ [key: string]: string; }}
+     * @memberof PerformanceTrendSeries
+     */
+    'labels'?: { [key: string]: string; };
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSeries
+     */
+    'unit': string;
+    /**
+     * Optional warning threshold in the same unit as this metric.
+     * @type {number}
+     * @memberof PerformanceTrendSeries
+     */
+    'warnThreshold'?: number;
+    /**
+     * Optional critical threshold in the same unit as this metric.
+     * @type {number}
+     * @memberof PerformanceTrendSeries
+     */
+    'critThreshold'?: number;
+    /**
+     * Optional threshold direction. Values are above, below, or boolean.
+     * @type {string}
+     * @memberof PerformanceTrendSeries
+     */
+    'thresholdDirection'?: string;
+    /**
+     * 
+     * @type {Array<PerformanceTrendPoint>}
+     * @memberof PerformanceTrendSeries
+     */
+    'points': Array<PerformanceTrendPoint>;
+}
+

package/src/adminapi/models/performance-trend-source.ts

@@ -0,0 +1,54 @@
+/* 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 PerformanceTrendSource
+ */
+export interface PerformanceTrendSource {
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSource
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSource
+     */
+    'kind': string;
+    /**
+     * Coarse source status. Values are success, partial, failed, skipped, or noData.
+     * @type {string}
+     * @memberof PerformanceTrendSource
+     */
+    'status': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSource
+     */
+    'collectedAt': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSource
+     */
+    'message'?: string;
+}
+

package/src/adminapi/models/performance-trend-summary.ts

@@ -0,0 +1,111 @@
+/* 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 { LocalizedDescription } from './localized-description';
+
+/**
+ * 
+ * @export
+ * @interface PerformanceTrendSummary
+ */
+export interface PerformanceTrendSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'metric': string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof PerformanceTrendSummary
+     */
+    'displayName': LocalizedDescription;
+    /**
+     * Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'category': string;
+    /**
+     * Optional series dimension. Values include cluster, instance, pvc, and database.
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'dimension'?: string;
+    /**
+     * Optional dimension labels, for example instance, pvc, role, or datname.
+     * @type {{ [key: string]: string; }}
+     * @memberof PerformanceTrendSummary
+     */
+    'labels'?: { [key: string]: string; };
+    /**
+     * 
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'unit': string;
+    /**
+     * Optional warning threshold in the same unit as this metric.
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'warnThreshold'?: number;
+    /**
+     * Optional critical threshold in the same unit as this metric.
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'critThreshold'?: number;
+    /**
+     * Optional threshold direction. Values are above, below, or boolean.
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'thresholdDirection'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'min': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'max': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'avg': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PerformanceTrendSummary
+     */
+    'latest': number;
+    /**
+     * Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
+     * @type {string}
+     * @memberof PerformanceTrendSummary
+     */
+    'changeDirection'?: string;
+}
+