kb-cloud-client-typescript 2.4.0-alpha.92 → 2.4.0-alpha.94

package/src/adminapi/models/placement-scope.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.
+ */
+
+
+
+/**
+ * UI placement input scope for this mode. Omitted defaults to cluster. cluster displays AZ and NodeGroup selection for the cluster. component hides cluster placement and displays selection for each component, or for each instance template when the component declares templates. This does not restrict API placement overrides.
+ * @export
+ * @enum {string}
+ */
+
+export const PlacementScope = {
+    cluster: 'cluster',
+    component: 'component'
+} as const;
+
+export type PlacementScope = typeof PlacementScope[keyof typeof PlacementScope];
+
+
+

package/src/adminapi.yaml

@@ -24122,6 +24122,131 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/object-privileges/reset:
+    get:
+      tags:
+        - account
+        - rdbms
+        - shared
+      summary: Preview clearing all MySQL account privileges
+      operationId: previewAccountPrivilegeReset
+      description: MySQL only. Clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections.
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: accountName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: subjectType
+          in: query
+          required: false
+          schema:
+            $ref: '#/components/schemas/ObjectPrivilegeSubjectType'
+          description: Native subject kind; path account name identifies the subject.
+        - name: host
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Deprecated MySQL host alias. Prefer subjectQualifiers. Do not specify host in both.
+        - name: subjectQualifiers
+          in: query
+          schema:
+            type: string
+          description: JSON identity qualifiers; MySQL host defaults to %.
+      responses:
+        '200':
+          description: Server-generated steps with connection database, in execution order
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ObjectPrivilegeResetStep'
+        '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'
+    delete:
+      tags:
+        - account
+        - rdbms
+        - shared
+      summary: Clear all MySQL account privileges
+      operationId: resetAccountPrivileges
+      description: MySQL only. Clears direct privileges at every scope (including columns, routines, dynamic privileges and grant options), explicit role memberships and PROXY grants for one exact user/host. Rejects protected accounts and servers with mandatory roles before writing. Preview does not mutate. Execution re-reads current grants; concurrent new grants can be included. Statements are not atomic; on failure refresh and preview before retrying. Existing sessions follow MySQL privilege-cache semantics; this does not lock the account or terminate connections.
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: accountName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: subjectType
+          in: query
+          required: false
+          schema:
+            $ref: '#/components/schemas/ObjectPrivilegeSubjectType'
+          description: Native subject kind; path account name identifies the subject.
+        - name: host
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Deprecated MySQL host alias. Prefer subjectQualifiers. Do not specify host in both.
+        - name: subjectQualifiers
+          in: query
+          schema:
+            type: string
+          description: JSON identity qualifiers; MySQL host defaults to %.
+      responses:
+        '204':
+          description: Privileges cleared; account and password preserved
+        '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/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/object-privileges/columns:
     get:
       tags:
@@ -30630,12 +30755,14 @@ components:
     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.
+      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
@@ -30646,7 +30773,7 @@ components:
           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.
+          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.
@@ -30674,7 +30801,7 @@ components:
           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.
+          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:
@@ -30747,6 +30874,12 @@ components:
       required:
         - component
       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.
+        availabilityZone:
+          type: string
+          description: Single AZ for explicit component placement. Must be enabled in the environment and is required when nodeGroup is specified. An omitted nodeGroup does not inherit the cluster host group. Omitting both retains cluster scheduling.
         component:
           type: string
           description: component type, refer to componentDef and support NamePrefix
@@ -31086,6 +31219,18 @@ components:
       type: object
       description: ComponentItem is the information of a component
       properties:
+        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
@@ -31431,6 +31576,9 @@ components:
         componentDef:
           description: ComponentDefinition name
           type: string
+        instanceTemplate:
+          description: Instance template name within the actual component. Omitted when no template identity is available.
+          type: string
         component:
           description: component type, refer to componentDef and support NamePrefix
           type: string
@@ -40073,6 +40221,12 @@ components:
           type: boolean
           description: whether the component supports custom secret
           x-nullable: false
+    placementScope:
+      type: string
+      description: UI placement input scope for this mode. Omitted defaults to cluster. cluster displays AZ and NodeGroup selection for the cluster. component hides cluster placement and displays selection for each component, or for each instance template when the component declares templates. This does not restrict API placement overrides.
+      enum:
+        - cluster
+        - component
     modeCompatibleKubeblocksVersion:
       type: string
       description: |
@@ -40094,7 +40248,6 @@ components:
         - env
         - annotations
         - labels
-        - availabilityZone
         - storageClass
     instanceTemplateEnv:
       type: object
@@ -40470,6 +40623,8 @@ components:
         - description
         - components
       properties:
