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

package/src/adminapi/models/inspection-task-item.ts

@@ -60,13 +60,13 @@ export interface InspectionTaskItem {
      */
     'scriptDescription'?: LocalizedDescription;
     /**
-     * 
+     * Category used to group inspection items, such as availability, performance, capacity, or backup.
      * @type {string}
      * @memberof InspectionTaskItem
      */
     'scriptCategory'?: string;
     /**
-     * 
+     * Type of the inspected resource, such as cluster or node; resourceID and resourceName identify the target.
      * @type {string}
      * @memberof InspectionTaskItem
      */
@@ -84,31 +84,31 @@ export interface InspectionTaskItem {
      */
     'resourceName'?: string;
     /**
-     * 
+     * Execution state, such as Running, Completed, or Failed. Use severity for the health conclusion. For manual items, Completed means instructions are available, not that the user has performed them.
      * @type {string}
      * @memberof InspectionTaskItem
      */
     'status'?: string;
     /**
-     * 
+     * Textual observation or execution message for display. It may contain nonnumeric information or an error; use severity for the health conclusion. Manual instructions are stored in evidence.ruleSnapshot.scriptExpr.
      * @type {string}
      * @memberof InspectionTaskItem
      */
     'result'?: string;
     /**
-     * Numeric form of result when the result is parseable.
+     * Numeric observation when available, including numeric information collected by info items. Omitted when no numeric observation exists, including manual guidance. Use with unit and thresholds for numeric displays.
      * @type {number}
      * @memberof InspectionTaskItem
      */
     'valueNum'?: number | null;
     /**
-     * 
+     * Warning threshold interpreted using direction and the same unit as valueNum. Omitted when no numeric warning threshold is configured.
      * @type {number}
      * @memberof InspectionTaskItem
      */
     'warnThreshold'?: number | null;
     /**
-     * 
+     * Critical threshold interpreted using direction and the same unit as valueNum. Omitted when no numeric critical threshold is configured.
      * @type {number}
      * @memberof InspectionTaskItem
      */
@@ -126,7 +126,7 @@ export interface InspectionTaskItem {
      */
     'criticality'?: InspectionCriticality;
     /**
-     * Structured evidence used to explain the item result. Prometheus/exporter no-data is reported here as no data or unknown instead of being converted into a healthy result.
+     * Structured evidence used to explain the item result. Unavailable or invalid evidence from any collection source, including Prometheus/exporters and DMS, is reported as unknown instead of being converted into a healthy or unhealthy conclusion.
      * @type {{ [key: string]: any; }}
      * @memberof InspectionTaskItem
      */
@@ -144,19 +144,19 @@ export interface InspectionTaskItem {
      */
     'remediation'?: LocalizedDescription;
     /**
-     * 
+     * Link to documentation explaining this inspection item and recommended actions.
      * @type {string}
      * @memberof InspectionTaskItem
      */
     'docLink'?: string;
     /**
-     * 
+     * Health conclusion: red (critical), yellow (warning), green (healthy), unknown (cannot evaluate), or info (automatically collected information). Manual guidance returns unknown and retains its criticality. Unknown and info do not contribute to health scoring; Completed for manual guidance means instructions are available, not user completion.
      * @type {string}
      * @memberof InspectionTaskItem
      */
     'severity'?: string;
     /**
-     * 
+     * Display unit for the inspection result and thresholds, such as percent, seconds, or bytes. Empty when no unit applies.
      * @type {string}
      * @memberof InspectionTaskItem
      */

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

@@ -102,13 +102,13 @@ export interface InspectionTask {
      */
     'expiredAt'?: string;
     /**
-     * 
+     * Weighted health score from 0 to 100 over evaluable inspection items only. Unknown results and items with info importance are excluded from both the numerator and denominator. The field is omitted when no item is evaluable; a present value of 0 is a valid evaluated score.
      * @type {number}
      * @memberof InspectionTask
      */
-    'score'?: number;
+    'score'?: number | null;
     /**
-     * Backend truth derived from the worst item state and criticality-aware score caps. A red item makes the task red; a critical red item caps score at 40.
+     * Task health conclusion derived from evaluable item states and criticality-aware score caps. Valid conclusions are red, yellow, green, and unknown. Unknown means no item is evaluable. Unknown items remain visible in the item list but do not override a red, yellow, or green conclusion derived from evaluable items.
      * @type {string}
      * @memberof InspectionTask
      */

package/src/adminapi/models/list-clickhouse-account-roles200-response-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 group of privileges granted on a scope.
+ * @export
+ * @interface ListClickhouseAccountRoles200ResponsePrivilegesInner
+ */
+export interface ListClickhouseAccountRoles200ResponsePrivilegesInner {
+    /**
+     * The ON-clause operand of the grant, e.g. \"db.*\" or \"*.*\".
+     * @type {string}
+     * @memberof ListClickhouseAccountRoles200ResponsePrivilegesInner
+     */
+    'scope'?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ListClickhouseAccountRoles200ResponsePrivilegesInner
+     */
+    'privileges'?: Array<string>;
+}
+

package/src/adminapi/models/list-clickhouse-account-roles200-response.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 { ListClickhouseAccountRoles200ResponsePrivilegesInner } from './list-clickhouse-account-roles200-response-privileges-inner';
+
+/**
+ * A ClickHouse role.
+ * @export
+ * @interface ListClickhouseAccountRoles200Response
+ */
+export interface ListClickhouseAccountRoles200Response {
+    /**
+     * The role name.
+     * @type {string}
+     * @memberof ListClickhouseAccountRoles200Response
+     */
+    'name'?: string;
+    /**
+     * Privileges granted to the role, grouped by scope.
+     * @type {Array<ListClickhouseAccountRoles200ResponsePrivilegesInner>}
+     * @memberof ListClickhouseAccountRoles200Response
+     */
+    'privileges'?: Array<ListClickhouseAccountRoles200ResponsePrivilegesInner>;
+}
+

package/src/adminapi/models/milvus-role-create-request.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 { MilvusRoleGrant } from './milvus-role-grant';
+
+/**
+ * Milvus role create request.
+ * @export
+ * @interface MilvusRoleCreateRequest
+ */
+export interface MilvusRoleCreateRequest {
+    /**
+     * Milvus role name.
+     * @type {string}
+     * @memberof MilvusRoleCreateRequest
+     */
+    'name': string;
+    /**
+     * Native Milvus privilege grants owned by this role.
+     * @type {Array<MilvusRoleGrant>}
+     * @memberof MilvusRoleCreateRequest
+     */
+    'grants'?: Array<MilvusRoleGrant>;
+}
+

package/src/adminapi/models/milvus-role-request.ts

@@ -18,7 +18,7 @@
 import type { MilvusRoleGrant } from './milvus-role-grant';
 
 /**
- * Milvus role upsert request.
+ * Milvus role update request.
  * @export
  * @interface MilvusRoleRequest
  */

package/src/adminapi/models/mode-object-storage-additional-helm-value-path.ts

@@ -38,6 +38,24 @@ export interface ModeObjectStorageAdditionalHelmValuePath {
      * @memberof ModeObjectStorageAdditionalHelmValuePath
      */
     'usePathStyle'?: string;
+    /**
+     * whether the object storage endpoint uses TLS. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsEnabled'?: string;
+    /**
+     * Secret name that stores the CA certificate for TLS object storage. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsCACertSecret'?: string;
+    /**
+     * Secret key that stores the CA certificate for TLS object storage. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsCACertSecretKey'?: string;
     /**
      * Region to use. If not set, it means the engine does not need this option. 
      * @type {string}

package/src/adminapi/models/mode-service-ref-helm-value-path.ts

@@ -74,5 +74,11 @@ export interface ModeServiceRefHelmValuePath {
      * @memberof ModeServiceRefHelmValuePath
      */
     'mode'?: string;
+    /**
+     * the helm value path prefix for the extraForManualInput fields of this serviceRef. ClusterCreate API will map each key of serviceRefs[].extraForManualInput to `<extraForManualInput>.<key>` in the cluster chart values. 
+     * @type {string}
+     * @memberof ModeServiceRefHelmValuePath
+     */
+    'extraForManualInput'?: string;
 }
 

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

@@ -74,6 +74,24 @@ export interface ModeServiceRef {
      * @memberof ModeServiceRef
      */
     'disableManualInput'?: boolean;
+    /**
+     * whether to disable auto creating the ServiceDescriptor object for this serviceRef. If set to false, the serviceDescriptor content (host/port/username/password) will be set directly into the helm values under the helmValuePath.serviceDescriptor path. If omitted, the generated ServiceDescriptor name will be set instead. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableAutoCreateServiceDescriptor'?: boolean | null;
+    /**
+     * whether to disable selecting a related cluster created in the platform for this serviceRef. If set to true, the frontend should only allow manual input instead of selecting from the clusters provided by the list clusters api. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableRelatedCluster'?: boolean;
+    /**
+     * Extra form field definitions for manual input of the serviceRef. The keys are the field names and the frontend renders them as input items. The user-entered values are passed in ClusterCreate serviceRefs[].extraForManualInput and mapped to helm values via helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: any; }}
+     * @memberof ModeServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: any; };
     /**
      * 
      * @type {ModeServiceRefHelmValuePath}
@@ -92,6 +110,12 @@ export interface ModeServiceRef {
      * @memberof ModeServiceRef
      */
     'serviceVersionCompatibility'?: Array<ModeServiceRefVersionCompatibility>;
+    /**
+     * whether the serviceRef can be updated. If set to false, the frontend should not allow users to update the serviceRef.
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'updatable'?: boolean;
 }
 
 

package/src/adminapi/models/ops-expose.ts

@@ -66,13 +66,13 @@ export interface OpsExpose {
      */
     'portsMapping'?: Array<OpsExposePortsMappingInner>;
     /**
-     * The IP address of the LoadBalancer service. If not set, the IP address will be assigned by the system. Only available when vpcServiceType is LoadBalancer.
+     * The requested IPv4 or IPv6 address of the LoadBalancer service. If not set, IP addresses will be assigned by the system. For dual-stack MetalLB services, the system allocates the missing address family from the same VIP pool. Only available when vpcServiceType is LoadBalancer.
      * @type {string}
      * @memberof OpsExpose
      */
     'loadBalancerIP'?: string | null;
     /**
-     * The IP pool ID of the LoadBalancer service. If not set, the IP pool will be assigned by the system. Only available when vpcServiceType is LoadBalancer.
+     * The IP pool ID of the LoadBalancer service. If not set, the IP pool will be assigned by the system. All VIPs of a dual-stack MetalLB service are allocated from the same pool. Only available when vpcServiceType is LoadBalancer.
      * @type {string}
      * @memberof OpsExpose
      */

package/src/adminapi/models/ops-request-name.ts

@@ -26,12 +26,6 @@ export interface OpsRequestName {
      * @memberof OpsRequestName
      */
     'opsRequestName'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OpsRequestName
-     */
-    'clusterTaskId'?: string;
     /**
      * 
      * @type {string}

package/src/adminapi/models/param-tpl-update.ts

@@ -32,6 +32,12 @@ export interface ParamTplUpdate {
      * @memberof ParamTplUpdate
      */
     'parameters'?: { [key: string]: string; };
+    /**
+     * Specify parameters list to be removed from the template
+     * @type {Array<string>}
+     * @memberof ParamTplUpdate
+     */
+    'parametersToRemove'?: Array<string>;
     /**
      * Specify the new name of the parameter template
      * @type {string}

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/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;
+}
+