kb-cloud-client-typescript 2.3.0-alpha.154 → 2.3.0-alpha.156

package/src/adminapi.yaml

@@ -3735,6 +3735,49 @@ paths:
         - cluster
         - shared
       x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/modeTransition:
+    post:
+      operationId: transitionClusterMode
+      summary: Transition cluster engine mode
+      description: Validates the mode transition, updates the cluster spec, and creates an hscale task when required. Returns the resulting OpsRequest name and task ID.
+      parameters:
+        - description: name of the Org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the KubeBlocks cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/clusterModeTransition'
+      responses:
+        '202':
+          description: Mode transition accepted. Returns the OpsRequest name and task ID when an hscale operation is created.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - cluster
+        - shared
+      x-codegen-request-body-name: body
   /admin/v1/organizations/{orgName}/parent/{parentClusterID}/disasterRecovery:
     get:
       operationId: listDisasterRecovery
@@ -9886,6 +9929,37 @@ paths:
           $ref: '#/components/responses/404'
       tags:
         - environment
+  /admin/v1/environments/{environmentName}/koordinatorReservations/summary:
+    get:
+      description: Get Koordinator Reservation summary for the cluster creation page.
+      summary: Get Koordinator Reservation summary
+      operationId: getKoordinatorReservationSummary
+      parameters:
+        - description: name of the environment
+          in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/koordinatorReservationSummary'
+          description: Koordinator Reservation summary.
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - environment
   /admin/v1/environments/{environmentName}/nodes/{nodeName}/cordon:
     patch:
       description: cordon the specified Environment node
@@ -15762,9 +15836,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/inspectionTaskItem'
+                $ref: '#/components/schemas/inspectionTask'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -23769,6 +23841,11 @@ components:
         * `HardAntiAffinity` - Strictly enforce pod anti-affinity across nodes. Pods will not be scheduled when the anti-affinity constraints cannot be satisfied.
         * `SoftAntiAffinity` - Prefer to spread pods across nodes using anti-affinity, but allow scheduling on the same node when constraints cannot be fully satisfied.
         * `Disabled` - Do not apply pod anti-affinity constraints on nodes.
+    koordinatorReservationResourceClass:
+      type: string
+      enum:
+        - database
+        - business
     clusterCreate:
       required:
         - engine
@@ -23868,6 +23945,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Scheduler used by this cluster. If omitted, KBE uses the environment default. When koordinatorEnabled is true for the target environment, the environment default is the globally configured Koordinator scheduler.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster information
     componentItem:
       type: object
@@ -24095,6 +24180,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Effective scheduler used when the cluster was created.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster details
     clusterBatchUpdateData:
       type: object
@@ -24984,6 +25077,98 @@ components:
             $ref: '#/components/schemas/haHistory'
       required:
         - items
+    taskScheduleType:
+      type: string
+      enum:
+        - immediate
+        - scheduled
+        - maintenanceWindow
+      description: Schedule type for task execution
+    taskSchedule:
+      type: object
+      properties:
+        type:
+          $ref: '#/components/schemas/taskScheduleType'
+        startTime:
+          type: string
+          format: date-time
+          description: Start time of the execution window (required for scheduled type)
+          x-nullable: true
+        endTime:
+          type: string
+          format: date-time
+          description: End time of the execution window (required for scheduled type)
+          x-nullable: true
+      required:
+        - type
+    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.
+      required:
+        - component
+      properties:
+        component:
+          description: component type
+          type: string
+          minLength: 1
+        backupName:
+          description: name of the backup to restore from
+          type: string
+          nullable: true
+        replicas:
+          description: number of replicas
+          type: integer
+          nullable: true
+        onlineInstancesToOffline:
+          type: array
+          items:
+            type: string
+          description: List of online instance names to be switched to offline during scaling in.
+          nullable: true
+        OfflineInstancesToOnline:
+          type: array
+          items:
+            type: string
+          description: List of offline instance names to be switched to online during scaling out.
+          nullable: true
+        shards:
+          description: number of shards, mutually exclusive with replicas.
+          type: integer
+          nullable: true
+        preConditionDeadlineSeconds:
+          description: Specifies the maximum time in seconds that the OpsRequest will wait for its pre-conditions to be met before it aborts the operation
+          type: integer
+          nullable: true
+          minimum: 0
+        force:
+          type: boolean
+          description: force the scaling operation without pre-check
+          default: false
+        schedule:
+          $ref: '#/components/schemas/taskSchedule'
+      type: object
+    clusterModeTransition:
+      type: object
+      description: Parameters for switching the engine mode of a cluster.
+      required:
+        - mode
+      properties:
+        mode:
+          type: string
+          description: Target engine mode.
+        hScale:
+          $ref: '#/components/schemas/opsHScale'
+    opsRequestName:
+      description: OpsRequestName is the name of a KubeBlocks OpsRequest response
+      properties:
+        opsRequestName:
+          type: string
+        clusterTaskId:
+          type: string
+        taskId:
+          type: string
+      required:
+        - taskId
+      type: object
     taskSummary:
       type: object
       properties:
