kb-cloud-client-typescript 2.2.28 → 2.3.0-alpha.100

package/src/adminapi/models/cluster-slow-log-explain-response.ts

@@ -0,0 +1,84 @@
+/* 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 { ClusterExecutionLogItem } from './cluster-execution-log-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsQueryResponse } from './dms-query-response';
+
+/**
+ * Explain response for a selected slow log template sample
+ * @export
+ * @interface ClusterSlowLogExplainResponse
+ */
+export interface ClusterSlowLogExplainResponse {
+    /**
+     * Query template identifier
+     * @type {string}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'templateId'?: string;
+    /**
+     * Concrete sample SQL used for EXPLAIN
+     * @type {string}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'sql'?: string;
+    /**
+     * Statement type accepted by the backend safety check
+     * @type {string}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'sqlType'?: string;
+    /**
+     * Database selected from the slow log sample
+     * @type {string}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'database'?: string;
+    /**
+     * Normalized SQL template from oteld
+     * @type {string}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'normalizedQuery'?: string;
+    /**
+     * Timestamp of the selected sample in epoch nanoseconds
+     * @type {number}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'sampleTimestamp'?: number;
+    /**
+     * Execution time of the selected sample in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'executionTime'?: number;
+    /**
+     * 
+     * @type {ClusterExecutionLogItem}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'sample'?: ClusterExecutionLogItem;
+    /**
+     * 
+     * @type {DmsQueryResponse}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'explainResult'?: DmsQueryResponse;
+}
+

package/src/adminapi/models/cluster-slow-log-stats.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClusterSlowLogDatabaseDistribution } from './cluster-slow-log-database-distribution';
 
 /**
  * Summary statistics for slow logs
@@ -44,5 +47,11 @@ export interface ClusterSlowLogStats {
      * @memberof ClusterSlowLogStats
      */
     'activeDBs'?: number | null;
+    /**
+     * Slow log count distribution grouped by database. Null means the engine does not expose a stable database field.
+     * @type {Array<ClusterSlowLogDatabaseDistribution>}
+     * @memberof ClusterSlowLogStats
+     */
+    'databaseDistribution'?: Array<ClusterSlowLogDatabaseDistribution> | null;
 }
 

package/src/adminapi/models/cluster-slow-log-template-list.ts

@@ -0,0 +1,33 @@
+/* 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 { ClusterSlowLogTemplate } from './cluster-slow-log-template';
+
+/**
+ * Query template list for slow logs
+ * @export
+ * @interface ClusterSlowLogTemplateList
+ */
+export interface ClusterSlowLogTemplateList {
+    /**
+     * 
+     * @type {Array<ClusterSlowLogTemplate>}
+     * @memberof ClusterSlowLogTemplateList
+     */
+    'items'?: Array<ClusterSlowLogTemplate>;
+}
+

package/src/adminapi/models/cluster-slow-log-template.ts

@@ -0,0 +1,138 @@
+/* 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.
+ */
+
+
+
+/**
+ * Aggregated slow log query template
+ * @export
+ * @interface ClusterSlowLogTemplate
+ */
+export interface ClusterSlowLogTemplate {
+    /**
+     * Query template identifier
+     * @type {string}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'templateId'?: string;
+    /**
+     * Normalized SQL or command template
+     * @type {string}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'normalizedQuery'?: string;
+    /**
+     * Representative SQL sample for the template
+     * @type {string}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'sampleSQL'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'totalCount'?: number;
+    /**
+     * Total execution time in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'totalExecutionTime'?: number;
+    /**
+     * Average execution time in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'avgExecutionTime'?: number;
+    /**
+     * Maximum execution time in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'maxExecutionTime'?: number;
+    /**
+     * P95 execution time in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'p95ExecutionTime'?: number;
+    /**
+     * Number of unique database names in the time range
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'dbCount'?: number;
+    /**
+     * Number of unique users in the time range
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'userCount'?: number;
+    /**
+     * Number of unique client IPs in the time range
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'clientIPCount'?: number;
+    /**
+     * Number of unique application names in the time range
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'appCount'?: number;
+    /**
+     * Average rows examined by the template
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'avgRowsExamined'?: number | null;
+    /**
+     * Average rows returned or sent by the template
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'avgRowsSent'?: number | null;
+    /**
+     * Average lock wait time in seconds
+     * @type {number}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'avgLockTime'?: number | null;
+    /**
+     * Sampled database names for the template
+     * @type {Array<string>}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'dbNames'?: Array<string>;
+    /**
+     * Sampled users for the template
+     * @type {Array<string>}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'users'?: Array<string>;
+    /**
+     * Sampled client IPs for the template
+     * @type {Array<string>}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'clientIPs'?: Array<string>;
+    /**
+     * Sampled application names for the template
+     * @type {Array<string>}
+     * @memberof ClusterSlowLogTemplate
+     */
+    'apps'?: Array<string>;
+}
+

package/src/adminapi/models/database-option.ts

