kb-cloud-client-typescript 2.4.0-alpha.11 → 2.4.0-alpha.110

package/src/internalapi.yaml

@@ -13,6 +13,30 @@ servers:
 security:
   - BasicAuth: []
 paths:
+  /internal/v1/environments/{environmentName}/alertConfigs/sync:
+    post:
+      tags:
+        - environment
+      operationId: syncEnvironmentAlertConfigs
+      summary: Reconcile alert configuration for an environment
+      parameters:
+        - name: environmentName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: wait
+          in: query
+          schema:
+            type: boolean
+            default: false
+      responses:
+        '202':
+          description: Reconciliation scheduled
+        '204':
+          description: Synchronous reconciliation completed
+        '500':
+          description: Reconciliation failed
   /internal/v1/alertWebhook/{orgName}/{strategyId}:
     post:
       operationId: alertWebhookProxy
@@ -213,12 +237,18 @@ paths:
           required: true
           schema:
             type: string
-        - name: isDeleteBackup
+        - name: orgID
           in: query
-          description: whether to delete the backup of the cluster
           required: true
           schema:
-            type: boolean
+            type: string
+            pattern: ^[1-9][0-9]*$
+        - name: clusterID
+          in: query
+          required: true
+          schema:
+            type: string
+            pattern: ^[1-9][0-9]*$
         - name: uid
           in: query
           description: the uid of the impersonating user
@@ -689,6 +719,92 @@ paths:
           $ref: '#/components/responses/403'
       tags:
         - cluster
+  /internal/v1/organizations/{orgName}/clusters/{clusterName}/parameters:
+    get:
+      operationId: listParameterProps
+      summary: List parameter properties of the cluster
+      tags:
+        - parameter
+        - shared
+      parameters:
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: component type
+          in: query
+          name: component
+          required: false
+          schema:
+            type: string
+        - description: whether to return the raw template content
+          in: query
+          name: rawContent
+          schema:
+            type: boolean
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/parameterList'
+          description: get configuration of the cluster successfully
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+  /internal/v1/organizations/{orgName}/clusters/{clusterName}/reconfigure:
+    post:
+      operationId: reconfigureCluster
+      summary: Update cluster configuration
+      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:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/reconfigureCreate'
+        required: true
+      responses:
+        '202':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+          description: Accepted
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - opsrequest
+        - shared
+      x-codegen-request-body-name: body
   /internal/v1/environments/{environmentName}:
     delete:
       operationId: deleteEnvironment
@@ -705,11 +821,9 @@ paths:
           content: {}
           description: Returned when project is deleted successfully.
         '401':
-          content: {}
-          description: Unauthorized
+          $ref: '#/components/responses/401'
         '403':
-          content: {}
-          description: Forbidden
+          $ref: '#/components/responses/403'
       tags:
         - environment
   /internal/v1/status:
@@ -1289,6 +1403,56 @@ 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, nodeGroup and storageClass are optional overlays. The request must include every chart-rendered instance template exactly once. Explicit placement requires availabilityZone and optionally accepts nodeGroup, without inheriting upper-level AZ or NodeGroup. Omitting both leaves SchedulingPolicy unset for KubeBlocks default inheritance. Hostname, user scheduling rules and additional topology keys are preserved.
+      required:
+        - name
+        - replicas
+      properties:
+        nodeGroup:
+          type: string
+          description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
+        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: Single AZ for explicit template placement (topology.kubernetes.io/zone). Must be enabled in the environment and is required when nodeGroup is specified. An omitted nodeGroup does not inherit the component or cluster host group. Omitting both leaves SchedulingPolicy unset for KubeBlocks inheritance.
+        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. The apps.kubeblocks.io/instance-template label is managed by the system and must equal the template name if supplied.
     ioQuantity:
       description: IO Quantity describes IOPS and BPS of a volume
       properties:
@@ -1359,6 +1523,23 @@ components:
       type: object
       description: ComponentItem is the information of a component
       properties:
+        annotations:
+          type: object
+          additionalProperties:
+            type: string
+          description: User-provided component annotations. Does not include chart defaults or system-generated values.
+        nodeGroup:
+          type: string
+          description: Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
+        availabilityZone:
+          type: string
+          description: Explicit component AZ selection, if configured.
+        instanceTemplates:
+          type: array
+          x-omitempty: true
+          description: Instance template assignments with effective replicas, placement and storage class, and user-provided env, labels and annotations.
+          items:
+            $ref: '#/components/schemas/instanceTemplateCreate'
         name:
           type: string
           description: component name
@@ -1515,6 +1696,24 @@ components:
           description: the cluster definition of the referenced cluster.
         serviceDescriptor:
           $ref: '#/components/schemas/serviceDescriptor'
