kb-cloud-client-typescript 2.3.40 → 2.3.42

package/src/openapi/models/alert-cluster-silence.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AlertClusterSilenceMode } from './alert-cluster-silence-mode';
+
+/**
+ * Pause notifications while continuing to record alerts. Set enabled to false to cancel. Time windows include their start and exclude their end.
+ * @export
+ * @interface AlertClusterSilence
+ */
+export interface AlertClusterSilence {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AlertClusterSilence
+     */
+    'enabled': boolean;
+    /**
+     * Alert names to silence. Empty or omitted means all cluster alerts.
+     * @type {Array<string>}
+     * @memberof AlertClusterSilence
+     */
+    'rules'?: Array<string>;
+    /**
+     * 
+     * @type {AlertClusterSilenceMode}
+     * @memberof AlertClusterSilence
+     */
+    'mode'?: AlertClusterSilenceMode;
+    /**
+     * Required for once. Absolute start of the silence window.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'startsAt'?: string;
+    /**
+     * Required for once. Must be later than startsAt.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'endsAt'?: string;
+    /**
+     * Required for weekly. Sunday is 0. Overnight windows belong to the weekday on which they start.
+     * @type {Array<number>}
+     * @memberof AlertClusterSilence
+     */
+    'weekdays'?: Array<number>;
+    /**
+     * Required for weekly, in HH:mm format.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'startTime'?: string;
+    /**
+     * Required for weekly, in HH:mm format. Earlier than startTime means the following day; equal times are invalid.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'endTime'?: string;
+    /**
+     * Required for weekly. IANA timezone, e.g. Asia/Shanghai or UTC.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'timeZone'?: string;
+}
+
+
+

package/src/openapi/models/alert-cluster.ts

@@ -13,18 +13,39 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AlertClusterSilence } from './alert-cluster-silence';
 
 /**
- * 
+ * Cluster-scoped alert settings. PATCH updates only supplied fields; settings apply to both tenant and administrator notifications.
  * @export
  * @interface AlertCluster
  */
 export interface AlertCluster {
+    /**
+     * Disable all cluster alerts. Existing rule and silence settings are preserved.
+     * @type {boolean}
+     * @memberof AlertCluster
+     */
+    'disabled'?: boolean | null;
+    /**
+     * Alert names disabled only for this cluster. An empty array clears all rule overrides; omission preserves them.
+     * @type {Array<string>}
+     * @memberof AlertCluster
+     */
+    'disabledRules'?: Array<string>;
     /**
      * 
+     * @type {AlertClusterSilence}
+     * @memberof AlertCluster
+     */
+    'silence'?: AlertClusterSilence;
+    /**
+     * Whether the configured silence window is active now, regardless of the alert master switch.
      * @type {boolean}
      * @memberof AlertCluster
      */
-    'disabled': boolean;
+    'silenceActive'?: boolean;
 }
 

package/src/openapi/models/component-item-create.ts

@@ -42,13 +42,13 @@ export interface ComponentItemCreate {
      */
     'compNum'?: number;
     /**
-     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
+     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. When instanceTemplates is provided, this must equal the sum of all template replica counts.
      * @type {number}
      * @memberof ComponentItemCreate
      */
     'replicas'?: number;
     /**
-     * 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.
+     * Per-template replicas and optional overlays (env, annotations, labels, availability zone, storage class). Required when the current mode component declares instanceTemplate in engine_options; otherwise omit. 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.
      * @type {Array<InstanceTemplateCreate>}
      * @memberof ComponentItemCreate
      */

package/src/openapi/models/component-option-version-blocked-upgrade-from-inner.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * One upgrade restriction while the cluster runs a service version matching from, upgrading to a service version matching to is not allowed.
+ * @export
+ * @interface ComponentOptionVersionBlockedUpgradeFromInner
+ */
+export interface ComponentOptionVersionBlockedUpgradeFromInner {
+    /**
+     * Pattern of the service version the cluster currently runs. Supports exact version \"7.4.7\", version prefix \"7.4\", and comparisons \">=7.4.5\", \">7.4.4\", \"<=7.4.7\", \"<7.4.8\".
+     * @type {string}
+     * @memberof ComponentOptionVersionBlockedUpgradeFromInner
+     */
+    'from': string;
+    /**
+     * Pattern of the service version the upgrade is blocked to, with the same syntax as from. Omit to block every upgrade target, which makes from the end of the line for the component.
+     * @type {string}
+     * @memberof ComponentOptionVersionBlockedUpgradeFromInner
+     */
+    'to'?: string;
+}
+

package/src/openapi/models/component-option-version.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ComponentOptionVersionBlockedUpgradeFromInner } from './component-option-version-blocked-upgrade-from-inner';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentOptionVersionMajorVersion } from './component-option-version-major-version';
@@ -53,5 +56,11 @@ export interface ComponentOptionVersion {
      * @memberof ComponentOptionVersion
      */
     'architecture'?: ComponentVersionArchitecture | null;
+    /**
+     * Upgrades that must not be offered or accepted for this component, keyed by the service version the cluster currently runs. Use it when a target version is not a drop-in replacement for a source version, for example when the source image ships modules the target image no longer carries. Upgrades matching no rule stay untouched.
+     * @type {Array<ComponentOptionVersionBlockedUpgradeFromInner>}
+     * @memberof ComponentOptionVersion
+     */
+    'blockedUpgradeFrom'?: Array<ComponentOptionVersionBlockedUpgradeFromInner>;
 }
 

