kb-cloud-client-typescript 2.4.0-alpha.102 → 2.4.0-alpha.104

package/src/adminapi.yaml

@@ -1663,6 +1663,107 @@ paths:
       tags:
         - organization
       x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/deletionPreview:
+    get:
+      summary: Preview organization deletion or purge
+      operationId: previewOrgDeletion
+      tags:
+        - organization
+        - shared
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: orgID
+          in: query
+          required: true
+          schema:
+            type: string
+            pattern: ^[1-9][0-9]*$
+        - name: action
+          in: query
+          required: true
+          schema:
+            $ref: '#/components/schemas/orgDeletionAction'
+      responses:
+        '200':
+          description: Read-only preview; actual mutations revalidate all conditions
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/orgDeletionPreview'
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '409':
+          $ref: '#/components/responses/409'
+  /admin/v1/organizations/{orgName}/restoreOrganization:
+    post:
+      summary: Restore organization
+      operationId: restoreOrg
+      tags:
+        - organization
+        - shared
+      parameters:
+        - in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/orgLifecycleRequest'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/org'
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '409':
+          $ref: '#/components/responses/409'
+  /admin/v1/organizations/{orgName}/purge:
+    post:
+      summary: Purge organization
+      operationId: purgeOrg
+      tags:
+        - organization
+        - shared
+      parameters:
+        - in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/orgLifecycleRequest'
+      responses:
+        '202':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/orgPurgeResult'
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '409':
+          $ref: '#/components/responses/409'
   /admin/v1/organizations/{orgName}:
     get:
       description: read the specified Org
@@ -1738,6 +1839,12 @@ paths:
           required: true
           schema:
             type: string
+        - in: query
+          name: orgID
+          required: true
+          schema:
+            type: string
+            pattern: ^[1-9][0-9]*$
       responses:
         '204':
           content: {}
@@ -10550,7 +10657,7 @@ paths:
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/expose:
     post:
       operationId: exposeCluster
-      summary: Expose cluster loadbalancer endpoint
+      summary: Expose cluster endpoint
       parameters:
         - description: name of the Org
           in: path
@@ -11694,6 +11801,107 @@ paths:
       tags:
         - environment
       x-codegen-request-body-name: body
+  /admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/settings:
+    get:
+      tags:
+        - nodeAlert
+      operationId: getNodeAlertSettings
+      summary: Get alert settings for a node in an environment
+      parameters:
+        - name: environmentName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: nodeName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertCluster'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+    patch:
+      tags:
+        - nodeAlert
+      operationId: patchNodeAlertSettings
+      summary: Update supplied node alert settings; omitted fields are preserved
+      parameters:
+        - name: environmentName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: nodeName
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/alertCluster'
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertCluster'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+  /admin/v1/environments/{environmentName}/nodes/{nodeName}/alert/rules:
+    get:
+      tags:
+        - nodeAlert
+      operationId: listNodeAlertRules
+      summary: List node metric and NodeDown event alert rules
+      parameters:
+        - name: environmentName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: nodeName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertRuleList'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /admin/v1/environments/{environmentName}/nodes/{nodeName}:
     get:
       description: Get specified node info for environment
@@ -18628,6 +18836,34 @@ paths:
           $ref: '#/components/responses/500'
       tags:
         - task
+  /admin/v1/tasks/{taskId}/abort:
+    post:
+      summary: Force abort a task
+      description: Forcefully abort a running task. Pending steps or OpsRequests are cancelled, running ones are aborted.
+      operationId: abortTask
+      parameters:
+        - description: ID of the task
+          in: path
+          name: taskId
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Task aborted successfully
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - task
   /admin/v1/tasks/{taskId}/log:
     get:
       tags:
@@ -30580,15 +30816,44 @@ components:
           description: The list of series items aggregated in the time range.
           items:
             $ref: '#/components/schemas/seriesItem'
+    orgStatus:
+      x-nullable: false
+      type: string
+      enum:
+        - Active
+        - DeletionLocked
+        - Purging
+        - PurgeFailed
+        - Deleted
     organizationItem:
       description: Organization items.
       type: object
       required:
+        - id
+        - status
+        - expiredAt
+        - allowedActions
         - name
         - displayName
         - clusterTotal
         - createdAt
       properties:
+        id:
+          x-nullable: false
+          type: string
+        status:
+          x-nullable: false
+          $ref: '#/components/schemas/orgStatus'
+        expiredAt:
+          type: string
+          format: date-time
+          nullable: true
+        purgeError:
+          type: string
+        allowedActions:
+          type: array
+          items:
+            type: string
         name:
           type: string
           description: The name of the organization.
@@ -30638,6 +30903,19 @@ components:
     org:
       description: Org info
       properties:
+        status:
+          x-nullable: false
+          $ref: '#/components/schemas/orgStatus'
+        expiredAt:
+          type: string
+          format: date-time
+          nullable: true
+        purgeError:
+          type: string
+        allowedActions:
+          type: array
+          items:
+            type: string
         createdAt:
           description: |-
             CreatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
@@ -30668,11 +30946,167 @@ components:
           description: return true if the organization is enabled
           type: boolean
       required:
