kb-cloud-client-typescript 2.4.0-alpha.65 → 2.4.0-alpha.67

package/src/adminapi.yaml

@@ -116,7 +116,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars:
@@ -159,7 +159,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
     post:
@@ -208,9 +208,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '413':
-          description: Upload exceeds the configured size limit
+          $ref: '#/components/responses/413'
         '500':
           $ref: '#/components/responses/500'
       requestBody:
@@ -274,7 +274,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/download:
@@ -323,7 +323,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/distribute:
@@ -371,7 +371,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
       requestBody:
@@ -425,7 +425,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/archive:
@@ -469,7 +469,7 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          $ref: '#/components/responses/400'
+          $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/user:
@@ -4622,13 +4622,20 @@ paths:
     post:
       operationId: createParameterTemplate
       summary: Create parameter template
+      description: Create a parameter template in the target organization from an existing template. To copy a custom template from another organization, specify oriOrgName and provide a new name. Cross-organization creation only supports non-private custom source templates. The created template is always non-private; any isPrivate value in the request body is ignored.
       parameters:
-        - description: name of the Org
+        - description: Name of the target organization
           in: query
           name: orgName
           required: true
           schema:
             type: string
+        - description: 'Name of the source organization. When omitted, empty, or equal to orgName, existing creation behavior is preserved: custom templates are read from the target organization and default templates from the system organization. A different source organization requires oriPartition to be custom and name to differ from oriName. Both organizations must be active. The source may be the system organization, but the target must not be the system organization. A non-empty value containing only whitespace is invalid.'
+          in: query
+          name: oriOrgName
+          required: false
+          schema:
+            type: string
       requestBody:
         content:
           application/json:
@@ -4642,12 +4649,16 @@ paths:
               schema:
                 $ref: '#/components/schemas/paramTplListItem'
           description: create parameter template successfully
+        '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'
       tags:
         - parameterTemplate
       x-codegen-request-body-name: body
@@ -10074,6 +10085,58 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /admin/v1/environments/{environmentName}/resources/{resourceName}:
+    get:
+      operationId: getEnvironmentResource
+      summary: Get a live Kubernetes resource
+      description: Returns one named Kubernetes object, excluding metadata.managedFields. The code allowlist currently permits only apiVersion v1 with kind PersistentVolumeClaim; other valid resource types return 403 before Kubernetes access. Requires Admin environment read permission. Does not support lists, subresources or writes.
+      tags:
+        - environment
+      parameters:
+        - in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: resourceName
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: apiVersion
+          description: Kubernetes API version. Currently only v1 with kind PersistentVolumeClaim is allowed.
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: kind
+          description: Kubernetes kind. Currently only PersistentVolumeClaim with apiVersion v1 is allowed.
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: namespace
+          description: Required for namespaced kinds; must be omitted for cluster-scoped kinds.
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The live Kubernetes resource, including metadata, spec and status when present.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/jsonBody'
+        '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'
   /admin/v1/environments:
     get:
       operationId: listEnvironment
@@ -11344,6 +11407,44 @@ paths:
           $ref: '#/components/responses/404'
       tags:
         - vipPool
+    put:
+      operationId: updateVIPPool
+      summary: Update environment VIP Pool
+      parameters:
+        - description: name of the environment
+          in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+        - description: id of the VIP Pool
+          in: path
+          name: poolID
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/vipPoolUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/vipPool'
+          description: A successful response.
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - vipPool
+      x-codegen-request-body-name: body
   /admin/v1/environments/{environmentName}/storageClasses:
     get:
       description: Provides a summary of storage class statistics.
@@ -16557,7 +16658,7 @@ paths:
           description: Inspection tasks created and accepted for asynchronous execution.
           content: {}
         '400':
-          description: Invalid request, invalid cluster selection, or no eligible clusters.
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -22654,7 +22755,7 @@ paths:
                 $ref: '#/components/schemas/accountList'
           description: Success
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -22662,9 +22763,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -22701,7 +22802,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -22709,9 +22810,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -22746,7 +22847,7 @@ paths:
           content: {}
           description: Identity deleted
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -22754,9 +22855,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -22798,7 +22899,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -22806,9 +22907,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -22897,7 +22998,7 @@ paths:
         required: true
       responses:
         '400':
-          description: SeaweedFS uses the named policy binding API
+          $ref: '#/components/responses/400'
       tags:
         - account
         - seaweedfs
@@ -22946,17 +23047,17 @@ paths:
                           type: object
                           additionalProperties: true
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
   /admin/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/policies/{policyName}:
     put:
       summary: putSeaweedFSPolicy
@@ -22985,17 +23086,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -23031,17 +23132,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       description: Deletes an unused named policy. Attached policies are rejected; no identities or groups are implicitly changed.
   /admin/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/policies:
     put:
@@ -23071,17 +23172,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -23128,17 +23229,17 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -23179,17 +23280,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts:
     get:
       description: list accounts in cluster
@@ -30044,6 +30145,48 @@ components:
       enum:
         - DoNotTerminate
         - Delete
+    instanceTemplateCreate:
+      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.
+      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.
+        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:
@@ -30127,7 +30270,13 @@ components:
           title: Replicas
           type: integer
           x-nullable: true
-          description: Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas.
+          description: Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas. 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
@@ -30421,6 +30570,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:
@@ -31498,8 +31651,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:
@@ -31515,6 +31683,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:
@@ -35557,7 +35731,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'
@@ -35867,6 +36041,11 @@ components:
       required:
         - serviceName
         - serviceNamespace
+    jsonBody:
+      description: Represents a JSON body.
+      properties: {}
+      additionalProperties: true
+      type: object
     logBackendType:
       type: string
       description: Log query backend configured for this environment.
@@ -36902,11 +37081,6 @@ components:
         - items
         - updatedAt
       type: object
-    jsonBody:
-      description: Represents a JSON body.
-      properties: {}
-      additionalProperties: true
-      type: object
     instanceResourceStatsType:
       description: Type of the instance, choose cluster, system, or other
       enum:
@@ -37163,6 +37337,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
@@ -37199,6 +37381,21 @@ components:
       type: object
     vipPoolCreate:
       description: VIP Pool create
+      properties:
+        addresses:
+          description: IP Addresses
+          title: IP Addresses
+          type: string
+        poolName:
+          description: Name of the VIP Pool. It is what a cluster selects the pool by, so it is not restricted by Kubernetes resource naming rules. The MetalLB IPAddressPool resource name stays the generated kb-<id>.
+          title: Pool Name
+          type: string
+      required:
+        - addresses
+        - poolName
+      type: object
+    vipPoolUpdate:
+      description: VIP Pool update
       properties:
         addresses:
           description: IP Addresses
@@ -39235,6 +39432,39 @@ components:
       enum:
         - '0.9'
         - '1.0'
+    instanceTemplateOp:
+      type: string
+      description: Operation that can be declared on instanceTemplate.ops.
+      enum:
+        - hscale
+        - vscale
+    instanceTemplateAttribute:
+      type: string
+      description: Heterogeneous attribute the frontend may render on an instance template at create.
+      enum:
+        - env
+        - annotations
+        - labels
+    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:
@@ -39256,6 +39486,64 @@ components:
           type: boolean
         hideOnCreate:
           type: boolean
+        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.
+          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.
+            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.
+            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: |
@@ -41486,7 +41774,13 @@ components:
         modifierEmail:
           type: string
         option:
-          $ref: '#/components/schemas/engineOption'
+          description: |
+            Engine option document stored when this history row was written.
+            This is a point-in-time snapshot, not the current engineOption
+            create/update contract. Nested fields such as endpoints.protocol
+            may be absent on older rows.
+          type: object
+          additionalProperties: true
         createdAt:
           type: string
           format: date-time
@@ -50353,6 +50647,12 @@ components:
           schema:
             $ref: '#/components/schemas/APIErrorResponse'
       description: Conflict
+    '413':
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/APIErrorResponse'
+      description: Payload Too Large
     '429':
       content:
         application/json: