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

package/src/openapi.yaml

@@ -1343,6 +1343,107 @@ paths:
       tags:
         - organization
       x-codegen-request-body-name: body
+  /api/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'
+  /api/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'
+  /api/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'
   /api/v1/organizations/{orgName}:
     get:
       description: read the specified Org
@@ -1418,6 +1519,12 @@ paths:
           required: true
           schema:
             type: string
+        - in: query
+          name: orgID
+          required: true
+          schema:
+            type: string
+            pattern: ^[1-9][0-9]*$
       responses:
         '204':
           content: {}
@@ -5681,7 +5788,7 @@ paths:
   /api/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
@@ -10342,6 +10449,124 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /api/v1/organizations/{orgName}/alerts/resource/{resourceType}/{resourceID}/rules:
+    get:
+      tags:
+        - alertRule
+        - shared
+      operationId: listResourceAlertRules
+      summary: List applicable alert rules for a resource
+      parameters:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - name: resourceType
+          in: path
+          description: resourceType
+          required: true
+          schema:
+            $ref: '#/components/schemas/alertResourceType'
+        - name: resourceID
+          in: path
+          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/resource/{resourceType}/{resourceID}:
+    get:
+      tags:
+        - alertRule
+        - shared
+      operationId: getResourceAlertDisabled
+      summary: Get resource alert settings
+      parameters:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - name: resourceType
+          in: path
+          description: resourceType
+          required: true
+          schema:
+            $ref: '#/components/schemas/alertResourceType'
+        - name: resourceID
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertCluster'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+    patch:
+      tags:
+        - alertRule
+        - shared
+      operationId: setResourceAlertDisabled
+      summary: Update resource alert settings
+      parameters:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - name: resourceType
+          in: path
+          description: resourceType
+          required: true
+          schema:
+            $ref: '#/components/schemas/alertResourceType'
+        - name: resourceID
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/alertCluster'
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/alertCluster'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /api/v1/organizations/{orgName}/alerts/config:
     get:
       tags:
@@ -10966,6 +11191,40 @@ paths:
           $ref: '#/components/responses/500'
       tags:
         - task
+  /api/v1/organizations/{orgName}/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:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - 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
   /api/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}:
     get:
       tags:
@@ -22159,11 +22418,13 @@ paths:
             type: string
         - name: after
           in: query
+          description: Raw action cursor from the preceding response's nextCursor.
           required: false
           schema:
             type: string
         - name: limit
           in: query
+          description: Raw action page budget. The last turn is read in full before coalescing; use hasMore and nextCursor rather than the returned item count.
           required: false
           schema:
             type: integer
@@ -25168,9 +25429,31 @@ components:
         - description
         - createAt
       type: object
+    orgStatus:
+      x-nullable: false
+      type: string
+      enum:
+        - Active
+        - DeletionLocked
+        - Purging
+        - PurgeFailed
+        - Deleted
     userOrg:
       description: UserOrg is the payload for user organization
       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
         orgId:
           description: The ID of the organization
           type: string
@@ -25187,6 +25470,9 @@ components:
           description: The description of the organization
           type: string
       required:
+        - status
+        - expiredAt
+        - allowedActions
         - orgId
         - role
         - name
@@ -25222,6 +25508,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.
@@ -25252,11 +25551,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:
@@ -27284,6 +27739,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.
@@ -27616,6 +28076,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.
@@ -29332,10 +29797,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:
@@ -29352,10 +29818,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
@@ -33388,7 +33856,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.
@@ -34185,7 +34653,7 @@ components:
         rules:
           type: array
           maxItems: 1000
-          description: Alert names to silence. Empty or omitted means all cluster alerts.
+          description: Alert names to silence. Empty or omitted means all alerts for the resource.
           items:
             type: string
             minLength: 1
@@ -34220,17 +34688,17 @@ components:
           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.
+      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 cluster alerts. Existing rule and silence settings are preserved.
+          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 cluster. An empty array clears all rule overrides; omission preserves them.
+          description: Alert names disabled only for this resource. An empty array clears all rule overrides; omission preserves them.
           items:
             type: string
             minLength: 1
@@ -34241,6 +34709,11 @@ components:
           type: boolean
           readOnly: true
           description: Whether the configured silence window is active now, regardless of the alert master switch.
+    alertResourceType:
+      type: string
+      enum:
+        - cluster
+        - channel
     alertConfig:
       required:
         - timeZoneOffset
@@ -34583,6 +35056,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
@@ -36863,6 +37340,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.
@@ -37037,6 +37524,7 @@ components:
         - Failed
         - Cancelling
         - Cancelled
+        - Aborted
       description: Current status of the task
     taskListItem:
       type: object
@@ -42597,6 +43085,12 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/aiAgentTurnAction'
+        nextCursor:
+          type: string
+          description: Raw action cursor for the next page; independent of coalesced item IDs and timestamps.
+        hasMore:
+          type: boolean
+          description: Whether more actions are available. Pages finish the last turn before coalescing, so item counts must not be used to detect the final page.
     aiAgentEvent:
       type: object
       required:
@@ -44293,10 +44787,10 @@ components:
           type: integer
           format: int64
           x-nullable: true
-          description: Weighted health score from 0 to 100 over evaluable inspection items only. Unknown results and items with info importance are excluded from both the numerator and denominator. The field is omitted when no item is evaluable; a present value of 0 is a valid evaluated score.
+          description: Weighted health score from 0 to 100 over evaluable inspection items only. Unknown results and items with info importance are excluded from both the numerator and denominator. The field is omitted when no item is evaluable. Doris and SelectDB also omit it when risk-check evidence is unavailable, and score correlated findings once per failure family. A present value of 0 is a valid evaluated score.
         result:
           type: string
-          description: Task health conclusion derived from evaluable item states and criticality-aware score caps. Valid conclusions are red, yellow, green, and unknown. Unknown means no item is evaluable. Unknown items remain visible in the item list but do not override a red, yellow, or green conclusion derived from evaluable items.
+          description: Task health conclusion derived from evaluable item states and criticality-aware score caps. Valid conclusions are red, yellow, green, and unknown. Unknown means no item is evaluable, or a Doris/SelectDB inspection has unavailable risk-check evidence without an observed red or yellow finding. Unavailable evidence never hides an observed red or yellow finding.
         latestRunAt:
           format: date-time
           type: string