+        placementScope:
+          $ref: '#/components/schemas/placementScope'
         name:
           type: string
         title:
@@ -47201,6 +47356,20 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/ObjectPrivilegeQualifier'
+    ObjectPrivilegeResetStep:
+      type: object
+      description: One ordered, engine-generated step of an account privilege reset.
+      required:
+        - sql
+      properties:
+        databaseName:
+          type: string
+          description: Connection database in which this statement must run. Omitted when no particular database is required, as with MySQL account-wide REVOKE. This is execution context, not the scope of objects affected by the SQL.
+        sql:
+          type: string
+          x-nullable: false
+          minLength: 1
+          description: Engine-generated SQL for display. Callers cannot submit or modify these steps for execution; reset rebuilds the plan from current grants.
     ObjectPrivilegeObject:
       type: object
       required:

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

@@ -62,6 +62,8 @@ models/http-body.ts
 models/image-registry.ts
 models/index.ts
 models/init-option-item.ts
+models/instance-template-create-env-inner.ts
+models/instance-template-create.ts
 models/io-quantity.ts
 models/ip-pool-provider.ts
 models/ip-pool-selection.ts

package/src/internalapi/models/component-item.ts

@@ -19,6 +19,9 @@ import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateCreate } from './instance-template-create';
 
 /**
  * ComponentItem is the information of a component
@@ -26,6 +29,24 @@ import type { ComponentVolumeItem } from './component-volume-item';
  * @interface ComponentItem
  */
 export interface ComponentItem {
+    /**
+     * Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
+     * @type {string}
+     * @memberof ComponentItem
+     */
+    'nodeGroup'?: string;
+    /**
+     * Explicit component AZ selection, if configured.
+     * @type {string}
+     * @memberof ComponentItem
+     */
+    'availabilityZone'?: string;
+    /**
+     * Instance template assignments with effective replicas, placement and storage class, and user-provided env, labels and annotations.
+     * @type {Array<InstanceTemplateCreate>}
+     * @memberof ComponentItem
+     */
+    'instanceTemplates'?: Array<InstanceTemplateCreate>;
     /**
      * component name
      * @type {string}

package/src/internalapi/models/index.ts

@@ -35,6 +35,8 @@ export * from './grafana-datasource-create';
 export * from './http-body';
 export * from './image-registry';
 export * from './init-option-item';
+export * from './instance-template-create';
+export * from './instance-template-create-env-inner';
 export * from './io-quantity';
 export * from './ip-pool-provider';
 export * from './ip-pool-selection';

package/src/internalapi/models/instance-template-create-env-inner.ts

@@ -0,0 +1,36 @@
+/* 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
+ * @interface InstanceTemplateCreateEnvInner
+ */
+export interface InstanceTemplateCreateEnvInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'name': string;
+    /**
+     * Plain string value only. valueFrom is not supported.
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'value': string;
+}
+

package/src/internalapi/models/instance-template-create.ts

@@ -0,0 +1,75 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateCreateEnvInner } from './instance-template-create-env-inner';
+
+/**
+ * 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.
+ * @export
+ * @interface InstanceTemplateCreate
+ */
+export interface InstanceTemplateCreate {
+    /**
+     * Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'nodeGroup'?: string;
+    /**
+     * Instance template name; must match a chart-rendered instance.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'name': string;
+    /**
+     * Replica count for this instance template.
+     * @type {number}
+     * @memberof InstanceTemplateCreate
+     */
+    'replicas': number;
+    /**
+     * 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.
+     * @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>}
+     * @memberof InstanceTemplateCreate
+     */
+    'env'?: Array<InstanceTemplateCreateEnvInner>;
+    /**
+     * Annotation map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'annotations'?: { [key: string]: string; };
+    /**
+     * 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.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'labels'?: { [key: string]: string; };
+}
+

package/src/internalapi.yaml

@@ -1373,6 +1373,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:
@@ -1443,6 +1493,18 @@ components:
       type: object
       description: ComponentItem is the information of a component
       properties:
+        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

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

@@ -764,6 +764,7 @@ models/object-privilege-object.ts
 models/object-privilege-prerequisite-check.ts
 models/object-privilege-prerequisite-status.ts
 models/object-privilege-qualifier.ts
+models/object-privilege-reset-step.ts
 models/object-privilege-snapshot.ts
 models/object-privilege-spec.ts
 models/object-privilege-subject-type.ts
@@ -852,6 +853,7 @@ models/pg-extension-available-database-schema.ts
 models/pg-extension.ts
 models/pgbench.ts
 models/phone-verification-request.ts
+models/placement-scope.ts
 models/platform-parameter-constraints.ts
 models/platform-parameter-list.ts
 models/platform-parameter.ts