+        extraForManualInput:
+          type: object
+          additionalProperties:
+            type: string
+          description: |
+            extra fields for manual input of the serviceRef. The keys must be defined in the
+            engineoption modeServiceRef.extraForManualInput. They are mapped to helm values
+            via the corresponding helmValuePath.extraForManualInput.
+    clusterReference:
+      type: object
+      description: Cluster reference information returned by cluster detail APIs.
+      properties:
+        cluster:
+          type: string
+          description: Name of the cluster that references this cluster.
+        clusterDefinition:
+          type: string
+          description: Cluster definition of the referencing cluster.
     clusterObjectStorageConfig:
       type: object
       description: Specify the object storage config for cluster like starrocks
@@ -1734,7 +1933,7 @@ components:
           description: this list of objects (currently, object is a cluster) that uses this cluster as a serviceRef
           type: array
           items:
-            $ref: '#/components/schemas/serviceRef'
+            $ref: '#/components/schemas/clusterReference'
         objectStorageConfig:
           $ref: '#/components/schemas/clusterObjectStorageConfig'
         maintainceWindow:
@@ -2066,6 +2265,17 @@ components:
             serviceRefs of the cluster.
           items:
             $ref: '#/components/schemas/serviceRef'
+        serviceRefsUpdate:
+          type: array
+          description: |
+            ServiceRefs to update. Each serviceRef name must match an existing
+            serviceRef of the cluster, and the corresponding engine option
+            modeServiceRef.update.enable must be true. ServiceRefs that auto
+            create their ServiceDescriptor and Secret get their corresponding
+            K8s objects updated; serviceRefs with manual input must be handled
+            by each engine individually and are rejected.
+          items:
+            $ref: '#/components/schemas/serviceRef'
       description: ClusterUpdate is the payload to update a KubeBlocks cluster
     endpointList:
       required:
@@ -2077,6 +2287,144 @@ components:
           description: Items is the list of endpoint objects in the list
           items:
             $ref: '#/components/schemas/endpoint'
+    parameterProp:
+      type: object
+      required:
+        - name
+        - type
+        - needRestart
+        - immutable
+      properties:
+        name:
+          description: The name of the parameter
+          type: string
+        description:
+          description: The description of the parameter
+          type: string
+        type:
+          description: The type of the parameter value
+          type: string
+        value:
+          description: The value of the parameter, if parameter is not set in tpl, it's value equal to cue default value.
+          type: object
+        default:
+          description: The value of the parameter, if parameter is not set in tpl, it's value equal to cue default value.
+          type: object
+        needRestart:
+          description: Whether the parameter requires a restart to take effect
+          type: boolean
+        immutable:
+          description: Whether the parameter is an immutable parameter, immutable parameters cannot be modified
+          type: boolean
+        maximum:
+          description: The maximum value of the parameter
+          type: string
+        minimum:
+          description: The minimum value of the parameter
+          type: string
+        enum:
+          description: The value options of the parameter
+          type: array
+          items: {}
+        unit:
+          description: The unit of the parameter value (e.g., seconds, bytes, ms, percentage)
+          type: string
+    parameterItem:
+      type: object
+      description: With the list of parameter properties and the configuration file name
+      properties:
+        props:
+          type: array
+          description: The list of parameters properties
+          items:
+            $ref: '#/components/schemas/parameterProp'
+        additionalProps:
+          type: array
+          description: The additional properties of the parameter
+          items:
+            $ref: '#/components/schemas/parameterProp'
+        fileName:
+          description: The name of the configuration file
+          type: string
+        specName:
+          description: The name of the config spec
+          type: string
+        rawContent:
+          description: The raw content of the configuration file, return only when raw is true in the query.
+          type: string
+    parameterList:
+      description: A list of cluster parameter
+      required:
+        - engine
+        - component
+      properties:
+        engine:
+          description: Name of database engine
+          type: string
+        component:
+          description: Name of component
+          type: string
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/parameterItem'
+    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:
+        component:
+          description: component type
+          type: string
+          minLength: 1
+        configFileName:
+          description: config file name
+          type: string
+        parameters:
+          additionalProperties:
+            type: string
+          description: Specify parameters list to be updated
+          type: object
+        rawContent:
+          description: The raw content of the configuration file
+          type: string
+        schedule:
+          $ref: '#/components/schemas/taskSchedule'
+      required:
+        - component
+      type: object
+    opsRequestName:
+      description: OpsRequestName is the name of a KubeBlocks OpsRequest response
+      properties:
+        opsRequestName:
+          type: string
+        taskId:
+          type: string
+      required:
+        - taskId
+      type: object
     apiserverStatus:
       type: string
       enum: