kb-cloud-client-typescript 2.3.31 → 2.3.33

package/src/openapi.yaml

@@ -466,50 +466,6 @@ paths:
           $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
-  /api/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'
   /api/v1/user:
     get:
       description: Get authenticated login user info
@@ -23307,8 +23263,6 @@ components:
           type: string
         published:
           type: boolean
-        archived:
-          type: boolean
         status:
           type: string
         synced:
@@ -23335,7 +23289,6 @@ components:
         - size
         - uri
         - published
-        - archived
         - status
         - synced
         - total
@@ -24467,6 +24420,14 @@ components:
           description: ID of VIP Pool
           title: ID
           type: string
+        name:
+          description: Name of VIP Pool. It is the MetalLB IPAddressPool resource name, generated as kb-<id>.
+          title: Name
+          type: string
+        poolName:
+          description: User facing name of the VIP Pool, used to select the pool when creating a cluster. It falls back to the IPAddressPool resource name.
+          title: Pool Name
+          type: string
         total:
           description: Total number of IP addresses
           format: int64
@@ -25512,6 +25473,54 @@ components:
       enum:
         - DoNotTerminate
         - Delete
+    instanceTemplateCreate:
+      type: object
+      additionalProperties: false
+      description: |
+        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
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name; must match a chart-rendered instance.
+        replicas:
+          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.
+          items:
+            type: object
+            required:
+              - name
+              - value
+            properties:
+              name:
+                type: string
+              value:
+                type: string
+                minLength: 1
+                description: Plain string value only. valueFrom is not supported.
+        annotations:
+          type: object
+          additionalProperties:
+            type: string
+          description: Annotation map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+        labels:
+          type: object
+          additionalProperties:
+            type: string
+          description: Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
     ioQuantity:
       description: IO Quantity describes IOPS and BPS of a volume
       properties:
@@ -25589,7 +25598,13 @@ components:
         replicas:
           title: Replicas
           type: integer
-          description: The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3.
+          description: 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.
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: 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.
+          items:
+            $ref: '#/components/schemas/instanceTemplateCreate'
         skipResourceConstraints:
           type: boolean
           description: Whether to skip resource constraint validation when creating cluster
@@ -25870,6 +25885,10 @@ components:
         networkMode:
           description: Specify the network mode for intra-cluster communication
           $ref: '#/components/schemas/networkMode'
+        vipPoolName:
+          title: VIP Pool Name
+          description: 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
         serviceRefs:
           type: array
           items:
@@ -26493,8 +26512,23 @@ components:
           x-nullable: true
       required:
         - type
+    instanceTemplateReplicas:
+      type: object
+      description: HScale assignment for one instance template. name and replicas only.
+      required:
+        - name
+        - replicas
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Instance template name on the live Cluster spec.
+        replicas:
+          type: integer
+          minimum: 0
+          description: Target replica count for this instance template.
     opsHScale:
-      description: OpsHScale is the payload to horizontally scale a KubeBlocks cluster. It requires specifying either the number of replicas or the number of shards.
+      description: OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. instanceTemplates is an optional overlay and requires top-level replicas.
       required:
         - component
       properties:
@@ -26510,6 +26544,12 @@ components:
           description: number of replicas
           type: integer
           nullable: true
+        instanceTemplates:
+          type: array
+          minItems: 1
+          description: 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.
+          items:
+            $ref: '#/components/schemas/instanceTemplateReplicas'
         onlineInstancesToOffline:
           type: array
           items:
@@ -26697,6 +26737,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:
@@ -27431,9 +27499,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
@@ -27441,17 +27543,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
@@ -27472,7 +27564,7 @@ components:
           description: memory size
           type: string
         classCode:
-          description: class code of the cluster
+          description: Class code for component-level vertical scaling.
           type: string
         schedule:
           $ref: '#/components/schemas/taskSchedule'
@@ -32704,6 +32796,42 @@ components:
       enum:
         - '0.9'
         - '1.0'
+    instanceTemplateOp:
+      type: string
+      description: Operation that can be declared on instanceTemplate.ops.
+      enum:
+        - hscale
+        - vscale
+        - storageExpansion
+    instanceTemplateAttribute:
+      type: string
+      description: Heterogeneous attribute the frontend may render on an instance template at create.
+      enum:
+        - env
+        - annotations
+        - labels
+        - availabilityZone
+        - storageClass
+    instanceTemplateEnv:
+      type: object
+      description: One fillable env var on an instance template, for frontend rendering.
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          minLength: 1
+          description: Env var name written to the instance template.
+        label:
+          $ref: '#/components/schemas/localizedDescription'
+        description:
+          $ref: '#/components/schemas/localizedDescription'
+        required:
+          type: boolean
+          description: If true, the frontend should treat this env as required. Create does not re-check.
+        default:
+          type: string
+          description: Default value shown by the frontend.
     modeReadonlyEndpoint:
       type: object
       required:
@@ -32725,6 +32853,52 @@ components:
           type: boolean
         hideOnCreate:
           type: boolean
+        instanceTemplate:
+          type: object
+          description: |
+            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
+          properties:
+            names:
+              type: array
+              minItems: 1
+              uniqueItems: true
+              items:
+                type: string
+              description: |
+                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.
+            ops:
+              type: array
+              minItems: 1
+              items:
+                $ref: '#/components/schemas/instanceTemplateOp'
+              description: |
+                Template operations: hscale, storageExpansion, and reserved vscale.
+                Explicit volume expansion targets must match component volume names
+                and target capacities.
+            attributes:
+              type: array
+              uniqueItems: true
+              items:
+                $ref: '#/components/schemas/instanceTemplateAttribute'
+              description: |
+                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.
+            env:
+              type: array
+              description: |
+                Env vars the frontend may render when attributes includes env.
+                Create does not re-check this list.
+              items:
+                $ref: '#/components/schemas/instanceTemplateEnv'
         serviceRef:
           type: string
           description: |
@@ -33381,6 +33555,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:
@@ -35190,6 +35372,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:
@@ -35255,6 +35444,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
@@ -35860,8 +36054,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:

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/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"}