kb-cloud-client-typescript 2.4.0-alpha.2 → 2.4.0-alpha.21

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.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/dms-ob-parameter.ts

@@ -46,10 +46,10 @@ export interface DmsObParameter {
     'description': string;
     /**
      * The value options of the parameter
-     * @type {Array<any>}
+     * @type {Array<{ [key: string]: any; }>}
      * @memberof DmsObParameter
      */
-    'enum'?: Array<any>;
+    'enum'?: Array<{ [key: string]: any; }>;
     /**
      * The maximum value of the parameter
      * @type {string}

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/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

@@ -148,6 +148,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 +178,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 +227,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';
@@ -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';
@@ -540,6 +545,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 +573,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 +791,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';
@@ -836,6 +845,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 +864,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';
@@ -909,6 +921,7 @@ export * from './storage-provisioner';
 export * from './storage-provisioner-list';
 export * from './storage-stats';
 export * from './storage-update';
+export * from './system-component-scheduler-policy';
 export * from './table-space-status';
 export * from './tag';
 export * from './tag-create';
@@ -948,6 +961,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-task-item.ts

@@ -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
      */

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 items 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-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}

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>}