kb-cloud-client-typescript 2.3.32 → 2.3.34

package/src/adminapi/models/index.ts

@@ -593,6 +593,7 @@ 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';
@@ -773,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';
@@ -1031,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';

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

@@ -23,7 +23,9 @@
 export const InstanceTemplateAttribute = {
     env: 'env',
     annotations: 'annotations',
-    labels: 'labels'
+    labels: 'labels',
+    availabilityZone: 'availabilityZone',
+    storageClass: 'storageClass'
 } as const;
 
 export type InstanceTemplateAttribute = typeof InstanceTemplateAttribute[keyof typeof InstanceTemplateAttribute];

package/src/adminapi/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. env, annotations, and labels are optional overlays onto the chart-rendered instance. The request must include every chart-rendered instance template exactly once. 
+ * 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
  */
@@ -35,6 +35,18 @@ export interface InstanceTemplateCreate {
      * @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>}

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

@@ -22,7 +22,8 @@
 
 export const InstanceTemplateOp = {
     hscale: 'hscale',
-    vscale: 'vscale'
+    vscale: 'vscale',
+    storageExpansion: 'storageExpansion'
 } as const;
 
 export type InstanceTemplateOp = typeof InstanceTemplateOp[keyof typeof InstanceTemplateOp];

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

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

@@ -24,19 +24,19 @@ import type { InstanceTemplateEnv } from './instance-template-env';
 import type { InstanceTemplateOp } from './instance-template-op';
 
 /**
- * Frontend catalog of instance templates for this mode component. names, ops, attributes, and env are for UI rendering. Create validates the request against chart-rendered Cluster instances, not this catalog. HScale does not re-check this catalog; it builds the OpsRequest from the request and the live Cluster. HScale instanceTemplates still requires top-level replicas. ops lists hscale and vscale for the UI (vscale is reserved; class stays component-level). Only HScale processes instance templates. VolumeExpansion, VScale, Upgrade, Restart, and other operations silently ignore instance templates and keep their component-level behavior. Template-level volumeexpansion is not implemented. The platform does not even-split or fill in missing templates. When absent, the frontend should use component-level operations. 
+ * 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. 
+     * 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>;
     /**
-     * Operations the frontend should offer per template: hscale, vscale. Not re-checked when creating a cluster or building an hscale OpsRequest. Only hscale currently acts per template; vscale is reserved. VolumeExpansion, VScale, Upgrade, and Restart ignore instance templates and keep their component-level behavior. 
+     * Template operations: hscale, storageExpansion, and reserved vscale. Explicit volume expansion targets must match component volume names and target capacities. 
      * @type {Array<InstanceTemplateOp>}
      * @memberof ModeComponentInstanceTemplate
      */

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

@@ -428,50 +428,6 @@ paths:
           $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/archive:
-    post:
-      operationId: archiveClusterJar
-      summary: Archive a JAR while retaining published files and startup synchronization
-      tags:
-        - clusterJar
-        - shared
-      parameters:
-        - name: engineName
-          in: path
-          required: true
-          description: Doris or SelectDB engine of the target cluster.
-          schema:
-            type: string
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
-        - name: clusterName
-          in: path
-          required: true
-          schema:
-            type: string
-        - name: jarId
-          in: path
-          required: true
-          schema:
-            type: string
-      responses:
-        '204':
-          description: Success
-        '400':
-          $ref: '#/components/responses/400'
-        '401':
-          $ref: '#/components/responses/401'
-        '403':
-          $ref: '#/components/responses/403'
-        '404':
-          $ref: '#/components/responses/404'
-        '409':
-          $ref: '#/components/responses/409'
-        '500':
-          $ref: '#/components/responses/500'
   /admin/v1/user:
     get:
       description: Get authenticated login user info
@@ -17842,7 +17798,7 @@ paths:
   /admin/v1/tasks/{taskId}/retry:
     patch:
       summary: Retry a task
-      description: retry task
+      description: Restart a failed or stopped task. Resume requires the task type to declare resume in allowActions. The default mode is restart, which reruns all steps; resume preserves successful steps.
       operationId: retryTask
       parameters:
         - description: ID of the task
@@ -17851,6 +17807,12 @@ paths:
           required: true
           schema:
             type: string