@@ -28034,30 +28219,6 @@ components:
           type: integer
           format: int64
           x-omitempty: false
-    taskScheduleType:
-      type: string
-      enum:
-        - immediate
-        - scheduled
-        - maintenanceWindow
-      description: Schedule type for task execution
-    taskSchedule:
-      type: object
-      properties:
-        type:
-          $ref: '#/components/schemas/taskScheduleType'
-        startTime:
-          type: string
-          format: date-time
-          description: Start time of the execution window (required for scheduled type)
-          x-nullable: true
-        endTime:
-          type: string
-          format: date-time
-          description: End time of the execution window (required for scheduled type)
-          x-nullable: true
-      required:
-        - type
     reconfigureCreate:
       description: ReconfigureCreate is the payload to reconfigure a KubeBlocks cluster
       properties:
@@ -28081,18 +28242,6 @@ components:
       required:
         - component
       type: object
-    opsRequestName:
-      description: OpsRequestName is the name of a KubeBlocks OpsRequest response
-      properties:
-        opsRequestName:
-          type: string
-        clusterTaskId:
-          type: string
-        taskId:
-          type: string
-      required:
-        - taskId
-      type: object
     opsRestart:
       description: OpsRestart is the payload to restart a KubeBlocks cluster
       required:
@@ -28173,6 +28322,58 @@ components:
       required:
         - usage
       type: object
+    koordinatorReservationResources:
+      type: object
+      additionalProperties: false
+      description: Resource requests supported by KBE for Koordinator Reservations. Values are Kubernetes quantities and responses use Kubernetes canonical quantity strings.
+      properties:
+        cpu:
+          type: string
+        memory:
+          type: string
+    koordinatorReservationAllocatePolicy:
+      type: string
+      enum:
+        - Restricted
+        - Aligned
+    koordinatorReservationStatus:
+      type: object
+      properties:
+        phase:
+          type: string
+        nodeName:
+          type: string
+        allocatable:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        allocated:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        available:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+    koordinatorNodeReservation:
+      type: object
+      required:
+        - resourceClass
+        - resources
+      properties:
+        resourceClass:
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
+        reservationName:
+          type: string
+          readOnly: true
+        resources:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        ttl:
+          type: string
+          default: 24h
+          description: Kubernetes duration string. Koordinator defaults omitted ttl to 24h.
+        allocateOnce:
+          type: boolean
+        preAllocation:
+          type: boolean
+        allocatePolicy:
+          $ref: '#/components/schemas/koordinatorReservationAllocatePolicy'
+        status:
+          $ref: '#/components/schemas/koordinatorReservationStatus'
     nodeStatus:
       type: string
       description: Status of the node
@@ -28231,6 +28432,10 @@ components:
         managed:
           description: Whether the node is managed (has data-plane or control-plane label)
           type: boolean
+        koordinatorReservations:
+          type: array
+          items:
+            $ref: '#/components/schemas/koordinatorNodeReservation'
         status:
           $ref: '#/components/schemas/nodeStatus'
           description: Node status
@@ -28369,51 +28574,6 @@ components:
         schedule:
           $ref: '#/components/schemas/taskSchedule'
       type: object
-    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.
-      required:
-        - component
-      properties:
-        component:
-          description: component type
-          type: string
-          minLength: 1
-        backupName:
-          description: name of the backup to restore from
-          type: string
-          nullable: true
-        replicas:
-          description: number of replicas
-          type: integer
-          nullable: true
-        onlineInstancesToOffline:
-          type: array
-          items:
-            type: string
-          description: List of online instance names to be switched to offline during scaling in.
-          nullable: true
-        OfflineInstancesToOnline:
-          type: array
-          items:
-            type: string
-          description: List of offline instance names to be switched to online during scaling out.
-          nullable: true
-        shards:
-          description: number of shards, mutually exclusive with replicas.
-          type: integer
-          nullable: true
-        preConditionDeadlineSeconds:
-          description: Specifies the maximum time in seconds that the OpsRequest will wait for its pre-conditions to be met before it aborts the operation
-          type: integer
-          nullable: true
-          minimum: 0
-        force:
-          type: boolean
-          description: force the scaling operation without pre-check
-          default: false
-        schedule:
-          $ref: '#/components/schemas/taskSchedule'
-      type: object
     opsPromote:
       description: OpsPromote is the payload to promote a KubeBlocks cluster
       required:
@@ -28952,7 +29112,6 @@ components:
       type: object
       description: Storage config for environment
       required:
-        - log
         - backup
         - storages
       properties:
@@ -28961,15 +29120,6 @@ components:
           description: these storages will be created
           items:
             $ref: '#/components/schemas/environmentStorage'
-        log:
-          type: object
-          description: the storage config for log
-          required:
-            - storageName
-          properties:
-            storageName:
-              type: string
-              description: the name of storage
         backup:
           type: object
           description: the storage config for backup
