kb-cloud-client-typescript 2.4.0-alpha.4 → 2.4.0-alpha.40

package/src/adminapi/models/aggregate-task-result-summary.ts

@@ -38,5 +38,11 @@ export interface AggregateTaskResultSummary {
      * @memberof AggregateTaskResultSummary
      */
     'normal'?: number;
+    /**
+     * Number of completed tasks with no evaluable inspection item. Tasks that contain both evaluable and unknown items retain the conclusion derived from their evaluable items.
+     * @type {number}
+     * @memberof AggregateTaskResultSummary
+     */
+    'unknown'?: number;
 }
 

package/src/adminapi/models/aggregate-task-result-type.ts

@@ -23,7 +23,8 @@
 export const AggregateTaskResultType = {
     green: 'green',
     yellow: 'yellow',
-    red: 'red'
+    red: 'red',
+    unknown: 'unknown'
 } as const;
 
 export type AggregateTaskResultType = typeof AggregateTaskResultType[keyof typeof AggregateTaskResultType];

package/src/adminapi/models/ck-account-type.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+
+/**
+ * The account role type.
+ * @export
+ * @enum {string}
+ */
+
+export const CkAccountType = {
+    SUPERUSER: 'SUPERUSER',
+    BASICUSER: 'BASICUSER',
+    ROOT: 'ROOT'
+} as const;
+
+export type CkAccountType = typeof CkAccountType[keyof typeof CkAccountType];
+
+
+

package/src/adminapi/models/ck-account.ts

@@ -0,0 +1,59 @@
+/* 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 { CkAccountType } from './ck-account-type';
+
+/**
+ * A ClickHouse account.
+ * @export
+ * @interface CkAccount
+ */
+export interface CkAccount {
+    /**
+     * The account (user) name.
+     * @type {string}
+     * @memberof CkAccount
+     */
+    'name'?: string;
+    /**
+     * Host IPs the account is allowed to log in from.
+     * @type {Array<string>}
+     * @memberof CkAccount
+     */
+    'hostIp'?: Array<string>;
+    /**
+     * Host names the account is allowed to log in from.
+     * @type {Array<string>}
+     * @memberof CkAccount
+     */
+    'hostNames'?: Array<string>;
+    /**
+     * Roles granted to the account, separated by commas.
+     * @type {string}
+     * @memberof CkAccount
+     */
+    'roles'?: string;
+    /**
+     * 
+     * @type {CkAccountType}
+     * @memberof CkAccount
+     */
+    'type'?: CkAccountType;
+}
+
+
+

package/src/adminapi/models/cluster-metrics.ts

@@ -28,9 +28,9 @@ export interface ClusterMetrics {
     'value'?: Array<any> | null;
     /**
      * 
-     * @type {Array<Array<any> | null>}
+     * @type {Array<Array<{ [key: string]: any; }> | null>}
      * @memberof ClusterMetrics
      */
-    'values'?: Array<Array<any> | null>;
+    'values'?: Array<Array<{ [key: string]: any; }> | null>;
 }
 

package/src/adminapi/models/cluster-reference.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.
+ */
+
+
+
+/**
+ * Cluster reference information returned by cluster detail APIs.
+ * @export
+ * @interface ClusterReference
+ */
+export interface ClusterReference {
+    /**
+     * Name of the cluster that references this cluster.
+     * @type {string}
+     * @memberof ClusterReference
+     */
+    'cluster'?: string;
+    /**
+     * Cluster definition of the referencing cluster.
+     * @type {string}
+     * @memberof ClusterReference
+     */
+    'clusterDefinition'?: string;
+}
+

package/src/adminapi/models/cluster-update.ts

@@ -53,6 +53,12 @@ export interface ClusterUpdate {
      * @memberof ClusterUpdate
      */
     'newServiceRefs'?: Array<ServiceRef>;
+    /**
+     * ServiceRefs to update. Each serviceRef name must match an existing serviceRef of the cluster, and the corresponding engine option modeServiceRef.update.enable must be true. ServiceRefs that auto create their ServiceDescriptor and Secret get their corresponding K8s objects updated; serviceRefs with manual input must be handled by each engine individually and are rejected. 
+     * @type {Array<ServiceRef>}
+     * @memberof ClusterUpdate
+     */
+    'serviceRefsUpdate'?: Array<ServiceRef>;
 }
 
 

package/src/adminapi/models/cluster.ts

