kb-cloud-client-typescript 0.0.0-support-instance-template-ops.20260920.1113 → 0.0.0-support-instance-template-ops.20260921.645

package/src/openapi/models/{instance-template-overlay-field.ts → instance-template-attribute.ts}

@@ -15,20 +15,21 @@
 
 
 /**
- * Overlay field the frontend may render on an instance template.
+ * Heterogeneous attribute the frontend may render on an instance template at create.
  * @export
  * @enum {string}
  */
 
-export const InstanceTemplateOverlayField = {
-    storageClass: 'storageClass',
+export const InstanceTemplateAttribute = {
+    storageClassName: 'storageClassName',
     availabilityZone: 'availabilityZone',
     env: 'env',
     annotations: 'annotations',
-    labels: 'labels'
+    labels: 'labels',
+    classCode: 'classCode'
 } as const;
 
-export type InstanceTemplateOverlayField = typeof InstanceTemplateOverlayField[keyof typeof InstanceTemplateOverlayField];
+export type InstanceTemplateAttribute = typeof InstanceTemplateAttribute[keyof typeof InstanceTemplateAttribute];
 
 
 

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

@@ -18,7 +18,7 @@
 import type { InstanceTemplateCreateEnvInner } from './instance-template-create-env-inner';
 
 /**
- * Create assignment for one instance template. name and replicas are required. storageClass, availabilityZone, env, annotations, and labels are optional overlays; omitted fields inherit the component. Node group is cluster-level. Class stays on the component so later component-level vscale applies. Volume sizes are copied onto each template. The request list fully replaces chart instances. 
+ * Create assignment for one instance template. name and replicas are required. storageClassName, availabilityZone, env, annotations, labels, and classCode are optional overlays gated by instanceTemplate.attributes; omitted values inherit the component. Node group is cluster-level. Volume sizes are copied onto each template. The request list fully replaces chart instances. 
  * @export
  * @interface InstanceTemplateCreate
  */
@@ -36,11 +36,17 @@ export interface InstanceTemplateCreate {
      */
     'replicas': number;
     /**
-     * StorageClass for this template. Omit to inherit the component storageClass.
+     * StorageClassName for this template. Omit to inherit the component storageClass.
      * @type {string}
      * @memberof InstanceTemplateCreate
      */
-    'storageClass'?: string;
+    'storageClassName'?: string;
+    /**
+     * Class code for this template. Omit to inherit the component class.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'classCode'?: string;
     /**
      * Availability zone for this template. Omit to inherit component scheduling (no default zone is invented).
      * @type {string}

package/src/openapi/models/instance-template-op.ts

@@ -21,7 +21,9 @@
  */
 
 export const InstanceTemplateOp = {
-    hscale: 'hscale'
+    hscale: 'hscale',
+    vscale: 'vscale',
+    volumeexpansion: 'volumeexpansion'
 } as const;
 
 export type InstanceTemplateOp = typeof InstanceTemplateOp[keyof typeof InstanceTemplateOp];

package/src/openapi/models/{ops-volume-expand-volumes-inner.ts → instance-template-volume-expand-volumes-inner.ts}

@@ -17,19 +17,19 @@
 /**
  * 
  * @export
- * @interface OpsVolumeExpandVolumesInner
+ * @interface InstanceTemplateVolumeExpandVolumesInner
  */
-export interface OpsVolumeExpandVolumesInner {
+export interface InstanceTemplateVolumeExpandVolumesInner {
     /**
      * volume name
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof InstanceTemplateVolumeExpandVolumesInner
      */
     'name': string;
     /**
      * Storage size, the unit is Gi.
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof InstanceTemplateVolumeExpandVolumesInner
      */
     'storage': string;
 }

package/src/openapi/models/instance-template-volume-expand.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { InstanceTemplateVolumeExpandVolumesInner } from './instance-template-volume-expand-volumes-inner';
+
+/**
+ * Volume expansion assignment for one instance template.
+ * @export
+ * @interface InstanceTemplateVolumeExpand
+ */
+export interface InstanceTemplateVolumeExpand {
+    /**
+     * Instance template name declared on the engine option.
+     * @type {string}
+     * @memberof InstanceTemplateVolumeExpand
+     */
+    'name': string;
+    /**
+     * 
+     * @type {Array<InstanceTemplateVolumeExpandVolumesInner>}
+     * @memberof InstanceTemplateVolumeExpand
+     */
+    'volumes': Array<InstanceTemplateVolumeExpandVolumesInner>;
+}
+

package/src/openapi/models/instance-template-vscale.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * VScale assignment for one instance template. name and classCode.
+ * @export
+ * @interface InstanceTemplateVScale
+ */
+export interface InstanceTemplateVScale {
+    /**
+     * Instance template name declared on the engine option.
+     * @type {string}
+     * @memberof InstanceTemplateVScale
+     */
+    'name': string;
+    /**
+     * Class code for this instance template.
+     * @type {string}
+     * @memberof InstanceTemplateVScale
+     */
+    'classCode': string;
+}
+

package/src/openapi/models/mode-component-instance-template.ts

@@ -15,16 +15,16 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { InstanceTemplateEnv } from './instance-template-env';
+import type { InstanceTemplateAttribute } from './instance-template-attribute';
 // May contain unused imports in some cases
 // @ts-ignore
-import type { InstanceTemplateOp } from './instance-template-op';
+import type { InstanceTemplateEnv } from './instance-template-env';
 // May contain unused imports in some cases
 // @ts-ignore
-import type { InstanceTemplateOverlayField } from './instance-template-overlay-field';
+import type { InstanceTemplateOp } from './instance-template-op';
 
 /**
- * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale: instanceTemplates requires top-level replicas. Named templates attach as scaleIn/scaleOut.instances; omit names for component-level only. VScale is component-level only (no per-template class). The platform does not even-split or fill in missing templates. Instance online/offline can be set together with instanceTemplates. When absent, the component uses component-level operations. 
+ * Declares instance-template support for this mode component. Create requires instanceTemplates for every declared name; component replicas must equal the sum of those replica counts. HScale: instanceTemplates requires top-level replicas. Named templates attach as scaleIn/scaleOut.instances. ops catalogs hscale, vscale, and volumeexpansion; upgrade and restart stay component-level. volumeexpansion via instance templates is 400 until implemented. attributes catalogs create-time overlays. The platform does not even-split or fill in missing templates. When absent, the component uses component-level operations. 
  * @export
  * @interface ModeComponentInstanceTemplate
  */
@@ -36,19 +36,19 @@ export interface ModeComponentInstanceTemplate {
      */
     'names': Set<string>;
     /**
-     * Operations supported via instance templates. Currently only hscale. 
+     * Operations supported via instance templates: hscale, vscale, volumeexpansion. Upgrade and restart stay component-level. 
      * @type {Array<InstanceTemplateOp>}
      * @memberof ModeComponentInstanceTemplate
      */
     'ops': Array<InstanceTemplateOp>;
     /**
-     * Overlay fields the frontend should render on each instance template. Omitted or empty means only name and replicas. Request fields not listed here are rejected. Includes storageClass, availabilityZone, env, annotations, labels. 
-     * @type {Set<InstanceTemplateOverlayField>}
+     * Heterogeneous attributes the frontend should render on each instance template at create. Omitted or empty means only name and replicas. Request attributes not listed here are rejected. 
+     * @type {Set<InstanceTemplateAttribute>}
      * @memberof ModeComponentInstanceTemplate
      */
-    'fields'?: Set<InstanceTemplateOverlayField>;
+    'attributes'?: Set<InstanceTemplateAttribute>;
     /**
-     * Env vars the frontend may render when fields includes env. Each item is one fillable env name. Request env names must be in this list. 
+     * Env vars the frontend may render when attributes includes env. Each item is one fillable env name. Request env names must be in this list. 
      * @type {Array<InstanceTemplateEnv>}
      * @memberof ModeComponentInstanceTemplate
      */

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

@@ -15,7 +15,10 @@
 
 // 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 { InstanceTemplateVolumeExpandVolumesInner } from './instance-template-volume-expand-volumes-inner';
 
 /**
  * OpsVolumeExpand is the payload to expand volume for a KubeBlocks cluster
@@ -29,11 +32,17 @@ export interface OpsVolumeExpand {
      * @memberof OpsVolumeExpand
      */
     'component': string;
+    /**
+     * Per-template volume expansion. Schema is complete; apiserver currently returns 400 until instance-template volumeexpansion is implemented.
+     * @type {Array<InstanceTemplateVolumeExpand>}
+     * @memberof OpsVolumeExpand
+     */
+    'instanceTemplates'?: Array<InstanceTemplateVolumeExpand>;
     /**
      * 
-     * @type {Array<OpsVolumeExpandVolumesInner>}
+     * @type {Array<InstanceTemplateVolumeExpandVolumesInner>}
      * @memberof OpsVolumeExpand
      */
-    'volumes': Array<OpsVolumeExpandVolumesInner>;
+    'volumes': Array<InstanceTemplateVolumeExpandVolumesInner>;
 }
 

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

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateVScale } from './instance-template-vscale';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { TaskSchedule } from './task-schedule';
@@ -47,6 +50,12 @@ export interface OpsVScale {
      * @memberof OpsVScale
      */
     'classCode'?: string;
+    /**
+     * Per-template classCode. Requires instanceTemplate.ops to include vscale. Names must be unique and declared.
+     * @type {Array<InstanceTemplateVScale>}
+     * @memberof OpsVScale
+     */
+    'instanceTemplates'?: Array<InstanceTemplateVScale>;
     /**
      * 
      * @type {TaskSchedule}

package/src/openapi.yaml

@@ -24612,7 +24612,7 @@ components:
     instanceTemplateCreate:
       type: object
       description: |
-        Create assignment for one instance template. name and replicas are required. storageClass, availabilityZone, env, annotations, and labels are optional overlays; omitted fields inherit the component. Node group is cluster-level. Class stays on the component so later component-level vscale applies. Volume sizes are copied onto each template. The request list fully replaces chart instances.
+        Create assignment for one instance template. name and replicas are required. storageClassName, availabilityZone, env, annotations, labels, and classCode are optional overlays gated by instanceTemplate.attributes; omitted values inherit the component. Node group is cluster-level. Volume sizes are copied onto each template. The request list fully replaces chart instances.
       required:
         - name
         - replicas
@@ -24625,9 +24625,12 @@ components:
           type: integer
           minimum: 1
           description: Replica count for this instance template.
-        storageClass:
+        storageClassName:
+          type: string
+          description: StorageClassName for this template. Omit to inherit the component storageClass.
+        classCode:
           type: string
-          description: StorageClass for this template. Omit to inherit the component storageClass.
+          description: Class code for this template. Omit to inherit the component class.
         availabilityZone:
           type: string
           description: Availability zone for this template. Omit to inherit component scheduling (no default zone is invented).
@@ -24735,7 +24738,7 @@ components:
         instanceTemplates:
           type: array
           minItems: 1
-          description: Per-template replicas and optional overlays (storageClass, availabilityZone, env, annotations, labels). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances fully replace the Helm chart instances list. Names must be in instanceTemplate.names. Component replicas must equal the sum of these replica counts.
+          description: Per-template replicas and optional overlays (storageClassName, availabilityZone, env, annotations, labels, classCode). Node group is cluster-level and inherited. Required when the engine option declares instanceTemplate. Request instances fully replace the Helm chart instances list. Names must be in instanceTemplate.names. Component replicas must equal the sum of these replica counts.
           items:
             $ref: '#/components/schemas/instanceTemplateCreate'
         availabilityZone:
@@ -26601,12 +26604,44 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/engineServiceVersionsItem'
+    instanceTemplateVolumeExpand:
+      type: object
+      description: Volume expansion assignment for one instance template.
+      required:
+        - name
+        - volumes
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name declared on the engine option.
+        volumes:
+          type: array
+          minItems: 1
+          items:
+            type: object
+            required:
+              - name
+              - storage
+            properties:
+              name:
+                type: string
+                description: volume name
+              storage:
+                type: string
+                description: Storage size, the unit is Gi.
     opsVolumeExpand:
       description: OpsVolumeExpand is the payload to expand volume for a KubeBlocks cluster
       properties:
         component:
           type: string
           minLength: 1
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: Per-template volume expansion. Schema is complete; apiserver currently returns 400 until instance-template volumeexpansion is implemented.
+          items:
+            $ref: '#/components/schemas/instanceTemplateVolumeExpand'
         volumes:
           type: array
           minItems: 1
@@ -26626,6 +26661,21 @@ components:
         - volumes
         - component
       type: object
+    instanceTemplateVScale:
+      type: object
+      description: VScale assignment for one instance template. name and classCode.
+      required:
+        - name
+        - classCode
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name declared on the engine option.
+        classCode:
+          type: string
+          minLength: 1
+          description: Class code for this instance template.
     opsVScale:
       description: OpsVScale is the payload to vertically scale a KubeBlocks cluster
       required:
@@ -26644,6 +26694,12 @@ components:
         classCode:
           description: Class code for component-level vertical scaling.
           type: string
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: Per-template classCode. Requires instanceTemplate.ops to include vscale. Names must be unique and declared.
+          items:
+            $ref: '#/components/schemas/instanceTemplateVScale'
         schedule:
           $ref: '#/components/schemas/taskSchedule'
       type: object
@@ -31838,15 +31894,18 @@ components:
       description: Operation that can be declared on instanceTemplate.ops.
       enum:
         - hscale
-    instanceTemplateOverlayField:
+        - vscale
+        - volumeexpansion
+    instanceTemplateAttribute:
       type: string
-      description: Overlay field the frontend may render on an instance template.
+      description: Heterogeneous attribute the frontend may render on an instance template at create.
       enum:
-        - storageClass
+        - storageClassName
         - availabilityZone
         - env
         - annotations
         - labels
+        - classCode
     instanceTemplateEnv:
       type: object
       description: One fillable env var on an instance template, for frontend rendering.
@@ -31895,10 +31954,11 @@ components:
             Create requires instanceTemplates for every declared name; component
             replicas must equal the sum of those replica counts.
             HScale: instanceTemplates requires top-level replicas. Named templates
-            attach as scaleIn/scaleOut.instances; omit names for component-level only.
-            VScale is component-level only (no per-template class).
+            attach as scaleIn/scaleOut.instances.
+            ops catalogs hscale, vscale, and volumeexpansion; upgrade and restart
+            stay component-level. volumeexpansion via instance templates is 400
+            until implemented. attributes catalogs create-time overlays.
             The platform does not even-split or fill in missing templates.
-            Instance online/offline can be set together with instanceTemplates.
             When absent, the component uses component-level operations.
           required:
             - names
@@ -31920,21 +31980,21 @@ components:
               items:
                 $ref: '#/components/schemas/instanceTemplateOp'
               description: |
-                Operations supported via instance templates. Currently only hscale.
-            fields:
+                Operations supported via instance templates: hscale, vscale,
+                volumeexpansion. Upgrade and restart stay component-level.
+            attributes:
               type: array
               uniqueItems: true
               items:
-                $ref: '#/components/schemas/instanceTemplateOverlayField'
+                $ref: '#/components/schemas/instanceTemplateAttribute'
               description: |
-                Overlay fields the frontend should render on each instance template.
-                Omitted or empty means only name and replicas. Request fields not
-                listed here are rejected. Includes storageClass,
-                availabilityZone, env, annotations, labels.
+                Heterogeneous attributes the frontend should render on each
+                instance template at create. Omitted or empty means only name
+                and replicas. Request attributes not listed here are rejected.
             env:
               type: array
               description: |
-                Env vars the frontend may render when fields includes env.
+                Env vars the frontend may render when attributes includes env.
                 Each item is one fillable env name. Request env names must be in
                 this list.
               items:

package/dist/adminapi/models/instance-template-overlay-field.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;CAM/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/adminapi/models/instance-template-overlay-field.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/adminapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC"}

package/dist/adminapi/models/ops-volume-expand-volumes-inner.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ops-volume-expand-volumes-inner.d.ts","sourceRoot":"","sources":["../../../src/adminapi/models/ops-volume-expand-volumes-inner.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB"}

package/dist/adminapi/models/ops-volume-expand-volumes-inner.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ops-volume-expand-volumes-inner.js","sourceRoot":"","sources":["../../../src/adminapi/models/ops-volume-expand-volumes-inner.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG"}

package/dist/openapi/models/instance-template-overlay-field.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"instance-template-overlay-field.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,4BAA4B;;;;;;CAM/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}

package/dist/openapi/models/instance-template-overlay-field.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instance-template-overlay-field.js","sourceRoot":"","sources":["../../../src/openapi/models/instance-template-overlay-field.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;;;AAIH;;;;GAIG;AAEU,QAAA,4BAA4B,GAAG;IACxC,YAAY,EAAE,cAAc;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,aAAa;IAC1B,MAAM,EAAE,QAAQ;CACV,CAAC"}

package/dist/openapi/models/ops-volume-expand-volumes-inner.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ops-volume-expand-volumes-inner.d.ts","sourceRoot":"","sources":["../../../src/openapi/models/ops-volume-expand-volumes-inner.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB"}

package/dist/openapi/models/ops-volume-expand-volumes-inner.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ops-volume-expand-volumes-inner.js","sourceRoot":"","sources":["../../../src/openapi/models/ops-volume-expand-volumes-inner.ts"],"names":[],"mappings":";AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG"}