kb-cloud-client-typescript 2.3.0-beta.0 → 2.3.0-beta.10

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-list-item.ts

@@ -16,6 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ClusterType } from './cluster-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Endpoint } from './endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Tag } from './tag';
 
 /**
  * KubeBlocks cluster information
@@ -179,6 +185,24 @@ export interface ClusterListItem {
      * @memberof ClusterListItem
      */
     'orgName'?: string;
+    /**
+     * Name of project, it is the alias of environment namespace
+     * @type {string}
+     * @memberof ClusterListItem
+     */
+    'project'?: string;
+    /**
+     * Tags bound to the cluster
+     * @type {Array<Tag>}
+     * @memberof ClusterListItem
+     */
+    'tags'?: Array<Tag>;
+    /**
+     * Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+     * @type {Array<Endpoint>}
+     * @memberof ClusterListItem
+     */
+    'endpoints'?: Array<Endpoint>;
 }
 
 

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/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/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';
@@ -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';
@@ -457,6 +460,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,11 +544,16 @@ 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';
 export * from './load-balancer';
+export * from './load-balancer-annotations';
 export * from './load-balancer-available-type';
+export * from './load-balancer-config';
+export * from './load-balancer-config-update';
 export * from './load-balancer-ipam-status';
 export * from './load-balancer-status';
 export * from './localized-description';
@@ -833,6 +842,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';
@@ -851,6 +861,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';
@@ -906,6 +918,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';
@@ -945,6 +958,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/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/load-balancer-annotations.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.
+ */
+
+
+
+/**
+ * Provider-neutral annotations applied to load balancer Services by exposure type.
+ * @export
+ * @interface LoadBalancerAnnotations
+ */
+export interface LoadBalancerAnnotations {
+    /**
+     * Annotations used for load balancers exposed inside the VPC.
+     * @type {{ [key: string]: string; }}
+     * @memberof LoadBalancerAnnotations
+     */
+    'vpc': { [key: string]: string; };
+    /**
+     * Annotations used for load balancers exposed to the Internet.
+     * @type {{ [key: string]: string; }}
+     * @memberof LoadBalancerAnnotations
+     */
+    'internet': { [key: string]: string; };
+}
+

package/src/adminapi/models/load-balancer-config-update.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 { LoadBalancerAnnotations } from './load-balancer-annotations';
+
+/**
+ * Complete editable load balancer annotations for an environment.
+ * @export
+ * @interface LoadBalancerConfigUpdate
+ */
+export interface LoadBalancerConfigUpdate {
+    /**
+     * 
+     * @type {LoadBalancerAnnotations}
+     * @memberof LoadBalancerConfigUpdate
+     */
+    'annotations': LoadBalancerAnnotations;
+}
+

package/src/adminapi/models/load-balancer-config.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 { LoadBalancerAnnotations } from './load-balancer-annotations';
+
+/**
+ * Effective load balancer annotations for an environment.
+ * @export
+ * @interface LoadBalancerConfig
+ */
+export interface LoadBalancerConfig {
+    /**
+     * Current environment provider returned by the server.
+     * @type {string}
+     * @memberof LoadBalancerConfig
+     */
+    'provider': string;
+    /**
+     * 
+     * @type {LoadBalancerAnnotations}
+     * @memberof LoadBalancerConfig
+     */
+    'annotations': LoadBalancerAnnotations;
+}
+

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