@@ -27,6 +27,9 @@ import type { ClusterMaintainceWindow } from './cluster-maintaince-window';
 import type { ClusterObjectStorageConfig } from './cluster-object-storage-config';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { ClusterReference } from './cluster-reference';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { ClusterTerminationPolicy } from './cluster-termination-policy';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -295,10 +298,10 @@ export interface Cluster {
     'serviceRefs'?: Array<ServiceRef>;
     /**
      * this list of objects (currently, object is a cluster) that uses this cluster as a serviceRef
-     * @type {Array<ServiceRef>}
+     * @type {Array<ClusterReference>}
      * @memberof Cluster
      */
-    'referencedBy'?: Array<ServiceRef>;
+    'referencedBy'?: Array<ClusterReference>;
     /**
      * 
      * @type {ClusterObjectStorageConfig}

package/src/adminapi/models/create-clickhouse-account-request.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.
+ */
+
+
+
+/**
+ * Create a ClickHouse account request.
+ * @export
+ * @interface CreateClickhouseAccountRequest
+ */
+export interface CreateClickhouseAccountRequest {
+    /**
+     * The account (user) name.
+     * @type {string}
+     * @memberof CreateClickhouseAccountRequest
+     */
+    'name': string;
+    /**
+     * The account password.
+     * @type {string}
+     * @memberof CreateClickhouseAccountRequest
+     */
+    'password': string;
+    /**
+     * Roles to grant to the account on creation.
+     * @type {Array<string>}
+     * @memberof CreateClickhouseAccountRequest
+     */
+    'roles'?: Array<string>;
+}
+

package/src/adminapi/models/disaster-recovery-task.ts

@@ -32,11 +32,5 @@ export interface DisasterRecoveryTask {
      * @memberof DisasterRecoveryTask
      */
     'taskId': string | null;
-    /**
-     * Cluster task ID
-     * @type {string}
-     * @memberof DisasterRecoveryTask
-     */
-    'clusterTaskId'?: string | null;
 }
 

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

@@ -24,6 +24,9 @@ import type { EventObject } from './event-object';
 import type { MappingDescription } from './mapping-description';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { ReplicationCheckOption } from './replication-check-option';
+// 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
@@ -83,6 +86,12 @@ export interface EngineMapping {
      * @memberof EngineMapping
      */
     'preCheckers'?: Array<string>;
+    /**
+     * 
+     * @type {ReplicationCheckOption}
+     * @memberof EngineMapping
+     */
+    'dataCheckOption'?: ReplicationCheckOption;
     /**
      * module parameter template, the key is the module name, the value is the parameter template
      * @type {{ [key: string]: Array<DataChannelParameter>; }}

package/src/adminapi/models/engine-option-license-file.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 { LocalizedDescription } from './localized-description';
+
+/**
+ * 
+ * @export
+ * @interface EngineOptionLicenseFile
+ */
+export interface EngineOptionLicenseFile {
+    /**
+     * Target license file name written into the engine license Secret.
+     * @type {string}
+     * @memberof EngineOptionLicenseFile
+     */
+    'name': string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof EngineOptionLicenseFile
+     */
+    'title'?: LocalizedDescription;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof EngineOptionLicenseFile
+     */
+    'description'?: LocalizedDescription;
+}
+

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

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EngineOptionLicenseFile } from './engine-option-license-file';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { LicenseOption } from './license-option';
@@ -40,7 +43,13 @@ export interface EngineOptionLicense {
      * @type {string}
      * @memberof EngineOptionLicense
      */
-    'fileName': string;
+    'fileName'?: string;
+    /**
+     * Explicit license file upload slots. Each item maps one UI upload field to the file name written into the license Secret.
+     * @type {Array<EngineOptionLicenseFile>}
+     * @memberof EngineOptionLicense
+     */
+    'files'?: Array<EngineOptionLicenseFile>;
     /**
      * set the custom ops to update license for different components
      * @type {Array<LicenseOption>}

package/src/adminapi/models/essecurity-role-mapping.ts

@@ -18,7 +18,7 @@
 import type { ESSecurityRoleTemplate } from './essecurity-role-template';
 
 /**
- * 
+ * Native Elasticsearch security role mapping. At least one of roles or role_templates must be non-empty.
  * @export
  * @interface ESSecurityRoleMapping
  */
@@ -28,7 +28,7 @@ export interface ESSecurityRoleMapping {
      * @type {boolean}
      * @memberof ESSecurityRoleMapping
      */
-    'enabled'?: boolean | null;
+    'enabled': boolean | null;
     /**
      * 
      * @type {Array<string>}
@@ -46,7 +46,7 @@ export interface ESSecurityRoleMapping {
      * @type {{ [key: string]: any; }}
      * @memberof ESSecurityRoleMapping
      */
-    'rules'?: { [key: string]: any; };
+    'rules': { [key: string]: any; };
     /**
      * 
      * @type {{ [key: string]: any; }}

package/src/adminapi/models/essecurity-role-template.ts

@@ -28,7 +28,7 @@ export interface ESSecurityRoleTemplate {
      * @type {{ [key: string]: any; }}
      * @memberof ESSecurityRoleTemplate
      */
-    'template'?: { [key: string]: any; };
+    'template': { [key: string]: any; };
     /**
      * 
      * @type {ESSecurityRoleTemplateFormat}

package/src/adminapi/models/get-clickhouse-role-grants200-response-inner.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.
+ */
+
+
+
+/**
+ * A single grant of a ClickHouse role.
+ * @export
+ * @interface GetClickhouseRoleGrants200ResponseInner
+ */
+export interface GetClickhouseRoleGrants200ResponseInner {
+    /**
+     * The access type of the grant.
+     * @type {string}
+     * @memberof GetClickhouseRoleGrants200ResponseInner
+     */
+    'accessType'?: string;
+    /**
+     * The database of the grant scope.
+     * @type {string}
+     * @memberof GetClickhouseRoleGrants200ResponseInner
+     */
+    'database'?: string;
+    /**
+     * The table of the grant scope.
+     * @type {string}
+     * @memberof GetClickhouseRoleGrants200ResponseInner
+     */
+    'table'?: string;
+    /**
+     * The full grant scope, e.g. \"db.*\".
+     * @type {string}
+     * @memberof GetClickhouseRoleGrants200ResponseInner
+     */
+    'scope'?: string;
+    /**
+     * Whether the grant is a partial revoke.
+     * @type {boolean}
+     * @memberof GetClickhouseRoleGrants200ResponseInner
+     */
+    'isPartialRevoke'?: boolean;
+}
+

package/src/adminapi/models/index.ts

@@ -85,7 +85,6 @@ export * from './auto-inspection';
 export * from './auto-inspection-resource-type';
 export * from './auto-inspection-run-unit';
 export * from './autohealing-config';
-export * from './autohealing-list-inner';
 export * from './available-cluster-list-inner';
 export * from './backup';
 export * from './backup-create';
@@ -148,6 +147,8 @@ export * from './cdc-worker-template';
 export * from './certificate';
 export * from './certificate-issuer';
 export * from './check-apikey';
+export * from './ck-account';
+export * from './ck-account-type';
 export * from './class';
 export * from './class-batch';
 export * from './class-type';
@@ -176,6 +177,7 @@ export * from './cluster-mode-transition';
 export * from './cluster-object-storage-config';
 export * from './cluster-raw-log-item';
 export * from './cluster-raw-log-response';
+export * from './cluster-reference';
 export * from './cluster-scheduling-policy';
 export * from './cluster-slow-log-database-distribution';
 export * from './cluster-slow-log-detail';
@@ -224,6 +226,7 @@ export * from './consumer-group';
 export * from './consumer-group-describe';
 export * from './container-info';
 export * from './create-class-type';
+export * from './create-clickhouse-account-request';
 export * from './create-ipwhitelist-request';
 export * from './create-pg-extension-resp';
 export * from './create-topic-request';
@@ -377,6 +380,7 @@ export * from './engine-option';
 export * from './engine-option-history';
 export * from './engine-option-history-list';
 export * from './engine-option-license';
+export * from './engine-option-license-file';
 export * from './engine-option-list';
 export * from './engine-option-status';
 export * from './engine-option-version';
@@ -457,6 +461,7 @@ export * from './feature-list';
 export * from './feature-pre-release-type';
 export * from './file-entry';
 export * from './file-entry-list';
+export * from './get-clickhouse-role-grants200-response-inner';
 export * from './get-upload-image-progress200-response';
 export * from './global-pricing';
 export * from './ha-history';
@@ -486,6 +491,7 @@ export * from './init-option-item';
 export * from './init-option-object';
 export * from './init-option-type';
 export * from './inspection-criticality';
+export * from './inspection-evaluation-mode';
 export * from './inspection-script';
 export * from './inspection-script-category';
 export * from './inspection-task';
@@ -540,6 +546,8 @@ export * from './kubeconfig';
 export * from './license';
 export * from './license-option';
 export * from './license-request';
+export * from './list-clickhouse-account-roles200-response';
+export * from './list-clickhouse-account-roles200-response-privileges-inner';
 export * from './list-kubernetes-node-op-type';
 export * from './llm';
 export * from './llm-list';
@@ -566,6 +574,7 @@ export * from './metrics-query-type';
 export * from './milvus-account-password';
 export * from './milvus-account-roles';
 export * from './milvus-role';
+export * from './milvus-role-create-request';
 export * from './milvus-role-grant';
 export * from './milvus-role-list';
 export * from './milvus-role-request';
@@ -783,6 +792,7 @@ export * from './rbmq-accounts-list';
 export * from './rbmq-accounts-list-items-inner';
 export * from './rbmq-exchange';
 export * from './rbmq-message-stats';
+export * from './rbmq-password-update-request';
 export * from './rbmq-permission';
 export * from './rbmq-topic-permission';
 export * from './rbmq-user';
@@ -815,6 +825,7 @@ export * from './redis-key-detail';
 export * from './redis-key-detail-request';
 export * from './redis-key-mutate-request';
 export * from './redis-key-mutate-response';
+export * from './redis-key-scan-progress';
 export * from './redis-key-summary';
 export * from './redis-key-summary-list';
 export * from './redis-key-value';
@@ -836,6 +847,7 @@ export * from './ref';
 export * from './ref-item';
 export * from './register';
 export * from './related-cluster-list-item';
+export * from './replication-check-option';
 export * from './replication-metadata-object';
 export * from './replication-object-node';
 export * from './replication-object-tree';
@@ -854,6 +866,8 @@ export * from './restore-org-alert-rule-to-default200-response';
 export * from './restore-status';
 export * from './restore-status-actions-inner';
 export * from './restore-status-conditions-inner';
+export * from './revoke-clickhouse-role-privileges-request';
+export * from './revoke-clickhouse-role-privileges-request-privileges-inner';
 export * from './role';
 export * from './role-create';
 export * from './role-list';
@@ -949,6 +963,8 @@ export * from './topic-offset';
 export * from './urlcheck';
 export * from './update-authenticated-user-password-request';
 export * from './update-broker-config-request';
+export * from './update-clickhouse-account-password-request';
+export * from './update-clickhouse-account-roles-request';
 export * from './update-topic-config-request';
 export * from './user';
 export * from './user-authorization';

package/src/adminapi/models/inspection-criticality.ts

@@ -15,7 +15,7 @@
 
 
 /**
- * First-version criticality assumption for score weighting and red-item veto behavior. Missing legacy values are treated as medium.
+ * Rule importance used for score weighting. Info marks automatically collected information excluded from scoring. Manual items retain their importance but return unknown and are not scored. Missing legacy values normally default to medium; cluster and node status default to critical.
  * @export
  * @enum {string}
  */
@@ -24,7 +24,8 @@ export const InspectionCriticality = {
     critical: 'critical',
     high: 'high',
     medium: 'medium',
-    low: 'low'
+    low: 'low',
+    info: 'info'
 } as const;
 
 export type InspectionCriticality = typeof InspectionCriticality[keyof typeof InspectionCriticality];

package/src/adminapi/models/inspection-evaluation-mode.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+
+/**
+ * Empty legacy values mean check. Display collects information without scoring. Manual requires type=manual and presents scriptExpr verbatim as instructions; it executes no SQL or templates, returns severity=unknown, and retains rule importance.
+ * @export
+ * @enum {string}
+ */
+
+export const InspectionEvaluationMode = {
+    check: 'check',
+    display: 'display',
+    manual: 'manual'
+} as const;
+
+export type InspectionEvaluationMode = typeof InspectionEvaluationMode[keyof typeof InspectionEvaluationMode];
+
+
+

package/src/adminapi/models/inspection-script.ts

@@ -18,6 +18,9 @@
 import type { InspectionCriticality } from './inspection-criticality';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { InspectionEvaluationMode } from './inspection-evaluation-mode';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { InspectionScriptCategory } from './inspection-script-category';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -57,7 +60,7 @@ export interface InspectionScript {
      */
     'engine': string;
     /**
-     * The type of the script, such as \"promQL\"
+     * The type of the script, such as \"promQL\" or \"manual\" (requires evaluationMode=manual)
      * @type {string}
      * @memberof InspectionScript
      */
@@ -75,11 +78,17 @@ export interface InspectionScript {
      */
     'description'?: LocalizedDescription;
     /**
-     * 
+     * Collector expression for automatic modes; complete user instructions (up to 8192 UTF-8 bytes) for manual mode. Manual placeholders are not rendered.
      * @type {string}
      * @memberof InspectionScript
      */
     'scriptExpr': string;
+    /**
+     * 
+     * @type {InspectionEvaluationMode}
+     * @memberof InspectionScript
+     */
+    'evaluationMode'?: InspectionEvaluationMode;
     /**
      * 
      * @type {string}