+        - name: mode
+          in: query
+          description: restart reruns all steps; resume preserves successful steps and reruns unfinished steps and PreFinish hooks.
+          required: false
+          schema:
+            $ref: '#/components/schemas/taskRetryMode'
       responses:
         '200':
           description: Current status of the task
@@ -17866,6 +17828,12 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+        '405':
+          description: The task type does not support resume.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
         '500':
           $ref: '#/components/responses/500'
       tags:
@@ -28475,8 +28443,6 @@ components:
           type: string
         published:
           type: boolean
-        archived:
-          type: boolean
         status:
           type: string
         synced:
@@ -28503,7 +28469,6 @@ components:
         - size
         - uri
         - published
-        - archived
         - status
         - synced
         - total
@@ -29955,7 +29920,7 @@ components:
       type: object
       additionalProperties: false
       description: |
-        Create assignment for one instance template. name and replicas are required. env, annotations, and labels are optional overlays onto the chart-rendered instance. The request must include every chart-rendered instance template exactly once.
+        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.
       required:
         - name
         - replicas
@@ -29968,6 +29933,12 @@ components:
           type: integer
           minimum: 0
           description: Replica count for this instance template.
+        availabilityZone:
+          type: string
+          description: 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.
+        storageClass:
+          type: string
+          description: 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.
         env:
           type: array
           description: Simple env vars (name and value only) merged into this template. valueFrom is not supported; overlaying a name clears any chart valueFrom.
@@ -32521,6 +32492,34 @@ components:
     DmsPagination:
       type: object
       properties:
+        offset:
+          type: integer
+          format: int64
+          nullable: true
+          description: Zero-based offset of this showData page.
+        limit:
+          type: integer
+          format: int64
+          nullable: true
+        hasMore:
+          type: boolean
+          nullable: true
+          description: Whether another showData page exists; determined by reading one extra row.
+        nextOffset:
+          type: integer
+          format: int64
+          nullable: true
+          description: Present only when hasMore is true.
+        totalRows:
+          type: integer
+          format: int64
+          nullable: true
+          description: Exact count returned only by countOnly requests (including zero).
+        orderColumns:
+          type: array
+          items:
+            type: string
+          description: Primary-key columns used for ordering; empty means ordering is not guaranteed. Pages are not a fixed snapshot.
         rows_count:
           type: integer
         page:
@@ -33446,8 +33445,19 @@ components:
           description: the target table or view name
         limit:
           type: integer
-          description: return limited number of data
+          description: Rows per batch, from 1 to 2000; defaults to 200.
+          minimum: 1
+          maximum: 2000
+          nullable: true
+        offset:
+          type: integer
+          format: int64
+          minimum: 0
           nullable: true
+          description: 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.
+        countOnly:
+          type: boolean
+          description: Only return pagination.totalRows, without loading data.
     RedisACLContext:
       type: object
       properties:
@@ -35542,9 +35552,43 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/engineServiceVersionsItem'
+    opsVolumeExpandVolumesItems0:
+      type: object
+      required:
+        - name
+        - storage
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Volume name.
+        storage:
+          type: string
+          description: Desired size with Gi suffix, for example 30Gi.
+    instanceTemplateVolumeExpand:
+      type: object
+      required:
+        - name
+        - volumes
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Template name from the current mode component instanceTemplate.names.
+        volumes:
+          type: array
+          minItems: 1
+          items:
+            $ref: '#/components/schemas/opsVolumeExpandVolumesItems0'
     opsVolumeExpand:
-      description: OpsVolumeExpand is the payload to expand volume for a KubeBlocks cluster
+      description: Expand component volumes and explicit targets for components with template expansion enabled.
       properties:
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: 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.
+          items:
+            $ref: '#/components/schemas/instanceTemplateVolumeExpand'
         component:
           type: string
           minLength: 1
@@ -35552,17 +35596,7 @@ components:
           type: array
           minItems: 1
           items:
-            type: object
-            properties:
-              name:
-                type: string
-                description: volume name
-              storage:
-                type: string
-                description: Storage size, the unit is Gi.
-            required:
-              - name
-              - storage
+            $ref: '#/components/schemas/opsVolumeExpandVolumesItems0'
       required:
         - volumes
         - component
