kb-cloud-client-typescript 2.4.0-alpha.5 → 2.4.0-alpha.50

package/src/adminapi/models/postgresql-sqlfingerprint-explain-response.ts

@@ -0,0 +1,98 @@
+/* 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 { DmsExecutionPlanPlanningMode } from './dms-execution-plan-planning-mode';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DmsExecutionPlanResult } from './dms-execution-plan-result';
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlSQLFingerprintExplainResponse
+ */
+export interface PostgresqlSQLFingerprintExplainResponse {
+    /**
+     * PostgreSQL pg_stat_statements queryid represented as a string.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'queryID': string;
+    /**
+     * Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'fingerprint': string;
+    /**
+     * Database name from the requested SQL fingerprint identity.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'database': string;
+    /**
+     * Database user from the requested SQL fingerprint identity.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'user': string;
+    /**
+     * Top-level flag from the requested SQL fingerprint identity.
+     * @type {boolean}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'topLevel': boolean;
+    /**
+     * Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'statementSource'?: string;
+    /**
+     * Timestamp when the parameterized SQL statement was resolved.
+     * @type {string}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'statementResolvedAt'?: string;
+    /**
+     * 
+     * @type {DmsExecutionPlanPlanningMode}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'planMode': DmsExecutionPlanPlanningMode;
+    /**
+     * Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
+     * @type {boolean}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'parameterized': boolean;
+    /**
+     * Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
+     * @type {number}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'parameterCount'?: number | null;
+    /**
+     * 
+     * @type {DmsExecutionPlanResult}
+     * @memberof PostgresqlSQLFingerprintExplainResponse
+     */
+    'explainResult': DmsExecutionPlanResult;
+}
+
+
+

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

@@ -80,5 +80,11 @@ export interface PostgresqlSQLFingerprint {
      * @memberof PostgresqlSQLFingerprint
      */
     'user': string;
+    /**
+     * Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
+     * @type {boolean}
+     * @memberof PostgresqlSQLFingerprint
+     */
+    'topLevel': boolean;
 }
 

package/src/adminapi/models/provision-config.ts

@@ -27,6 +27,9 @@ import type { NodePoolNode } from './node-pool-node';
 import type { Register } from './register';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { StaticCluster } from './static-cluster';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { StorageConfig } from './storage-config';
 
 /**
@@ -59,6 +62,18 @@ export interface ProvisionConfig {
      * @memberof ProvisionConfig
      */
     'storage'?: StorageConfig;
+    /**
+     * 
+     * @type {StaticCluster}
+     * @memberof ProvisionConfig
+     */
+    'victoriaMetrics'?: StaticCluster;
+    /**
+     * 
+     * @type {StaticCluster}
+     * @memberof ProvisionConfig
+     */
+    'victoriaLogs'?: StaticCluster;
     /**
      * option modules of environment
      * @type {Array<EnvironmentModule>}

package/src/adminapi/models/rbmq-password-update-request.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.
+ */
+
+
+
+/**
+ * RabbitMQ account password update request.
+ * @export
+ * @interface RbmqPasswordUpdateRequest
+ */
+export interface RbmqPasswordUpdateRequest {
+    /**
+     * New RabbitMQ account password.
+     * @type {string}
+     * @memberof RbmqPasswordUpdateRequest
+     */
+    'password': string;
+}
+

package/src/adminapi/models/redis-info-response.ts

@@ -20,6 +20,12 @@
  * @interface RedisInfoResponse
  */
 export interface RedisInfoResponse {
+    /**
+     * INFO scope, either node or cluster.
+     * @type {string}
+     * @memberof RedisInfoResponse
+     */
+    'scope'?: string;
     /**
      * 
      * @type {string}

package/src/adminapi/models/redis-key-scan-progress.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.
+ */
+
+
+
+/**
+ * Redis key browser scan progress for the current page.
+ * @export
+ * @interface RedisKeyScanProgress
+ */
+export interface RedisKeyScanProgress {
+    /**
+     * Scan scope, either node or cluster.
+     * @type {string}
+     * @memberof RedisKeyScanProgress
+     */
+    'scope'?: string;
+    /**
+     * Total keys in the scan scope when available.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'total'?: number;
+    /**
+     * Number of key names returned by SCAN in this page before type filtering.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'scanned'?: number;
+    /**
+     * Number of key summaries loaded in this page after filtering and metadata lookup.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'loaded'?: number;
+    /**
+     * Whether the scan cursor is complete after this page.
+     * @type {boolean}
+     * @memberof RedisKeyScanProgress
+     */
+    'complete'?: boolean;
+}
+

package/src/adminapi/models/redis-key-summary-list.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisKeyScanProgress } from './redis-key-scan-progress';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { RedisKeySummary } from './redis-key-summary';
@@ -41,5 +44,11 @@ export interface RedisKeySummaryList {
      * @memberof RedisKeySummaryList
      */
     'hasMore'?: boolean;
+    /**
+     * 
+     * @type {RedisKeyScanProgress}
+     * @memberof RedisKeySummaryList
+     */
+    'progress'?: RedisKeyScanProgress;
 }
 