+        - status
+        - expiredAt
+        - allowedActions
         - createdAt
         - name
         - updatedAt
         - enabled
       type: object
+    orgDeletionAction:
+      type: string
+      enum:
+        - delete
+        - purge
+    orgDeletionBlocker:
+      type: object
+      required:
+        - code
+        - resourceType
+        - count
+      properties:
+        code:
+          x-nullable: false
+          type: string
+        resourceType:
+          x-nullable: false
+          type: string
+        count:
+          x-nullable: false
+          type: integer
+          format: int64
+    orgConfigurationItem:
+      type: object
+      required:
+        - id
+        - displayName
+      properties:
+        id:
+          x-nullable: false
+          type: string
+        displayName:
+          x-nullable: false
+          type: string
+    orgConfigurationSummary:
+      type: object
+      required:
+        - type
+        - count
+        - items
+        - truncated
+        - actionEffect
+        - purgeEffect
+      properties:
+        type:
+          x-nullable: false
+          type: string
+        count:
+          x-nullable: false
+          type: integer
+          format: int64
+        items:
+          x-nullable: false
+          type: array
+          items:
+            $ref: '#/components/schemas/orgConfigurationItem'
+        truncated:
+          x-nullable: false
+          type: boolean
+        actionEffect:
+          x-nullable: false
+          type: string
+        purgeEffect:
+          x-nullable: false
+          type: string
+    orgRetainedResource:
+      type: object
+      required:
+        - type
+        - count
+        - retentionPolicy
+      properties:
+        type:
+          x-nullable: false
+          type: string
+        count:
+          x-nullable: false
+          type: integer
+          format: int64
+        retentionPolicy:
+          x-nullable: false
+          type: string
+    orgDeletionPreview:
+      type: object
+      required:
+        - orgID
+        - name
+        - status
+        - expiredAt
+        - action
+        - canProceed
+        - blockers
+        - configurations
+        - retainedResources
+      properties:
+        orgID:
+          x-nullable: false
+          type: string
+        name:
+          x-nullable: false
+          type: string
+        status:
+          x-nullable: false
+          type: string
+        expiredAt:
+          type: string
+          format: date-time
+          nullable: true
+        purgeError:
+          type: string
+        action:
+          x-nullable: false
+          type: string
+        canProceed:
+          x-nullable: false
+          type: boolean
+        blockers:
+          x-nullable: false
+          type: array
+          items:
+            $ref: '#/components/schemas/orgDeletionBlocker'
+        configurations:
+          x-nullable: false
+          type: array
+          items:
+            $ref: '#/components/schemas/orgConfigurationSummary'
+        retainedResources:
+          x-nullable: false
+          type: array
+          items:
+            $ref: '#/components/schemas/orgRetainedResource'
+    orgLifecycleRequest:
+      type: object
+      required:
+        - orgID
+        - expectedExpiredAt
+      properties:
+        orgID:
+          type: string
+          pattern: ^[1-9][0-9]*$
+        expectedExpiredAt:
+          type: string
+          format: date-time
+    orgPurgeResult:
+      type: object
+      properties:
+        orgID:
+          type: string
+        status:
+          type: string
+        expiredAt:
+          type: string
+          format: date-time
     orgUpdate:
       description: Organization update
       properties:
@@ -31823,6 +32257,11 @@ components:
       required:
         - component
       properties:
+        annotations:
+          type: object
+          additionalProperties:
+            type: string
+          description: User-provided component annotations, merged over chart defaults. Platform-managed keys cannot be overridden. Omitted or empty preserves defaults; empty string values are literal values, not deletions.
         nodeGroup:
           type: string
           description: Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
@@ -32168,6 +32607,11 @@ 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.
@@ -37381,10 +37825,11 @@ components:
       type: object
     opsExposeType:
       type: string
-      description: Specifies the type of exposure for the KubeBlocks cluster.
+      description: Specifies the type of exposure for the KubeBlocks cluster. Internal exposure creates an internal-ro ClusterIP service and requires readonly=true; it is independent of vpc and internet exposure.
       enum:
         - vpc
         - internet
+        - internal
     opsExposeVPCServiceType:
       description: Specifies the type of service for the KubeBlocks cluster.
       enum:
@@ -37401,10 +37846,12 @@ components:
         enable:
           type: boolean
         readonly:
+          description: Select the configured read-only role. Must be true for internal exposure.
           type: boolean
         type:
           $ref: '#/components/schemas/opsExposeType'
         vpcServiceType:
+          description: Service type for vpc exposure. Omit for internal exposure, which always uses ClusterIP.
           $ref: '#/components/schemas/opsExposeVPCServiceType'
         portsMapping:
           type: array