package/src/openapi/models/index.ts

@@ -41,6 +41,8 @@ export * from './ai-agent-turn-action';
 export * from './ai-agent-turn-action-list';
 export * from './ai-agent-turn-status';
 export * from './alert-cluster';
+export * from './alert-cluster-silence';
+export * from './alert-cluster-silence-mode';
 export * from './alert-config';
 export * from './alert-inhibit';
 export * from './alert-inhibit-list';
@@ -208,6 +210,7 @@ export * from './component-ops-option-dependent-custom-ops-params-inner';
 export * from './component-ops-option-restore-env-inner';
 export * from './component-option';
 export * from './component-option-version';
+export * from './component-option-version-blocked-upgrade-from-inner';
 export * from './component-option-version-major-version';
 export * from './component-option-version-major-version-version-mapping-inner';
 export * from './component-option-version-minor-version';

package/src/openapi/models/mode-component-instance-template.ts

@@ -24,19 +24,19 @@ import type { InstanceTemplateEnv } from './instance-template-env';
 import type { InstanceTemplateOp } from './instance-template-op';
 
 /**
- * Template fields and operations shared by the frontend and backend. Declaring storageExpansion in ops requires explicit volume expansion targets for every name. Components without this capability use component-level expansion. 
+ * Template fields and operations shared by the frontend and backend. Requested components require creation template targets when instanceTemplate is declared. Declaring hscale or storageExpansion in ops requires explicit targets for every name. The hscale requirement applies to replica scaling only. 
  * @export
  * @interface ModeComponentInstanceTemplate
  */
 export interface ModeComponentInstanceTemplate {
     /**
-     * Instance template names the frontend should render. Create and hscale check names against the chart or live Cluster, not this list. Explicit volume expansion targets must include every name in this list. 
+     * Instance template names the frontend should render. Create checks names against the chart. Replica hscale and volume expansion targets must include every name in this list. 
      * @type {Set<string>}
      * @memberof ModeComponentInstanceTemplate
      */
     'names': Set<string>;
     /**
-     * Template operations: hscale, storageExpansion, and reserved vscale. Explicit volume expansion targets must match component volume names and target capacities. 
+     * Template operations: hscale, storageExpansion, and reserved vscale. Template hscale replicas must sum to the component target. Volume expansion targets must match component volume names and capacities. 
      * @type {Array<InstanceTemplateOp>}
      * @memberof ModeComponentInstanceTemplate
      */

package/src/openapi/models/ops-hscale.ts

@@ -21,7 +21,7 @@ import type { InstanceTemplateReplicas } from './instance-template-replicas';
 import type { TaskSchedule } from './task-schedule';
 
 /**
- * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. instanceTemplates is an optional overlay and requires top-level replicas.
+ * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. Replica scaling requires explicit template targets when the current mode component declares instanceTemplate.ops hscale.
  * @export
  * @interface OpsHScale
  */
@@ -45,7 +45,7 @@ export interface OpsHScale {
      */
     'replicas'?: number | null;
     /**
-     * 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.
+     * Explicit template replica targets, required when the current mode component instanceTemplate.ops includes hscale. Otherwise omit for component-level scaling. Requires top-level replicas and every name from instanceTemplate.names, without missing, extra, or duplicate names. Template replica counts must sum to the component target; equal distribution is not required by the API. Component and template changes are sent together in one OpsRequest using current Cluster replicas to calculate scaleIn/scaleOut deltas. Shard-count scaling cannot include this list.
      * @type {Array<InstanceTemplateReplicas>}
      * @memberof OpsHScale
      */

package/src/openapi.yaml

@@ -3687,6 +3687,14 @@ paths:
           name: instanceName
           schema:
             type: string
+        - in: query
+          name: query
+          schema:
+            type: string
+        - in: query
+          name: filename
+          schema:
+            type: string
         - in: query
           name: sortType
           schema:
@@ -4351,6 +4359,8 @@ paths:
         - $ref: '#/components/parameters/limit'
         - $ref: '#/components/parameters/componentName'
         - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/query'
+        - $ref: '#/components/parameters/filename'
         - $ref: '#/components/parameters/sortType'
       responses:
         '200':
@@ -9520,13 +9530,46 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /api/v1/organizations/{orgName}/alerts/cluster/{clusterName}/rules:
+    get:
+      tags:
+        - clusterAlertSwitch
+        - shared
+      operationId: listClusterAlertRules
+      summary: List applicable alert rules for a cluster
+      parameters:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: clusterName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertRuleList'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /api/v1/organizations/{orgName}/alerts/cluster/{clusterName}:
     get:
       tags:
         - clusterAlertSwitch
         - shared
       operationId: getClusterAlertDisabled
-      summary: Check if cluster alert is disabled
+      summary: Get cluster alert settings
       parameters:
         - name: orgName
           in: path
@@ -9558,7 +9601,7 @@ paths:
         - clusterAlertSwitch
         - shared
       operationId: setClusterAlertDisabled
-      summary: Set cluster alert disabled or enabled
+      summary: Update cluster alert settings
       parameters:
         - name: orgName
           in: path
@@ -25598,11 +25641,11 @@ components:
         replicas:
           title: Replicas
           type: integer
-          description: The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
+          description: The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. When instanceTemplates is provided, this must equal the sum of all template replica counts.
         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.
+          description: Per-template replicas and optional overlays (env, annotations, labels, availability zone, storage class). Required when the current mode component declares instanceTemplate in engine_options; otherwise omit. 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:
@@ -26528,7 +26571,7 @@ components:
           minimum: 0
           description: Target replica count for this instance template.
     opsHScale:
-      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.
+      description: OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. Replica scaling requires explicit template targets when the current mode component declares instanceTemplate.ops hscale.
       required:
         - component
       properties:
@@ -26547,7 +26590,7 @@ components:
         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.
+          description: Explicit template replica targets, required when the current mode component instanceTemplate.ops includes hscale. Otherwise omit for component-level scaling. Requires top-level replicas and every name from instanceTemplate.names, without missing, extra, or duplicate names. Template replica counts must sum to the component target; equal distribution is not required by the API. Component and template changes are sent together in one OpsRequest using current Cluster replicas to calculate scaleIn/scaleOut deltas. Shard-count scaling cannot include this list.
           items:
             $ref: '#/components/schemas/instanceTemplateReplicas'
         onlineInstancesToOffline:
@@ -32451,13 +32494,79 @@ components:
           format: date-time
           description: response generation time
       description: Cluster alert summary
-    alertCluster:
+    alertClusterSilenceMode:
+      type: string
+      enum:
+        - once
+        - weekly
+      description: Required when enabled. Once uses absolute timestamps; weekly uses weekdays and local times in timeZone.
+    alertClusterSilence:
+      type: object
       required:
-        - disabled
+        - enabled
+      description: Pause notifications while continuing to record alerts. Set enabled to false to cancel. Time windows include their start and exclude their end.
+      properties:
+        enabled:
+          type: boolean
+        rules:
+          type: array
+          maxItems: 1000
+          description: Alert names to silence. Empty or omitted means all cluster alerts.
+          items:
+            type: string
+            minLength: 1
+            maxLength: 255
+        mode:
+          $ref: '#/components/schemas/alertClusterSilenceMode'
+        startsAt:
+          type: string
+          format: date-time
+          description: Required for once. Absolute start of the silence window.
+        endsAt:
+          type: string
+          format: date-time
+          description: Required for once. Must be later than startsAt.
+        weekdays:
+          type: array
+          maxItems: 7
+          description: Required for weekly. Sunday is 0. Overnight windows belong to the weekday on which they start.
+          items:
+            type: integer
+            minimum: 0
+            maximum: 6
+        startTime:
+          type: string
+          description: Required for weekly, in HH:mm format.
+        endTime:
+          type: string
+          description: Required for weekly, in HH:mm format. Earlier than startTime means the following day; equal times are invalid.
+        timeZone:
+          type: string
+          maxLength: 100
+          description: Required for weekly. IANA timezone, e.g. Asia/Shanghai or UTC.
+    alertCluster:
       type: object
+      description: Cluster-scoped alert settings. PATCH updates only supplied fields; settings apply to both tenant and administrator notifications.
       properties:
         disabled:
           type: boolean
+          x-nullable: true
+          description: Disable all cluster alerts. Existing rule and silence settings are preserved.
+        disabledRules:
+          type: array
+          maxItems: 1000
+          x-omitempty: false
+          description: Alert names disabled only for this cluster. An empty array clears all rule overrides; omission preserves them.
+          items:
+            type: string
+            minLength: 1
+            maxLength: 255
+        silence:
+          $ref: '#/components/schemas/alertClusterSilence'
+        silenceActive:
+          type: boolean
+          readOnly: true
+          description: Whether the configured silence window is active now, regardless of the alert master switch.
     alertConfig:
       required:
         - timeZoneOffset
@@ -32781,6 +32890,21 @@ components:
                           type: string
             architecture:
               $ref: '#/components/schemas/componentVersionArchitecture'
+            blockedUpgradeFrom:
+              type: array
+              description: Upgrades that must not be offered or accepted for this component, keyed by the service version the cluster currently runs. Use it when a target version is not a drop-in replacement for a source version, for example when the source image ships modules the target image no longer carries. Upgrades matching no rule stay untouched.
+              items:
+                type: object
+                description: One upgrade restriction while the cluster runs a service version matching from, upgrading to a service version matching to is not allowed.
+                required:
+                  - from
+                properties:
+                  from:
+                    type: string
+                    description: Pattern of the service version the cluster currently runs. Supports exact version "7.4.7", version prefix "7.4", and comparisons ">=7.4.5", ">7.4.4", "<=7.4.7", "<7.4.8".
+                  to:
+                    type: string
+                    description: Pattern of the service version the upgrade is blocked to, with the same syntax as from. Omit to block every upgrade target, which makes from the end of the line for the component.
         main:
           description: Main component flag
           type: boolean
@@ -32857,8 +32981,9 @@ components:
           type: object
           description: |
             Template fields and operations shared by the frontend and backend.
-            Declaring storageExpansion in ops requires explicit volume expansion targets
-            for every name. Components without this capability use component-level expansion.
+            Requested components require creation template targets when instanceTemplate is declared.
+            Declaring hscale or storageExpansion in ops requires explicit targets
+            for every name. The hscale requirement applies to replica scaling only.
           required:
             - names
             - ops
@@ -32871,8 +32996,8 @@ components:
                 type: string
               description: |
                 Instance template names the frontend should render.
-                Create and hscale check names against the chart or live Cluster,
-                not this list. Explicit volume expansion targets must include every name in this list.
+                Create checks names against the chart. Replica hscale and volume expansion
+                targets must include every name in this list.
             ops:
               type: array
               minItems: 1
@@ -32880,8 +33005,8 @@ components:
                 $ref: '#/components/schemas/instanceTemplateOp'
               description: |
                 Template operations: hscale, storageExpansion, and reserved vscale.
-                Explicit volume expansion targets must match component volume names
-                and target capacities.
+                Template hscale replicas must sum to the component target.
+                Volume expansion targets must match component volume names and capacities.
             attributes:
               type: array
               uniqueItems: true