package/src/adminapi/models/redis-key-value-item.ts

@@ -27,11 +27,11 @@ export interface RedisKeyValueItem {
      */
     'field'?: string;
     /**
-     * Hash/list/set/json item value.
-     * @type {{ [key: string]: any; }}
+     * Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
+     * @type {any}
      * @memberof RedisKeyValueItem
      */
-    'value'?: { [key: string]: any; };
+    'value'?: any;
     /**
      * Set or sorted-set member.
      * @type {string}

package/src/adminapi/models/replication-check-option.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 ReplicationCheckOption
+ */
+export interface ReplicationCheckOption {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ReplicationCheckOption
+     */
+    'enabled'?: boolean;
+}
+

package/src/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.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.
+ */
+
+
+
+/**
+ * A single privilege granted on a scope.
+ * @export
+ * @interface RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+ */
+export interface RevokeClickhouseRolePrivilegesRequestPrivilegesInner {
+    /**
+     * The ON-clause operand of the grant, e.g. \"db.*\" or \"*.*\".
+     * @type {string}
+     * @memberof RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+     */
+    'scope'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+     */
+    'privilege'?: string;
+}
+

package/src/adminapi/models/revoke-clickhouse-role-privileges-request.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 { RevokeClickhouseRolePrivilegesRequestPrivilegesInner } from './revoke-clickhouse-role-privileges-request-privileges-inner';
+
+/**
+ * Revoke privileges from a role request.
+ * @export
+ * @interface RevokeClickhouseRolePrivilegesRequest
+ */
+export interface RevokeClickhouseRolePrivilegesRequest {
+    /**
+     * 
+     * @type {Array<RevokeClickhouseRolePrivilegesRequestPrivilegesInner>}
+     * @memberof RevokeClickhouseRolePrivilegesRequest
+     */
+    'privileges': Array<RevokeClickhouseRolePrivilegesRequestPrivilegesInner>;
+}
+

package/src/adminapi/models/scheduling-config.ts

@@ -38,6 +38,12 @@ export interface SchedulingConfig {
      * @memberof SchedulingConfig
      */
     'clusterSchedulingPolicy'?: ClusterSchedulingPolicy;
+    /**
+     * Additional Kubernetes topology label keys used by pod anti-affinity and topology spread for subsequently created or re-rendered clusters; existing Pods are not migrated automatically. Omit or use null during environment creation to store an empty list. Values must be valid Kubernetes qualified label keys. Infrastructure integrations or administrators must label all eligible nodes consistently; missing labels can cause unintended scheduling behavior and undermine failure-domain isolation. Too few eligible topology domains can leave Pods Pending under hard anti-affinity. If the Kubernetes LimitPodHardAntiAffinityTopology admission plugin is enabled, Pod creation is rejected for required anti-affinity using topology keys other than kubernetes.io/hostname, which can prevent the database cluster from becoming ready.
+     * @type {Array<string>}
+     * @memberof SchedulingConfig
+     */
+    'additionalTopologyKeys'?: Array<string> | null;
     /**
      * 
      * @type {TolerateDefaultTaints}

package/src/adminapi/models/service-ref.ts

@@ -47,5 +47,11 @@ export interface ServiceRef {
      * @memberof ServiceRef
      */
     'serviceDescriptor'?: ServiceDescriptor;
+    /**
+     * extra fields for manual input of the serviceRef. The keys must be defined in the engineoption modeServiceRef.extraForManualInput. They are mapped to helm values via the corresponding helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: string; }}
+     * @memberof ServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: string; };
 }
 

package/src/adminapi/models/update-clickhouse-account-password-request.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.
+ */
+
+
+
+/**
+ * Update a ClickHouse account password request.
+ * @export
+ * @interface UpdateClickhouseAccountPasswordRequest
+ */
+export interface UpdateClickhouseAccountPasswordRequest {
+    /**
+     * The new account password.
+     * @type {string}
+     * @memberof UpdateClickhouseAccountPasswordRequest
+     */
+    'password': string;
+}
+

package/src/adminapi/models/update-clickhouse-account-roles-request.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.
+ */
+
+
+
+/**
+ * Update the roles granted to a ClickHouse account request.
+ * @export
+ * @interface UpdateClickhouseAccountRolesRequest
+ */
+export interface UpdateClickhouseAccountRolesRequest {
+    /**
+     * The full set of roles to grant to the account. Existing roles are replaced.
+     * @type {Array<string>}
+     * @memberof UpdateClickhouseAccountRolesRequest
+     */
+    'roles': Array<string>;
+}
+

package/src/adminapi/models/vip-pool.ts

@@ -51,7 +51,7 @@ export interface VipPool {
      */
     'usedIPs'?: Array<string>;
     /**
-     * Used IP addresses
+     * Available IP address candidates, limited to 4096 per pool. IPv4 and IPv6 share the limit equally, with unused slots reassigned to the other family. Large pools return a partial list.
      * @type {Array<string>}
      * @memberof VipPool
      */