kb-cloud-client-typescript 2.3.31 → 2.3.33

package/src/adminapi/apis/vip-pool-api.ts

@@ -29,6 +29,8 @@ import type { VipPool } from '../models';
 import type { VipPoolCreate } from '../models';
 // @ts-ignore
 import type { VipPoolList } from '../models';
+// @ts-ignore
+import type { VipPoolUpdate } from '../models';
 /**
  * VipPoolApi - axios parameter creator
  * @export
@@ -163,6 +165,57 @@ export const VipPoolApiAxiosParamCreator = function (configuration?: Configurati
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Update environment VIP Pool
+         * @param {string} environmentName name of the environment
+         * @param {string} poolID id of the VIP Pool
+         * @param {VipPoolUpdate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateVIPPool: async (environmentName: string, poolID: string, body: VipPoolUpdate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('updateVIPPool', 'environmentName', environmentName)
+            // verify required parameter 'poolID' is not null or undefined
+            assertParamExists('updateVIPPool', 'poolID', poolID)
+            // verify required parameter 'body' is not null or undefined
+            assertParamExists('updateVIPPool', 'body', body)
+            const localVarPath = `/admin/v1/environments/{environmentName}/loadbalancer/vipPool/{poolID}`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)))
+                .replace(`{${"poolID"}}`, encodeURIComponent(String(poolID)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -219,6 +272,21 @@ export const VipPoolApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['VipPoolApi.listVIPPool']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Update environment VIP Pool
+         * @param {string} environmentName name of the environment
+         * @param {string} poolID id of the VIP Pool
+         * @param {VipPoolUpdate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateVIPPool(environmentName: string, poolID: string, body: VipPoolUpdate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VipPool>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateVIPPool(environmentName, poolID, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['VipPoolApi.updateVIPPool']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -259,6 +327,16 @@ export const VipPoolApiFactory = function (configuration?: Configuration, basePa
         listVIPPool(requestParameters: VipPoolApiListVIPPoolRequest, options?: RawAxiosRequestConfig): AxiosPromise<VipPoolList> {
             return localVarFp.listVIPPool(requestParameters.environmentName, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Update environment VIP Pool
+         * @param {VipPoolApiUpdateVIPPoolRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateVIPPool(requestParameters: VipPoolApiUpdateVIPPoolRequest, options?: RawAxiosRequestConfig): AxiosPromise<VipPool> {
+            return localVarFp.updateVIPPool(requestParameters.environmentName, requestParameters.poolID, requestParameters.body, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -298,6 +376,16 @@ export interface VipPoolApiInterface {
      */
     listVIPPool(requestParameters: VipPoolApiListVIPPoolRequest, options?: RawAxiosRequestConfig): AxiosPromise<VipPoolList>;
 