@@ -39290,6 +39324,7 @@ components:
       enum:
         - hscale
         - vscale
+        - storageExpansion
     instanceTemplateAttribute:
       type: string
       description: Heterogeneous attribute the frontend may render on an instance template at create.
@@ -39297,6 +39332,8 @@ components:
         - env
         - annotations
         - labels
+        - availabilityZone
+        - storageClass
     instanceTemplateEnv:
       type: object
       description: One fillable env var on an instance template, for frontend rendering.
@@ -39341,19 +39378,9 @@ components:
         instanceTemplate:
           type: object
           description: |
-            Frontend catalog of instance templates for this mode component.
-            names, ops, attributes, and env are for UI rendering. Create
-            validates the request against chart-rendered Cluster instances,
-            not this catalog. HScale does not re-check this catalog; it
-            builds the OpsRequest from the request and the live Cluster.
-            HScale instanceTemplates still requires top-level replicas.
-            ops lists hscale and vscale for the UI (vscale is reserved;
-            class stays component-level). Only HScale processes instance templates.
-            VolumeExpansion, VScale, Upgrade, Restart, and other operations silently
-            ignore instance templates and keep their component-level behavior.
-            Template-level volumeexpansion is not implemented.
-            The platform does not even-split or fill in missing templates.
-            When absent, the frontend should use component-level operations.
+            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.
           required:
             - names
             - ops
@@ -39367,18 +39394,16 @@ components:
               description: |
                 Instance template names the frontend should render.
                 Create and hscale check names against the chart or live Cluster,
-                not this list.
+                not this list. Explicit volume expansion targets must include every name in this list.
             ops:
               type: array
               minItems: 1
               items:
                 $ref: '#/components/schemas/instanceTemplateOp'
               description: |
-                Operations the frontend should offer per template: hscale, vscale.
-                Not re-checked when creating a cluster or building an hscale OpsRequest.
-                Only hscale currently acts per template; vscale is reserved.
-                VolumeExpansion, VScale, Upgrade, and Restart ignore instance templates
-                and keep their component-level behavior.
+                Template operations: hscale, storageExpansion, and reserved vscale.
+                Explicit volume expansion targets must match component volume names
+                and target capacities.
             attributes:
               type: array
               uniqueItems: true
@@ -40052,6 +40077,14 @@ components:
         - defaultMethod
         - fullMethod
       properties:
+        modes:
+          type: array
+          x-omitempty: false
+          description: |
+            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.
+          items:
+            type: string
         defaultMethod:
           type: string
         defaultComponent:
@@ -43896,6 +43929,13 @@ components:
         - interrupt
         - ignore
       description: Policy to handle failures
+    taskRetryMode:
+      type: string
+      enum:
+        - restart
+        - resume
+      default: restart
+      description: restart reruns all steps; resume preserves successful steps.
     task:
       type: object
       required:
@@ -43961,6 +44001,11 @@ components:
           description: Degree of parallelism for the task
         failurePolicy:
           $ref: '#/components/schemas/taskFailurePolicy'
+        retryModes:
+          type: array
+          description: Supported manual retry modes for this task. Runtime conflicts are checked when retrying.
+          items:
+            $ref: '#/components/schemas/taskRetryMode'
         retryLimit:
           type: integer
           description: Maximum number of retries for the task

package/src/openapi/.openapi-generator/FILES

@@ -611,6 +611,7 @@ models/instance-template-create.ts
 models/instance-template-env.ts
 models/instance-template-op.ts
 models/instance-template-replicas.ts
+models/instance-template-volume-expand.ts
 models/instance.ts
 models/integer-option.ts
 models/international-desc.ts
@@ -772,7 +773,7 @@ models/ops-restart.ts
 models/ops-start.ts
 models/ops-stop.ts
 models/ops-upgrade.ts
-models/ops-volume-expand-volumes-inner.ts
+models/ops-volume-expand-volumes-items0.ts
 models/ops-volume-expand.ts
 models/ops-vscale.ts
 models/org-aggregation-group-type.ts
@@ -979,6 +980,7 @@ models/tag.ts
 models/task-failure-policy.ts
 models/task-list-item.ts
 models/task-list.ts
+models/task-retry-mode.ts
 models/task-schedule-type.ts
 models/task-schedule.ts
 models/task-status.ts