kb-cloud-client-typescript 2.3.31 → 2.3.33

package/src/adminapi/models/mode-component-instance-template.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 { InstanceTemplateAttribute } from './instance-template-attribute';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateEnv } from './instance-template-env';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateOp } from './instance-template-op';
+
+/**
+ * Template fields and operations shared by the frontend and backend. Declaring storageExpansion in ops requires explicit volume expansion targets for every name. Components without this capability use component-level expansion. 
+ * @export
+ * @interface ModeComponentInstanceTemplate
+ */
+export interface ModeComponentInstanceTemplate {
+    /**
+     * Instance template names the frontend should render. Create and hscale check names against the chart or live Cluster, not this list. Explicit volume expansion targets must include every name in this list. 
+     * @type {Set<string>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'names': Set<string>;
+    /**
+     * Template operations: hscale, storageExpansion, and reserved vscale. Explicit volume expansion targets must match component volume names and target capacities. 
+     * @type {Array<InstanceTemplateOp>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'ops': Array<InstanceTemplateOp>;
+    /**
+     * Heterogeneous attributes the frontend should render on each instance template at create. Omitted or empty means only name and replicas. Create overlays the request onto the chart and does not re-check this list. 
+     * @type {Set<InstanceTemplateAttribute>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'attributes'?: Set<InstanceTemplateAttribute>;
+    /**
+     * Env vars the frontend may render when attributes includes env. Create does not re-check this list. 
+     * @type {Array<InstanceTemplateEnv>}
+     * @memberof ModeComponentInstanceTemplate
+     */
+    'env'?: Array<InstanceTemplateEnv>;
+}
+