@@ -38808,6 +39255,142 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/koordinatorReservationSummaryItem'
+    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:
+        - 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 alerts for the resource.
+          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: Resource-scoped alert settings, shared by cluster and node endpoints. PATCH updates only supplied fields. Cluster settings apply to both tenant and administrator notifications.
+      properties:
+        disabled:
+          type: boolean
+          x-nullable: true
+          description: Disable all alerts for the resource. Existing rule and silence settings are preserved.
+        disabledRules:
+          type: array
+          maxItems: 1000
+          x-omitempty: false
+          description: Alert names disabled only for this resource. 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.
+    alertSeverity:
+      enum:
+        - critical
+        - warning
+        - info
+      type: string
+    alertRule:
+      required:
+        - alertName
+        - for
+        - groupName
+        - severity
+      type: object
+      properties:
+        description:
+          type: string
+        summary:
+          type: string
+        alertName:
+          type: string
+        expr:
+          type: string
+          description: Expression. Required if metric is not provided.
+        for:
+          type: string
+        groupName:
+          type: string
+        disabled:
+          type: boolean
+          default: false
+        severity:
+          $ref: '#/components/schemas/alertSeverity'
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+        orgName:
+          type: string
+      description: Alert rule information. Either provide 'expr' for custom expressions, or 'metric' for predefined metrics.
+    alertRuleGroup:
+      type: object
+      properties:
+        name:
+          type: string
+        rules:
+          type: array
+          items:
+            $ref: '#/components/schemas/alertRule'
+    alertRuleList:
+      required:
+        - items
+      type: object
+      properties:
+        items:
+          type: array
+          description: Items is the list of alert rule objects in the list
+          items:
+            $ref: '#/components/schemas/alertRuleGroup'
+        pageResult:
+          $ref: '#/components/schemas/pageResult'
+      description: AlertRuleList is a list of alert rules
     listBody:
       description: Represents a list of JSON bodies.
       items:
@@ -40468,7 +41051,7 @@ components:
         cluster:
           $ref: '#/components/schemas/clusterCreate'
         restoreTimeStr:
-          description: restoreTime point to restore
+          description: Target time for point-in-time recovery, only supported with a Continuous backup ID. Use an RFC3339 timestamp at whole-second precision, for example 2026-10-22T08:30:00Z or 2026-10-22T16:30:00+08:00. Timezone offsets are converted to UTC without changing the instant. Non-zero fractional seconds and UTC years outside 0000-9999 are rejected. Omit or leave empty to retain the backup method's default restore behavior.
           type: string
         doReadyRestoreAfterClusterRunning:
           description: the recovery process in the PostReady phase will be performed after the cluster is running successfully.
@@ -40554,142 +41137,6 @@ components:
       required:
         - items
       type: object
-    alertSeverity:
-      enum:
-        - critical
-        - warning
-        - info
-      type: string
-    alertRule:
-      required:
-        - alertName
-        - for
-        - groupName
-        - severity
-      type: object
-      properties:
-        description:
-          type: string
-        summary:
-          type: string
-        alertName:
-          type: string
-        expr:
-          type: string
-          description: Expression. Required if metric is not provided.
-        for:
-          type: string
-        groupName:
-          type: string
-        disabled:
-          type: boolean
-          default: false
-        severity:
-          $ref: '#/components/schemas/alertSeverity'
-        createdAt:
-          type: string
-          format: date-time
-        updatedAt:
-          type: string
-          format: date-time
-        orgName:
-          type: string
-      description: Alert rule information. Either provide 'expr' for custom expressions, or 'metric' for predefined metrics.
-    alertRuleGroup:
-      type: object
-      properties:
-        name:
-          type: string
-        rules:
-          type: array
-          items:
-            $ref: '#/components/schemas/alertRule'
-    alertRuleList:
-      required:
-        - items
-      type: object
-      properties:
-        items:
-          type: array
-          description: Items is the list of alert rule objects in the list
-          items:
-            $ref: '#/components/schemas/alertRuleGroup'
-        pageResult:
-          $ref: '#/components/schemas/pageResult'
-      description: AlertRuleList is a list of alert rules
-    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:
-        - 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.
     URLCheck:
       type: object
       required:
@@ -41142,6 +41589,10 @@ components:
           description: Main component flag
           type: boolean
           x-nullable: false
+        customAnnotations:
+          type: boolean
+          description: Whether to show the component annotations editor during cluster creation. Omitted or false hides the editor. This is a UI visibility hint and does not restrict the cluster creation API. Applies to this component in every engine mode, including sharding templates, on KubeBlocks 0.9 and 1.0.
+          x-nullable: false
         customSecret:
           type: boolean
           description: whether the component supports custom secret
@@ -43422,6 +43873,16 @@ components:
               description: Allowed engine license types. Omit to retain unrestricted license types.
               items:
                 type: string
+            versions:
+              type: array
+              description: Engine versions that support license installation. Entries match an exact service version or its major version according to the main component version rule. Omit or leave empty for unrestricted versions.
+              items:
+                type: string
+            networkModes:
+              type: array
+              description: Effective cluster network modes that support license installation. Omit or leave empty for unrestricted network modes.
+              items:
+                $ref: '#/components/schemas/networkMode'
             files:
               type: array
               description: Explicit license file upload slots. Each item maps one UI upload field to the file name written into the license Secret.
@@ -45631,6 +46092,7 @@ components:
         - Failed
         - Cancelling
         - Cancelled
+        - Aborted
       description: Current status of the task
     taskListItem:
       type: object