@@ -68,6 +68,12 @@ export interface DatabaseOption {
      * @memberof DatabaseOption
      */
     'listOption'?: Array<string>;
+    /**
+     * Database names that should be visible in database lists but protected from destructive operations. 
+     * @type {Array<string>}
+     * @memberof DatabaseOption
+     */
+    'protectedDatabases'?: Array<string>;
     /**
      * The database option cloud be set when creating databases 
      * @type {Array<string>}

package/src/adminapi/models/database-parameter-item.ts

@@ -122,6 +122,12 @@ export interface DatabaseParameterItem {
      * @memberof DatabaseParameterItem
      */
     'unit'?: string;
+    /**
+     * Whether the parameter can be recovered during backup restore
+     * @type {boolean}
+     * @memberof DatabaseParameterItem
+     */
+    'recoverable'?: boolean;
 }
 
 

package/src/adminapi/models/database-parameter-list-item.ts

@@ -110,6 +110,12 @@ export interface DatabaseParameterListItem {
      * @memberof DatabaseParameterListItem
      */
     'unit'?: string;
+    /**
+     * Whether the parameter can be recovered during backup restore
+     * @type {boolean}
+     * @memberof DatabaseParameterListItem
+     */
+    'recoverable'?: boolean;
 }
 
 

package/src/adminapi/models/dms-option.ts

@@ -44,11 +44,5 @@ export interface DmsOption {
      * @memberof DmsOption
      */
     'defaultAccount'?: string | null;
-    /**
-     * 
-     * @type {Array<object>}
-     * @memberof DmsOption
-     */
-    'tableMetadata'?: Array<object>;
 }
 

package/src/adminapi/models/dms-query-history.ts

@@ -21,25 +21,31 @@
  */
 export interface DmsQueryHistory {
     /**
-     * executed sql statements
+     * datasource engine
+     * @type {string}
+     * @memberof DmsQueryHistory
+     */
+    'engine'?: string | null;
+    /**
+     * user input text
      * @type {string}
      * @memberof DmsQueryHistory
      */
     'sql'?: string | null;
     /**
-     * sql executed massage
+     * execution message
      * @type {string}
      * @memberof DmsQueryHistory
      */
     'errMassage'?: string | null;
     /**
-     * sql executed time
+     * executed time
      * @type {string}
      * @memberof DmsQueryHistory
      */
     'createdAt'?: string;
     /**
-     * sql executed duration
+     * execution duration
      * @type {number}
      * @memberof DmsQueryHistory
      */

package/src/adminapi/models/engine-network-mode-options-inner.ts

@@ -0,0 +1,45 @@
+/* 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 { NetworkMode } from './network-mode';
+
+/**
+ * 
+ * @export
+ * @interface EngineNetworkModeOptionsInner
+ */
+export interface EngineNetworkModeOptionsInner {
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'mode': string;
+    /**
+     * available network modes for this engine+mode
+     * @type {Array<NetworkMode>}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'networkModes': Array<NetworkMode>;
+}
+

package/src/adminapi/models/engine-network-mode-supported.ts

@@ -0,0 +1,39 @@
+/* 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 { NetworkMode } from './network-mode';
+
+/**
+ * 
+ * @export
+ * @interface EngineNetworkModeSupported
+ */
+export interface EngineNetworkModeSupported {
+    /**
+     * supported network modes
+     * @type {Array<NetworkMode>}
+     * @memberof EngineNetworkModeSupported
+     */
+    'supported'?: Array<NetworkMode>;
+    /**
+     * not supported versions, key is networkMode, value is array of versions
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof EngineNetworkModeSupported
+     */
+    'notSupportedVersions'?: { [key: string]: Array<string>; };
+}
+

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

@@ -82,6 +82,9 @@ import type { NetworkModeOptionInner } from './network-mode-option-inner';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ParameterOption } from './parameter-option';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TdeOption } from './tde-option';
 
 /**
  * 
@@ -311,6 +314,12 @@ export interface EngineOption {
      * @memberof EngineOption
      */
     'tls'?: EngineTlsOption;
+    /**
+     * Transparent data encryption configuration.
+     * @type {Array<TdeOption>}
+     * @memberof EngineOption
+     */
+    'tde'?: Array<TdeOption>;
 }
 
 

package/src/adminapi/models/environment-engine-option-create.ts

@@ -0,0 +1,42 @@
+/* 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 EnvironmentEngineOptionCreate
+ */
+export interface EnvironmentEngineOptionCreate {
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'mode': string;
+    /**
+     * network modes
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'networkModes': Array<string>;
+}
+

package/src/adminapi/models/environment-engine-option-update.ts

@@ -0,0 +1,30 @@
+/* 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 EnvironmentEngineOptionUpdate
+ */
+export interface EnvironmentEngineOptionUpdate {
+    /**
+     * environment engine option to update
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOptionUpdate
+     */
+    'networkModes': Array<string>;
+}
+

package/src/adminapi/models/environment-engine-option.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface EnvironmentEngineOption
+ */
+export interface EnvironmentEngineOption {
+    /**
+     * record id
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'id': string;
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'mode': string;
+    /**
+     * network modes configured for this engine+mode+env combination
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOption
+     */
+    'networkModes': Array<string>;
+    /**
+     * environment id
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'envId': string;
+    /**
+     * environment name
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'envName': string;
+    /**
+     * create time
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'createTime'?: string;
+    /**
+     * update time
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'updateTime'?: string;
+}
+