package/src/adminapi/models/mode-component.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ModeComponentInstanceTemplate } from './mode-component-instance-template';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ModeReadonlyEndpoint } from './mode-readonly-endpoint';
@@ -41,6 +44,12 @@ export interface ModeComponent {
      * @memberof ModeComponent
      */
     'hideOnCreate': boolean;
+    /**
+     * 
+     * @type {ModeComponentInstanceTemplate}
+     * @memberof ModeComponent
+     */
+    'instanceTemplate'?: ModeComponentInstanceTemplate;
     /**
      * the name of the serviceRef defined in mode\'s serviceRefs. If set, it means a serviceRef can be used to replace this component. 
      * @type {string}

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

@@ -13,12 +13,15 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateReplicas } from './instance-template-replicas';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { TaskSchedule } from './task-schedule';
 
 /**
- * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. It requires specifying either the number of replicas or the number of shards.
+ * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. instanceTemplates is an optional overlay and requires top-level replicas.
  * @export
  * @interface OpsHScale
  */
@@ -41,6 +44,12 @@ export interface OpsHScale {
      * @memberof OpsHScale
      */
     'replicas'?: number | null;
+    /**
+     * Target replica count for named instance templates. Requires top-level replicas. Mapped onto the live Cluster spec to build scaleIn/scaleOut.instances. Required for replica scaling when the live component has instance templates. Names must exactly match all live instance templates, without missing, extra, or duplicate names; order does not matter. Top-level replicas must equal the sum of all requested template replica counts. Shard-count scaling does not check templates and cannot include this list.
+     * @type {Array<InstanceTemplateReplicas>}
+     * @memberof OpsHScale
+     */
+    'instanceTemplates'?: Array<InstanceTemplateReplicas>;
     /**
      * List of online instance names to be switched to offline during scaling in.
      * @type {Array<string>}

package/src/adminapi/models/{ops-volume-expand-volumes-inner.ts → ops-volume-expand-volumes-items0.ts}

@@ -17,19 +17,19 @@
 /**
  * 
  * @export
- * @interface OpsVolumeExpandVolumesInner
+ * @interface OpsVolumeExpandVolumesItems0
  */
-export interface OpsVolumeExpandVolumesInner {
+export interface OpsVolumeExpandVolumesItems0 {
     /**
-     * volume name
+     * Volume name.
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof OpsVolumeExpandVolumesItems0
      */
     'name': string;
     /**
-     * Storage size, the unit is Gi.
+     * Desired size with Gi suffix, for example 30Gi.
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof OpsVolumeExpandVolumesItems0
      */
     'storage': string;
 }

package/src/adminapi/models/ops-volume-expand.ts

@@ -15,14 +15,23 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { OpsVolumeExpandVolumesInner } from './ops-volume-expand-volumes-inner';
+import type { InstanceTemplateVolumeExpand } from './instance-template-volume-expand';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OpsVolumeExpandVolumesItems0 } from './ops-volume-expand-volumes-items0';
 
 /**
- * OpsVolumeExpand is the payload to expand volume for a KubeBlocks cluster
+ * Expand component volumes and explicit targets for components with template expansion enabled.
  * @export
  * @interface OpsVolumeExpand
  */
 export interface OpsVolumeExpand {
+    /**
+     * Required when the current mode component instanceTemplate.ops includes storageExpansion; otherwise omit for component-level expansion. Explicit targets require this capability. Every configured template must explicitly specify the same volume names and target capacities as component-level volumes. Names identify templates, not Pods. Targets are forwarded together in one OpsRequest without filling in, merging, or removing template targets. KubeBlocks may materialize template volumeClaimTemplates for explicitly targeted inherited volumes.
+     * @type {Array<InstanceTemplateVolumeExpand>}
+     * @memberof OpsVolumeExpand
+     */
+    'instanceTemplates'?: Array<InstanceTemplateVolumeExpand>;
     /**
      * 
      * @type {string}
@@ -31,9 +40,9 @@ export interface OpsVolumeExpand {
     'component': string;
     /**
      * 
-     * @type {Array<OpsVolumeExpandVolumesInner>}
+     * @type {Array<OpsVolumeExpandVolumesItems0>}
      * @memberof OpsVolumeExpand
      */
-    'volumes': Array<OpsVolumeExpandVolumesInner>;
+    'volumes': Array<OpsVolumeExpandVolumesItems0>;
 }
 

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

@@ -42,7 +42,7 @@ export interface OpsVScale {
      */
     'memory'?: string;
     /**
-     * class code of the cluster
+     * Class code for component-level vertical scaling.
      * @type {string}
      * @memberof OpsVScale
      */

package/src/adminapi/models/show-data-request.ts

@@ -33,10 +33,22 @@ export interface ShowDataRequest {
      */
     'table'?: string;
     /**
-     * return limited number of data
+     * Rows per batch, from 1 to 2000; defaults to 200.
      * @type {number}
      * @memberof ShowDataRequest
      */
     'limit'?: number | null;
+    /**
+     * Zero-based offset. Include 0 for the first paged request; omit for legacy data plus total-count behavior. Paged requests do not count the table.
+     * @type {number}
+     * @memberof ShowDataRequest
+     */
+    'offset'?: number | null;
+    /**
+     * Only return pagination.totalRows, without loading data.
+     * @type {boolean}
+     * @memberof ShowDataRequest
+     */
+    'countOnly'?: boolean;
 }
 

package/src/adminapi/models/task-retry-mode.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * restart reruns all steps; resume preserves successful steps.
+ * @export
+ * @enum {string}
+ */
+
+export const TaskRetryMode = {
+    restart: 'restart',
+    resume: 'resume'
+} as const;
+
+export type TaskRetryMode = typeof TaskRetryMode[keyof typeof TaskRetryMode];
+
+
+

package/src/adminapi/models/task.ts

@@ -18,6 +18,9 @@
 import type { TaskFailurePolicy } from './task-failure-policy';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { TaskRetryMode } from './task-retry-mode';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { TaskSchedule } from './task-schedule';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -122,6 +125,12 @@ export interface Task {
      * @memberof Task
      */
     'failurePolicy'?: TaskFailurePolicy;
+    /**
+     * Supported manual retry modes for this task. Runtime conflicts are checked when retrying.
+     * @type {Array<TaskRetryMode>}
+     * @memberof Task
+     */
+    'retryModes'?: Array<TaskRetryMode>;
     /**
      * Maximum number of retries for the task
      * @type {number}

package/src/adminapi/models/vip-pool-create.ts

@@ -26,5 +26,11 @@ export interface VipPoolCreate {
      * @memberof VipPoolCreate
      */
     'addresses': string;
+    /**
+     * Name of the VIP Pool. It is what a cluster selects the pool by, so it is not restricted by Kubernetes resource naming rules. The MetalLB IPAddressPool resource name stays the generated kb-<id>.
+     * @type {string}
+     * @memberof VipPoolCreate
+     */
+    'poolName': string;
 }
 

package/src/adminapi/models/vip-pool-update.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.
+ */
+
+
+
+/**
+ * VIP Pool update
+ * @export
+ * @interface VipPoolUpdate
+ */
+export interface VipPoolUpdate {
+    /**
+     * IP Addresses
+     * @type {string}
+     * @memberof VipPoolUpdate
+     */
+    'addresses': string;
+}
+

package/src/adminapi/models/vip-pool.ts

@@ -32,6 +32,18 @@ export interface VipPool {
      * @memberof VipPool
      */
     'id'?: string;
+    /**
+     * Name of VIP Pool. It is the MetalLB IPAddressPool resource name, generated as kb-<id>.
+     * @type {string}
+     * @memberof VipPool
+     */
+    'name'?: string;
+    /**
+     * User facing name of the VIP Pool, used to select the pool when creating a cluster. It falls back to the IPAddressPool resource name.
+     * @type {string}
+     * @memberof VipPool
+     */
+    'poolName'?: string;
     /**
      * Total number of IP addresses
      * @type {number}