+    /**
+     * 
+     * @summary Update environment VIP Pool
+     * @param {VipPoolApiUpdateVIPPoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VipPoolApiInterface
+     */
+    updateVIPPool(requestParameters: VipPoolApiUpdateVIPPoolRequest, options?: RawAxiosRequestConfig): AxiosPromise<VipPool>;
+
 }
 
 /**
@@ -356,6 +444,34 @@ export interface VipPoolApiListVIPPoolRequest {
     readonly environmentName: string
 }
 
+/**
+ * Request parameters for updateVIPPool operation in VipPoolApi.
+ * @export
+ * @interface VipPoolApiUpdateVIPPoolRequest
+ */
+export interface VipPoolApiUpdateVIPPoolRequest {
+    /**
+     * name of the environment
+     * @type {string}
+     * @memberof VipPoolApiUpdateVIPPool
+     */
+    readonly environmentName: string
+
+    /**
+     * id of the VIP Pool
+     * @type {string}
+     * @memberof VipPoolApiUpdateVIPPool
+     */
+    readonly poolID: string
+
+    /**
+     * 
+     * @type {VipPoolUpdate}
+     * @memberof VipPoolApiUpdateVIPPool
+     */
+    readonly body: VipPoolUpdate
+}
+
 /**
  * VipPoolApi - object-oriented interface
  * @export
@@ -398,5 +514,17 @@ export class VipPoolApi extends BaseAPI implements VipPoolApiInterface {
     public listVIPPool(requestParameters: VipPoolApiListVIPPoolRequest, options?: RawAxiosRequestConfig) {
         return VipPoolApiFp(this.configuration).listVIPPool(requestParameters.environmentName, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 
+     * @summary Update environment VIP Pool
+     * @param {VipPoolApiUpdateVIPPoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VipPoolApi
+     */
+    public updateVIPPool(requestParameters: VipPoolApiUpdateVIPPoolRequest, options?: RawAxiosRequestConfig) {
+        return VipPoolApiFp(this.configuration).updateVIPPool(requestParameters.environmentName, requestParameters.poolID, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/src/adminapi/models/backup-option.ts

@@ -35,6 +35,12 @@ import type { SelectiveMethodOption } from './selective-method-option';
  * @interface BackupOption
  */
 export interface BackupOption {
+    /**
+     * Engine modes that support backup and restore. Omitted or null means all modes (legacy behavior); an empty array disables backup and restore for all modes. 
+     * @type {Array<string>}
+     * @memberof BackupOption
+     */
+    'modes'?: Array<string>;
     /**
      * 
      * @type {string}

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

@@ -191,6 +191,12 @@ export interface ClusterCreate {
      * @memberof ClusterCreate
      */
     'networkMode'?: NetworkMode;
+    /**
+     * Name of the VIP Pool (VIP Pool poolName) used as the MetalLB address pool for LoadBalancer services. Only effective when networkMode is LoadBalancer.
+     * @type {string}
+     * @memberof ClusterCreate
+     */
+    'vipPoolName'?: string;
     /**
      * 
      * @type {Array<ServiceRef>}

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

@@ -74,12 +74,6 @@ export interface ClusterJarPackage {
      * @memberof ClusterJarPackage
      */
     'published': boolean;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof ClusterJarPackage
-     */
-    'archived': boolean;
     /**
      * 
      * @type {string}

package/src/adminapi/models/component-item-create.ts

@@ -19,6 +19,9 @@ import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateCreate } from './instance-template-create';
 
 /**
  * ComponentItem is the information of a component
@@ -39,11 +42,17 @@ export interface ComponentItemCreate {
      */
     'compNum'?: number;
     /**
-     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3.
+     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
      * @type {number}
      * @memberof ComponentItemCreate
      */
     'replicas'?: number;
+    /**
+     * Per-template replicas and optional overlays (env, annotations, labels). Required when the chart renders instance templates. Names must exactly match all chart-rendered instances, without missing, extra, or duplicate names; order does not matter. Component replicas must equal the sum of all requested instance template replica counts.
+     * @type {Array<InstanceTemplateCreate>}
+     * @memberof ComponentItemCreate
+     */
+    'instanceTemplates'?: Array<InstanceTemplateCreate>;
     /**
      * Whether to skip resource constraint validation when creating cluster
      * @type {boolean}

package/src/adminapi/models/dms-pagination.ts

@@ -20,6 +20,42 @@
  * @interface DmsPagination
  */
 export interface DmsPagination {
+    /**
+     * Zero-based offset of this showData page.
+     * @type {number}
+     * @memberof DmsPagination
+     */
+    'offset'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsPagination
+     */
+    'limit'?: number | null;
+    /**
+     * Whether another showData page exists; determined by reading one extra row.
+     * @type {boolean}
+     * @memberof DmsPagination
+     */
+    'hasMore'?: boolean | null;
+    /**
+     * Present only when hasMore is true.
+     * @type {number}
+     * @memberof DmsPagination
+     */
+    'nextOffset'?: number | null;
+    /**
+     * Exact count returned only by countOnly requests (including zero).
+     * @type {number}
+     * @memberof DmsPagination
+     */
+    'totalRows'?: number | null;
+    /**
+     * Primary-key columns used for ordering; empty means ordering is not guaranteed. Pages are not a fixed snapshot.
+     * @type {Array<string>}
+     * @memberof DmsPagination
+     */
+    'orderColumns'?: Array<string>;
     /**
      * 
      * @type {number}

package/src/adminapi/models/index.ts

@@ -587,6 +587,13 @@ export * from './instance-resource-stats-list';
 export * from './instance-resource-stats-type';
 export * from './instance-status';
 export * from './instance-storage-item';
+export * from './instance-template-attribute';
+export * from './instance-template-create';
+export * from './instance-template-create-env-inner';
+export * from './instance-template-env';
+export * from './instance-template-op';
+export * from './instance-template-replicas';
+export * from './instance-template-volume-expand';
 export * from './integer-option';
 export * from './international-desc';
 export * from './io-quantity';
@@ -659,6 +666,7 @@ export * from './milvus-role-list';
 export * from './milvus-role-request';
 export * from './mode-compatible-kubeblocks-version';
 export * from './mode-component';
+export * from './mode-component-instance-template';
 export * from './mode-object-storage';
 export * from './mode-object-storage-additional-helm-value-path';
 export * from './mode-object-storage-service-ref';
@@ -766,7 +774,7 @@ export * from './ops-stop';
 export * from './ops-upgrade';
 export * from './ops-vscale';
 export * from './ops-volume-expand';
-export * from './ops-volume-expand-volumes-inner';
+export * from './ops-volume-expand-volumes-items0';
 export * from './org';
 export * from './org-create';
 export * from './org-member';
@@ -1024,6 +1032,7 @@ export * from './task';
 export * from './task-failure-policy';
 export * from './task-list';
 export * from './task-list-item';
+export * from './task-retry-mode';
 export * from './task-schedule';
 export * from './task-schedule-type';
 export * from './task-status';
@@ -1063,6 +1072,7 @@ export * from './user-update';
 export * from './vip-pool';
 export * from './vip-pool-create';
 export * from './vip-pool-list';
+export * from './vip-pool-update';
 export * from './volume-restore-policy';
 export * from './vuln-item';
 export * from './vuln-list';

package/src/adminapi/models/instance-template-attribute.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+
+
+/**
+ * Heterogeneous attribute the frontend may render on an instance template at create.
+ * @export
+ * @enum {string}
+ */
+
+export const InstanceTemplateAttribute = {
+    env: 'env',
+    annotations: 'annotations',
+    labels: 'labels',
+    availabilityZone: 'availabilityZone',
+    storageClass: 'storageClass'
+} as const;
+
+export type InstanceTemplateAttribute = typeof InstanceTemplateAttribute[keyof typeof InstanceTemplateAttribute];
+
+
+

package/src/adminapi/models/instance-template-create-env-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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface InstanceTemplateCreateEnvInner
+ */
+export interface InstanceTemplateCreateEnvInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'name': string;
+    /**
+     * Plain string value only. valueFrom is not supported.
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'value': string;
+}
+

package/src/adminapi/models/instance-template-create.ts

@@ -0,0 +1,69 @@
+/* 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 { InstanceTemplateCreateEnvInner } from './instance-template-create-env-inner';
+
+/**
+ * Create assignment for one instance template. name and replicas are required. env, annotations, labels, availabilityZone, and storageClass are optional overlays onto the chart-rendered instance. The request must include every chart-rendered instance template exactly once. A template with an explicit zone uses single-zone scheduling: hostname anti-affinity follows the scheduling policy, while explicit rules and additional topology keys are preserved. Component scheduling remains unchanged; templates without a zone inherit it, including its zone anti-affinity constraints. Chart instance scheduling policies are cleared; an omitted or empty availabilityZone leaves the instance policy unset to inherit the component policy. 
+ * @export
+ * @interface InstanceTemplateCreate
+ */
+export interface InstanceTemplateCreate {
+    /**
+     * Instance template name; must match a chart-rendered instance.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'name': string;
+    /**
+     * Replica count for this instance template.
+     * @type {number}
+     * @memberof InstanceTemplateCreate
+     */
+    'replicas': number;
+    /**
+     * Availability zone for this template (topology.kubernetes.io/zone); omitted or empty inherits the component zone selection. Must be enabled in the environment. If the request explicitly supplies a non-empty cluster availabilityZones list, the template zone must also belong to that list.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'availabilityZone'?: string;
+    /**
+     * StorageClass name for all persistent volumes in this template. Copied from component volumeClaimTemplates, preserving volume sizes and other settings while overriding storageClassName. Chart instance volume templates are cleared; omitted or empty leaves instance volumeClaimTemplates unset.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'storageClass'?: string;
+    /**
+     * Simple env vars (name and value only) merged into this template. valueFrom is not supported; overlaying a name clears any chart valueFrom.
+     * @type {Array<InstanceTemplateCreateEnvInner>}
+     * @memberof InstanceTemplateCreate
+     */
+    'env'?: Array<InstanceTemplateCreateEnvInner>;
+    /**
+     * Annotation map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'annotations'?: { [key: string]: string; };
+    /**
+     * Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'labels'?: { [key: string]: string; };
+}
+

package/src/adminapi/models/instance-template-env.ts

@@ -0,0 +1,57 @@
+/* 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';
+
+/**
+ * One fillable env var on an instance template, for frontend rendering.
+ * @export
+ * @interface InstanceTemplateEnv
+ */
+export interface InstanceTemplateEnv {
+    /**
+     * Env var name written to the instance template.
+     * @type {string}
+     * @memberof InstanceTemplateEnv
+     */
+    'name': string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InstanceTemplateEnv
+     */
+    'label'?: LocalizedDescription;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InstanceTemplateEnv
+     */
+    'description'?: LocalizedDescription;
+    /**
+     * If true, the frontend should treat this env as required. Create does not re-check.
+     * @type {boolean}
+     * @memberof InstanceTemplateEnv
+     */
+    'required'?: boolean;
+    /**
+     * Default value shown by the frontend.
+     * @type {string}
+     * @memberof InstanceTemplateEnv
+     */
+    'default'?: string;
+}
+

package/src/adminapi/models/instance-template-op.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.
+ */
+
+
+
+/**
+ * Operation that can be declared on instanceTemplate.ops.
+ * @export
+ * @enum {string}
+ */
+
+export const InstanceTemplateOp = {
+    hscale: 'hscale',
+    vscale: 'vscale',
+    storageExpansion: 'storageExpansion'
+} as const;
+
+export type InstanceTemplateOp = typeof InstanceTemplateOp[keyof typeof InstanceTemplateOp];
+
+
+

package/src/adminapi/models/instance-template-replicas.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.
+ */
+
+
+
+/**
+ * HScale assignment for one instance template. name and replicas only.
+ * @export
+ * @interface InstanceTemplateReplicas
+ */
+export interface InstanceTemplateReplicas {
+    /**
+     * Instance template name on the live Cluster spec.
+     * @type {string}
+     * @memberof InstanceTemplateReplicas
+     */
+    'name': string;
+    /**
+     * Target replica count for this instance template.
+     * @type {number}
+     * @memberof InstanceTemplateReplicas
+     */
+    'replicas': number;
+}
+

package/src/adminapi/models/instance-template-volume-expand.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 { OpsVolumeExpandVolumesItems0 } from './ops-volume-expand-volumes-items0';
+
+/**
+ * 
+ * @export
+ * @interface InstanceTemplateVolumeExpand
+ */
+export interface InstanceTemplateVolumeExpand {
+    /**
+     * Template name from the current mode component instanceTemplate.names.
+     * @type {string}
+     * @memberof InstanceTemplateVolumeExpand
+     */
+    'name': string;
+    /**
+     * 
+     * @type {Array<OpsVolumeExpandVolumesItems0>}
+     * @memberof InstanceTemplateVolumeExpand
+     */
+    'volumes': Array<OpsVolumeExpandVolumesItems0>;
+}
+