@@ -29210,6 +29360,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
     environmentList:
       description: EnvironmentList is a list of Environments
       properties:
@@ -29289,6 +29443,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
     preflight:
       title: Preflight results
       description: The result of preflight check
@@ -29417,6 +29575,10 @@ components:
           description: whether to enable calculate the cluster SLA for the environment
           type: boolean
           default: false
+        koordinatorEnabled:
+          description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+          type: boolean
+          default: false
         clusterSchedulingPolicy:
           $ref: '#/components/schemas/clusterSchedulingPolicy'
     environmentStateEvent:
@@ -29742,6 +29904,50 @@ components:
       required:
         - items
       type: object
+    schedulerOption:
+      type: object
+      properties:
+        name:
+          type: string
+        displayName:
+          type: string
+        default:
+          type: boolean
+    koordinatorReservationSummaryItem:
+      type: object
+      properties:
+        resourceClass:
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
+        nodeCount:
+          type: integer
+          format: int64
+        total:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        allocated:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+        available:
+          $ref: '#/components/schemas/koordinatorReservationResources'
+    koordinatorReservationSummary:
+      type: object
+      required:
+        - enabled
+        - schedulerOptions
+        - items
+      properties:
+        enabled:
+          type: boolean
+        schedulerName:
+          type: string
+        defaultSchedulerName:
+          type: string
+        schedulerOptions:
+          type: array
+          items:
+            $ref: '#/components/schemas/schedulerOption'
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/koordinatorReservationSummaryItem'
     listBody:
       description: Represents a list of JSON bodies.
       items:

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

@@ -59,6 +59,7 @@ models/image-registry.ts
 models/index.ts
 models/init-option-item.ts
 models/io-quantity.ts
+models/koordinator-reservation-resource-class.ts
 models/localized-description.ts
 models/network-mode.ts
 models/outage-record.ts

package/src/internalapi/models/cluster.ts

@@ -39,6 +39,9 @@ import type { ComponentItem } from './component-item';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -314,6 +317,18 @@ export interface Cluster {
      * @memberof Cluster
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Effective scheduler used when the cluster was created.
+     * @type {string}
+     * @memberof Cluster
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof Cluster
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/internalapi/models/index.ts

@@ -34,6 +34,7 @@ export * from './http-body';
 export * from './image-registry';
 export * from './init-option-item';
 export * from './io-quantity';
+export * from './koordinator-reservation-resource-class';
 export * from './localized-description';
 export * from './network-mode';
 export * from './outage-record';

package/src/internalapi/models/koordinator-reservation-resource-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const KoordinatorReservationResourceClass = {
+    database: 'database',
+    business: 'business'
+} as const;
+
+export type KoordinatorReservationResourceClass = typeof KoordinatorReservationResourceClass[keyof typeof KoordinatorReservationResourceClass];
+
+
+

package/src/internalapi.yaml

@@ -1518,6 +1518,11 @@ components:
         * `HardAntiAffinity` - Strictly enforce pod anti-affinity across nodes. Pods will not be scheduled when the anti-affinity constraints cannot be satisfied.
         * `SoftAntiAffinity` - Prefer to spread pods across nodes using anti-affinity, but allow scheduling on the same node when constraints cannot be fully satisfied.
         * `Disabled` - Do not apply pod anti-affinity constraints on nodes.
+    koordinatorReservationResourceClass:
+      type: string
+      enum:
+        - database
+        - business
     cluster:
       required:
         - engine
@@ -1695,6 +1700,14 @@ components:
         schedulingPolicy:
           description: Scheduling policy for this cluster.
           $ref: '#/components/schemas/schedulingPolicyType'
+        schedulerName:
+          title: Scheduler Name
+          type: string
+          nullable: true
+          description: Effective scheduler used when the cluster was created.
+        reservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
       description: KubeBlocks cluster details
     storage:
       type: object

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

@@ -84,7 +84,6 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
-models/access-level.ts
 models/account-list-item.ts
 models/account-list-role-type.ts
 models/account-option.ts
@@ -224,7 +223,6 @@ models/cdc-worker-template.ts
 models/certificate-issuer.ts
 models/certificate.ts
 models/channel-status.ts
-models/check-apikey.ts
 models/class-type.ts
 models/class.ts
 models/cluster-alert-summary.ts
@@ -515,11 +513,14 @@ models/ip-whitelist-list.ts
 models/ip-whitelist.ts
 models/key-list.ts
 models/key.ts
+models/koordinator-node-reservation.ts
+models/koordinator-reservation-allocate-policy.ts
+models/koordinator-reservation-resource-class.ts
+models/koordinator-reservation-resources.ts
+models/koordinator-reservation-status.ts
 models/kubeblocks-endpoint.ts
 models/license-option.ts
 models/license.ts
-models/llm-list.ts
-models/llm.ts
 models/load-balancer-available-type.ts
 models/load-balancer-ipam-status.ts
 models/load-balancer-status.ts