kb-cloud-client-typescript 2.4.0-alpha.50 → 2.4.0-alpha.51

package/src/adminapi.yaml

@@ -26219,6 +26219,695 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /admin/v1/replication/channel:
+    get:
+      operationId: listAdminDataChannels
+      summary: List Data Channels
+      description: Retrieve a list of data channels.
+      parameters:
+        - description: The Name of the organization
+          in: query
+          name: orgName
+          required: false
+          schema:
+            type: string
+        - description: The name of the data channel
+          in: query
+          name: name
+          required: false
+          schema:
+            type: string
+        - description: The status of the data channel
+          in: query
+          name: status
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataChannelList'
+          description: A list of data channels.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/{channelID}:
+    get:
+      operationId: getDataChannel
+      summary: Get Data Channel Details
+      description: Retrieve a data channel detail.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataChannelDetail'
+          description: A detail of data channel.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    delete:
+      operationId: deleteDataChannel
+      summary: Delete a data channel
+      description: Delete a data channel.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when channel is deleted successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    patch:
+      operationId: updateDataChannel
+      summary: Update a data channel
+      description: Update a new data channel.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/dataReplicationUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataChannelResponse'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+      x-codegen-request-body-name: body
+  /admin/v1/checks:
+    get:
+      operationId: listAdminDataChecks
+      summary: List Data Checks
+      description: Retrieve a list of standalone data checks.
+      parameters:
+        - description: The Name of the organization
+          in: query
+          name: orgName
+          required: false
+          schema:
+            type: string
+        - description: The name of the check
+          in: query
+          name: name
+          required: false
+          schema:
+            type: string
+        - description: The status of the check
+          in: query
+          name: status
+          required: false
+          schema:
+            type: array
+            items:
+              type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataCheckList'
+          description: A list of checks.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/checks/{checkID}:
+    get:
+      operationId: getDataCheck
+      summary: Get Data Check
+      description: Retrieve a standalone data check detail.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the check
+          in: path
+          name: checkID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataCheckItem'
+          description: A check detail.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    delete:
+      operationId: deleteDataCheck
+      summary: Delete a data check
+      description: Delete a standalone data check and its runtime resources.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the check
+          in: path
+          name: checkID
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when check is deleted successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/checks/{checkID}/details:
+    get:
+      operationId: getDataCheckDetails
+      summary: Get Data Check Difference Details
+      description: Read typed check miss or diff details from the latest parsed check result.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the check
+          in: path
+          name: checkID
+          required: true
+          schema:
+            type: string
+        - description: The detail type
+          in: query
+          name: type
+          required: true
+          schema:
+            $ref: '#/components/schemas/dataCheckDetailType'
+        - description: Source schema or database. Required for snapshot checks.
+          in: query
+          name: schema
+          required: false
+          schema:
+            type: string
+        - description: Source table. Required for snapshot checks.
+          in: query
+          name: table
+          required: false
+          schema:
+            type: string
+        - description: Struct object key. Optional for struct checks; omitted to page all struct details.
+          in: query
+          name: key
+          required: false
+          schema:
+            type: string
+        - description: Page number for pagination.
+          in: query
+          name: page
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            default: 1
+        - description: Number of items per page.
+          in: query
+          name: pageSize
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 1000
+            default: 100
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataCheckDetails'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
+    get:
+      operationId: getDataCheckSQLLogs
+      summary: Get Data Check SQL Logs
+      description: Read raw SQL lines emitted by check sql_logger entries.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the check
+          in: path
+          name: checkID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            text/plain:
+              schema:
+                type: string
+          description: Raw SQL lines.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/{channelID}/ops/{opsType}:
+    post:
+      operationId: createDataChannelOps
+      summary: Create a new data channel ops
+      description: Create a new data channel ops.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+        - description: The operation type
+          in: path
+          name: opsType
+          required: true
+          schema:
+            $ref: '#/components/schemas/dataReplicationOpsType'
+      responses:
+        '204':
+          content: {}
+          description: Returned when operation is completed successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/{channelID}/events:
+    get:
+      operationId: listDataChannelEvents
+      summary: List Data Channel Events
+      description: Retrieve a list of data channel events.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataReplicationEventList'
+          description: A list of data channel events.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/objects:
+    post:
+      operationId: queryReplicationObject
+      summary: query replication object
+      description: query replication object.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/replicationObjectQuery'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/replicationObjectTree'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '501':
+          $ref: '#/components/responses/501'
+      tags:
+        - dataReplication
+      x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/replication/channel/precheck:
+    post:
+      operationId: createPreCheck
+      summary: create pre check
+      description: create pre check.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/preCheckCreate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/preCheckTaskResponse'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+      x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/replication/channel/precheck/{preCheckID}:
+    get:
+      operationId: getPreCheck
+      summary: get preCheck
+      description: get preCheck.
+      parameters:
+        - description: The ID of the preCheck task
+          in: path
+          name: preCheckID
+          required: true
+          schema:
+            type: string
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/preCheckTaskDetail'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    delete:
+      deprecated: true
+      operationId: deletePreCheck
+      summary: delete preCheck
+      description: delete preCheck.
+      parameters:
+        - description: The ID of the preCheck task
+          in: path
+          name: preCheckID
+          required: true
+          schema:
+            type: string
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when preCheck is deleted successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/{channelID}/logs:
+    get:
+      description: Query logs of a data channel
+      summary: Query data channel logs
+      operationId: queryDataChannelLogs
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: moduleName
+          schema:
+            type: string
+        - in: query
+          name: containerName
+          schema:
+            type: string
+          required: false
+        - in: query
+          name: limit
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            text/plain:
+              schema:
+                type: string
+          description: channel logs output
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/{channelID}/containers:
+    get:
+      description: Query containers of a data channel module pod
+      summary: Query data channel module pod containers
+      operationId: queryDataChannelContainers
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: channelID
+          required: true
+          schema:
+            type: string
+        - in: query
+          name: moduleName
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/dataReplicationChannelContainer'
+          description: A list of data channel module containers.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/channel/parameters:
+    get:
+      operationId: listDataChannelParameters
+      summary: List Data Channel Parameters
+      description: Retrieve a list of data channel parameters.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The name of the standard definition
+          in: query
+          name: standardName
+          schema:
+            type: string
+        - description: The ID of the data channel
+          in: query
+          name: channelID
+          schema:
+            type: string
+        - description: The source EngineDeifnition name
+          in: query
+          name: source
+          schema:
+            type: string
+        - description: The target EngineDeifnition name
+          in: query
+          name: target
+          schema:
+            type: string
+        - description: The module name
+          in: query
+          name: moduleName
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataReplicationParametersResponse'
+          description: A list of data channel parameters.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
 components:
   securitySchemes:
     BearerToken:
@@ -46075,1060 +46764,1640 @@ components:
         pageResult:
           $ref: '#/components/schemas/pageResult'
       required:
-        - items
-      type: object
-    dataChannelObject:
+        - items
+      type: object
+    dataChannelObject:
+      type: object
+      properties:
+        includeObjects:
+          type: array
+          items:
+            type: string
+        excludeObjects:
+          type: array
+          items:
+            type: string
+          nullable: true
+    ImportPreflightRequest:
+      description: Data source preflight request
+      type: object
+      required:
+        - sourceType
+        - connectionConfig
+      properties:
+        sourceType:
+          type: string
+          description: Data source type
+        connectionConfig:
+          type: object
+          description: Connection configuration parameters that vary by data source type
+          example:
+            host: mysql-source.example.com
+            port: 3306
+            username: migration_user
+            password: secret123
+            sslMode: disable
+        objectSelection:
+          $ref: '#/components/schemas/dataChannelObject'
+    preCheckTaskResponse:
+      type: object
+      properties:
+        taskId:
+          type: string
+    preCheckStatus:
+      enum:
+        - Pending
+        - Running
+        - Succeed
+        - Failed
+      type: string
+    preCheckTaskItem:
+      type: object
+      properties:
+        checkerName:
+          type: string
+        checkerDesc:
+          type: string
+        message:
+          type: string
+          nullable: true
+        status:
+          $ref: '#/components/schemas/preCheckStatus'
+    preCheckResult:
+      type: object
+      properties:
+        name:
+          type: string
+        checkerName:
+          type: string
+        message:
+          type: string
+          nullable: true
+        advice:
+          type: string
+          nullable: true
+    preCheckTaskDetail:
+      type: object
+      properties:
+        taskID:
+          type: string
+        taskStatus:
+          $ref: '#/components/schemas/preCheckStatus'
+        progress:
+          type: integer
+          format: int32
+          nullable: true
+        checkers:
+          type: array
+          items:
+            $ref: '#/components/schemas/preCheckTaskItem'
+        errors:
+          type: array
+          items:
+            $ref: '#/components/schemas/preCheckResult'
+          nullable: true
+        warnings:
+          type: array
+          items:
+            $ref: '#/components/schemas/preCheckResult'
+          nullable: true
+        createdAt:
+          type: string
+          format: date-time
+        completedAt:
+          type: string
+          format: date-time
+          nullable: true
+    ImportQueryObjectsRequest:
+      description: Request payload for querying import data source objects.
+      type: object
+      required:
+        - sourceType
+        - connectionConfig
+      properties:
+        sourceType:
+          $ref: '#/components/schemas/ImportSourceType'
+          description: Data source type to query objects from.
+        connectionConfig:
+          type: object
+          description: Connection configuration parameters that vary by data source type.
+          example:
+            host: mysql-source.example.com
+            port: 3306
+            username: migration_user
+            password: secret123
+            sslMode: disable
+        nodeType:
+          type: string
+          description: Current node type in the replication object tree.
+        nodeValue:
+          type: string
+          description: Encoded node value of the current tree node.
+        queryNodeType:
+          type: string
+          description: Target node type to enumerate for the next level.
+    replicationObjectNode:
+      type: object
+      properties:
+        nodeName:
+          type: string
+        nodeValue:
+          type: string
+    replicationObjectTree:
+      type: object
+      properties:
+        nodeType:
+          type: string
+        nodeValues:
+          type: array
+          items:
+            $ref: '#/components/schemas/replicationObjectNode'
+        childrenNodeTypes:
+          type: array
+          nullable: true
+          items:
+            type: string
+    ImportTaskStatus:
+      type: string
+      description: Import task status
+      enum:
+        - Pending
+        - Initializing
+        - Finished
+        - Failed
+        - Deleting
+    ImportTaskResponse:
+      description: Import task response
+      type: object
+      properties:
+        id:
+          type: string
+          description: Import task ID
+        name:
+          type: string
+          description: Import name
+        status:
+          $ref: '#/components/schemas/ImportTaskStatus'
+        sourceEndpoint:
+          type: string
+          description: Source endpoint address
+        targetClusterName:
+          type: string
+          description: Target cluster name
+        progress:
+          type: integer
+          format: int32
+          minimum: 0
+          maximum: 100
+          default: 0
+          description: Overall progress
+        sourceType:
+          type: string
+          description: Data source type
+        targetEngine:
+          type: string
+          description: Target engine type
+        syncTimestamp:
+          type: string
+          format: date-time
+          description: Sync timestamp
+          nullable: true
+        delaySecond:
+          type: integer
+          description: Delay seconds
+          nullable: true
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation time
+        updatedAt:
+          type: string
+          format: date-time
+          description: Update time
+        finishedAt:
+          type: string
+          format: date-time
+          description: Finish time
+          nullable: true
+        message:
+          type: string
+          description: Operation result message
+          nullable: true
+      required:
+        - id
+        - name
+        - status
+        - sourceEndpoint
+        - targetClusterName
+        - progress
+        - sourceType
+        - targetEngine
+        - createdAt
+        - updatedAt
+        - message
+    ImportTaskListResponse:
+      description: Import task list response
       type: object
       properties:
-        includeObjects:
-          type: array
-          items:
-            type: string
-        excludeObjects:
+        items:
           type: array
           items:
-            type: string
-          nullable: true
-    ImportPreflightRequest:
-      description: Data source preflight request
+            $ref: '#/components/schemas/ImportTaskResponse'
+          description: Task list
+      required:
+        - items
+    ImportTaskCreateRequest:
+      description: Create import task request
       type: object
       required:
         - sourceType
         - connectionConfig
       properties:
-        sourceType:
+        name:
           type: string
-          description: Data source type
+          description: Import name
+        sourceType:
+          $ref: '#/components/schemas/ImportSourceType'
         connectionConfig:
           type: object
-          description: Connection configuration parameters that vary by data source type
-          example:
-            host: mysql-source.example.com
-            port: 3306
-            username: migration_user
-            password: secret123
-            sslMode: disable
+          description: Connection configuration
         objectSelection:
           $ref: '#/components/schemas/dataChannelObject'
-    preCheckTaskResponse:
-      type: object
-      properties:
-        taskId:
-          type: string
-    preCheckStatus:
-      enum:
-        - Pending
-        - Running
-        - Succeed
-        - Failed
+    ImportOpsType:
       type: string
-    preCheckTaskItem:
+      description: Import task operation type
+      enum:
+        - pause
+        - resume
+    environmentPricing:
       type: object
+      description: the information of environment pricing
+      required:
+        - envName
+        - cpuPrice
+        - memoryPrice
+        - storagePrice
+        - backupPrice
       properties:
-        checkerName:
+        envName:
+          description: The environment name
           type: string
-        checkerDesc:
+          nullable: true
+        cpuPrice:
+          description: The price of CPU, the unit is 'Core'
           type: string
-        message:
+          nullable: true
+        memoryPrice:
+          description: The price of Memory, the unit is 'GB'
           type: string
           nullable: true
-        status:
-          $ref: '#/components/schemas/preCheckStatus'
-    preCheckResult:
+        storagePrice:
+          description: The price of Storage, the unit is 'GB'
+          type: string
+          nullable: true
+        backupPrice:
+          description: The price of Backup, the unit is 'GB'
+          type: string
+          nullable: true
+    environmentPricingList:
       type: object
+      description: list of information with environment pricing
       properties:
-        name:
+        items:
+          description: Items is the list of environment pricing information
+          items:
+            $ref: '#/components/schemas/environmentPricing'
+          type: array
+      required:
+        - items
+    globalPricing:
+      type: object
+      description: the global information of pricing
+      required:
+        - billScheduleTime
+        - cpuPrice
+        - memoryPrice
+        - storagePrice
+        - backupPrice
+      properties:
+        enabled:
+          description: Enable global pricing
+          type: boolean
+          x-omitempty: false
+        currencyUnit:
+          description: The currency uint for display in bill query
           type: string
-        checkerName:
+          nullable: true
+        billScheduleTime:
+          description: Scheduled production time for daily bills, the format is 'HH:mm:ss', such as '01:00:00' meas every day at 1:00 AM, use the configured timezone
           type: string
-        message:
+          nullable: true
+          example: '01:00:00'
+        lastBillingTime:
+          description: |
+            The last billing time in RFC3339 format (e.g., '2025-09-01T00:00:00Z' or '2025-09-01T00:00:00+08:00').
+            This timestamp represents when the end time of the latest bill.
           type: string
+          format: date-time
           nullable: true
-        advice:
+          example: '2025-09-02T00:00:00Z'
+        cpuPrice:
+          description: The price of CPU, the unit is 'Core'
           type: string
           nullable: true
-    preCheckTaskDetail:
+        memoryPrice:
+          description: The price of Memory, the unit is 'GB'
+          type: string
+          nullable: true
+        storagePrice:
+          description: The price of Storage, the unit is 'GB'
+          type: string
+          nullable: true
+        backupPrice:
+          description: The price of Backup, the unit is 'GB'
+          type: string
+          nullable: true
+        timezone:
+          description: |
+            The timezone used for billing calculations and time alignment, specified as an IANA timezone identifier.
+
+            This timezone determines:
+            - When daily billing periods start and end (aligned to midnight in this timezone)
+            - How input timestamps are converted and normalized for billing calculations
+            - The timezone context for scheduled billing operations
+
+            Examples of valid timezone values:
+            - "UTC" - Coordinated Universal Time
+            - "Asia/Shanghai" - China Standard Time (CST, UTC+8)
+            - "America/New_York" - Eastern Time (EST/EDT, UTC-5/-4)
+            - "Europe/London" - Greenwich Mean Time/British Summer Time (GMT/BST, UTC+0/+1)
+
+            **The system defaults to UTC and not support to change for now.**
+          type: string
+          nullable: true
+          example: UTC
+    BasicTask:
       type: object
+      description: Task information
       properties:
-        taskID:
+        taskId:
+          description: Task ID
           type: string
-        taskStatus:
-          $ref: '#/components/schemas/preCheckStatus'
-        progress:
+          nullable: true
+      required:
+        - taskId
+    aggregationTimeType:
+      description: The type of aggregation time
+      enum:
+        - yearly
+        - monthly
+        - quarterly
+        - daily
+      type: string
+      nullable: true
+    aggregationGroupType:
+      description: The type of aggregation group
+      enum:
+        - global
+        - organization
+        - project
+        - cluster
+      type: string
+      nullable: true
+    Bill:
+      type: object
+      description: Task information
+      properties:
+        dataTime:
+          description: |
+            The Unix timestamp (seconds since epoch) representing the start of the billing period.
           type: integer
-          format: int32
+          format: int64
+          example: 1756656000
+        price:
+          description: The total price
+          type: string
+        clusterID:
+          description: The ID of cluster
+          type: string
           nullable: true
-        checkers:
-          type: array
-          items:
-            $ref: '#/components/schemas/preCheckTaskItem'
-        errors:
-          type: array
-          items:
-            $ref: '#/components/schemas/preCheckResult'
+          x-omitempty: true
+        clusterName:
+          description: The Name of cluster
+          type: string
           nullable: true
-        warnings:
-          type: array
-          items:
-            $ref: '#/components/schemas/preCheckResult'
+          x-omitempty: true
+        clusterDisplayName:
+          description: The Display Name of cluster
+          type: string
+          nullable: true
+          x-omitempty: true
+        engine:
+          description: Cluster Application Engine
+          type: string
+          nullable: true
+          x-omitempty: true
+        version:
+          description: Cluster Application Version
+          type: string
+          nullable: true
+          x-omitempty: true
+        mode:
+          description: Cluster topology mode
+          type: string
           nullable: true
-        createdAt:
+          x-omitempty: true
+        orgName:
+          description: The Name of organization
           type: string
-          format: date-time
-        completedAt:
+          nullable: true
+          x-omitempty: true
+        projectName:
+          description: The Name of project
           type: string
-          format: date-time
           nullable: true
-    ImportQueryObjectsRequest:
-      description: Request payload for querying import data source objects.
+          x-omitempty: true
+    BillList:
       type: object
+      description: list price details in date range
+      properties:
+        items:
+          description: Items of the price
+          items:
+            $ref: '#/components/schemas/Bill'
+          type: array
       required:
-        - sourceType
-        - connectionConfig
+        - items
+    MeteringTrack:
+      type: object
+      description: RTS metering track information
       properties:
-        sourceType:
-          $ref: '#/components/schemas/ImportSourceType'
-          description: Data source type to query objects from.
-        connectionConfig:
-          type: object
-          description: Connection configuration parameters that vary by data source type.
-          example:
-            host: mysql-source.example.com
-            port: 3306
-            username: migration_user
-            password: secret123
-            sslMode: disable
-        nodeType:
+        clusterID:
+          description: The ID of cluster
           type: string
-          description: Current node type in the replication object tree.
-        nodeValue:
+          nullable: true
+          x-omitempty: true
+        orgName:
+          description: The Name of organization
           type: string
-          description: Encoded node value of the current tree node.
-        queryNodeType:
+          nullable: true
+          x-omitempty: true
+        projectName:
+          description: The Name of project
           type: string
-          description: Target node type to enumerate for the next level.
-    replicationObjectNode:
-      type: object
-      properties:
-        nodeName:
+          nullable: true
+          x-omitempty: true
+        environmentID:
+          description: The ID of environment
           type: string
-        nodeValue:
+          nullable: true
+          x-omitempty: true
+        startTime:
+          description: The clipped start time of the metering track in Unix timestamp (seconds since epoch)
+          type: integer
+          format: int64
+          example: 1756656000
+        endTime:
+          description: The clipped end time of the metering track in Unix timestamp (seconds since epoch)
+          type: integer
+          format: int64
+          example: 1756663200
+        cpu:
+          description: The CPU usage tracked for the interval
           type: string
-    replicationObjectTree:
+        memory:
+          description: The memory usage tracked for the interval
+          type: string
+        storage:
+          description: The storage usage tracked for the interval
+          type: string
+        backup:
+          description: The backup usage tracked for the interval
+          type: string
+    MeteringTrackList:
       type: object
+      description: list metering tracks in date range
       properties:
-        nodeType:
-          type: string
-        nodeValues:
-          type: array
+        items:
+          description: Items of the metering tracks
           items:
-            $ref: '#/components/schemas/replicationObjectNode'
-        childrenNodeTypes:
+            $ref: '#/components/schemas/MeteringTrack'
           type: array
-          nullable: true
-          items:
-            type: string
-    ImportTaskStatus:
-      type: string
-      description: Import task status
-      enum:
-        - Pending
-        - Initializing
-        - Finished
-        - Failed
-        - Deleting
-    ImportTaskResponse:
-      description: Import task response
+        pagination:
+          $ref: '#/components/schemas/paginationResult'
+      required:
+        - items
+    SLACluster:
       type: object
+      description: The cluster summary used by SLA calculation results. SLA responses can be built from historical outage data, so general cluster list fields may be unavailable.
       properties:
         id:
           type: string
-          description: Import task ID
+          description: ID of cluster.
         name:
           type: string
-          description: Import name
-        status:
-          $ref: '#/components/schemas/ImportTaskStatus'
-        sourceEndpoint:
+          description: Name of cluster.
+        displayName:
           type: string
-          description: Source endpoint address
-        targetClusterName:
+          description: Display name of cluster.
+        orgName:
           type: string
-          description: Target cluster name
-        progress:
-          type: integer
-          format: int32
-          minimum: 0
-          maximum: 100
-          default: 0
-          description: Overall progress
-        sourceType:
+          description: Org Name.
+        environmentName:
           type: string
-          description: Data source type
-        targetEngine:
+          description: Environment Name.
+        engine:
           type: string
-          description: Target engine type
-        syncTimestamp:
+          description: Cluster Application Engine.
+        clusterType:
+          $ref: '#/components/schemas/clusterType'
+        createdAt:
           type: string
           format: date-time
-          description: Sync timestamp
+          x-nullable: true
+          description: The timestamp when the cluster was created, when available.
+        status:
+          type: string
+          description: The SLA calculation status for the cluster.
+        version:
+          type: string
+          description: Cluster Application Version.
+    OutageRecord:
+      type: object
+      description: Records the outage events of a cluster for SLA calculation. It is designed to ensure that for any given cluster, there can be at most one active outage record at any time.
+      required:
+        - clusterID
+      properties:
+        id:
+          type: string
+          description: The unique identifier for the outage record.
+        clusterID:
+          type: string
+          description: The id of cluster.
+        outageStartTime:
+          type: integer
+          format: int64
+          description: The Unix timestamp (in seconds) when the outage began (UTC).
+        outageEndTime:
+          type: integer
+          format: int64
           nullable: true
-        delaySecond:
+          description: The Unix timestamp (in seconds) when the outage was resolved (UTC). A null value indicates that the outage is still ongoing.
+        lastFailureReason:
+          type: string
+          nullable: true
+          description: The error message from the last failed probe.
+        failureCount:
           type: integer
-          description: Delay seconds
+          format: int32
           nullable: true
+          description: The number of consecutive failures in this outage event.
+          default: 1
         createdAt:
           type: string
           format: date-time
-          description: Creation time
+          description: The timestamp when the record was created.
+          readOnly: true
         updatedAt:
           type: string
           format: date-time
-          description: Update time
-        finishedAt:
-          type: string
-          format: date-time
-          description: Finish time
-          nullable: true
-        message:
-          type: string
-          description: Operation result message
-          nullable: true
-      required:
-        - id
-        - name
-        - status
-        - sourceEndpoint
-        - targetClusterName
-        - progress
-        - sourceType
-        - targetEngine
-        - createdAt
-        - updatedAt
-        - message
-    ImportTaskListResponse:
-      description: Import task list response
+          description: The timestamp when the record was last updated.
+          readOnly: true
+    OutageRecordList:
+      type: array
+      description: A list of outage records.
+      items:
+        $ref: '#/components/schemas/OutageRecord'
+    SLA:
+      type: object
+      description: The SLA (Service Level Agreement) for a cluster.
+      properties:
+        cluster:
+          type: object
+          $ref: '#/components/schemas/SLACluster'
+        detail:
+          type: object
+          $ref: '#/components/schemas/OutageRecordList'
+        sla:
+          type: number
+          description: The SLA value for the cluster.
+        targetThreshold:
+          type: number
+          description: The target SLA threshold value for the cluster.
+        totalDuration:
+          type: integer
+          format: int64
+          description: The total duration of the outage records.
+        totalDowntime:
+          type: integer
+          format: int64
+          description: The total downtime duration of the outage records.
+    SLAList:
+      type: array
+      description: A list of SLA records.
+      items:
+        $ref: '#/components/schemas/SLA'
+    ClustersSLA:
       type: object
+      description: The SLA (Service Level Agreement) for a cluster.
       properties:
         items:
-          type: array
-          items:
-            $ref: '#/components/schemas/ImportTaskResponse'
-          description: Task list
-      required:
-        - items
-    ImportTaskCreateRequest:
-      description: Create import task request
-      type: object
-      required:
-        - sourceType
-        - connectionConfig
-      properties:
-        name:
-          type: string
-          description: Import name
-        sourceType:
-          $ref: '#/components/schemas/ImportSourceType'
-        connectionConfig:
           type: object
-          description: Connection configuration
-        objectSelection:
-          $ref: '#/components/schemas/dataChannelObject'
-    ImportOpsType:
-      type: string
-      description: Import task operation type
-      enum:
-        - pause
-        - resume
-    environmentPricing:
+          $ref: '#/components/schemas/SLAList'
+        total:
+          type: integer
+          format: int64
+          description: The total number of cluster SLA records.
+    DailySLA:
       type: object
-      description: the information of environment pricing
-      required:
-        - envName
-        - cpuPrice
-        - memoryPrice
-        - storagePrice
-        - backupPrice
+      description: The SLA (Service Level Agreement) for a cluster on a specific date.
       properties:
-        envName:
-          description: The environment name
-          type: string
-          nullable: true
-        cpuPrice:
-          description: The price of CPU, the unit is 'Core'
+        date:
           type: string
+          description: The date for which the SLA is calculated, formatted as YYYY-MM-DD.
+        sla:
+          type: number
+          description: The SLA value for the cluster on the specified date. Null indicates that the cluster was not existing on that date.
+          x-omitempty: false
           nullable: true
-        memoryPrice:
-          description: The price of Memory, the unit is 'GB'
+    DailySLAList:
+      type: array
+      description: A list of daily SLA records.
+      items:
+        $ref: '#/components/schemas/DailySLA'
+    SLASettings:
+      type: object
+      properties:
+        environmentName:
           type: string
-          nullable: true
-        storagePrice:
-          description: The price of Storage, the unit is 'GB'
+          description: The name of the environment.
+        probeInterval:
           type: string
-          nullable: true
-        backupPrice:
-          description: The price of Backup, the unit is 'GB'
+          format: duration
+        probeTimeout:
           type: string
-          nullable: true
-    environmentPricingList:
-      type: object
-      description: list of information with environment pricing
-      properties:
-        items:
-          description: Items is the list of environment pricing information
-          items:
-            $ref: '#/components/schemas/environmentPricing'
-          type: array
-      required:
-        - items
-    globalPricing:
-      type: object
-      description: the global information of pricing
-      required:
-        - billScheduleTime
-        - cpuPrice
-        - memoryPrice
-        - storagePrice
-        - backupPrice
-      properties:
-        enabled:
-          description: Enable global pricing
+          format: duration
+        enableProbeRetry:
           type: boolean
           x-omitempty: false
-        currencyUnit:
-          description: The currency uint for display in bill query
+        probeRetryCount:
+          type: integer
+          x-omitempty: false
+        probeRetryInterval:
           type: string
-          nullable: true
-        billScheduleTime:
-          description: Scheduled production time for daily bills, the format is 'HH:mm:ss', such as '01:00:00' meas every day at 1:00 AM, use the configured timezone
+          format: duration
+        probeEngines:
+          type: array
+          items:
+            type: string
+        probePoolSize:
+          type: integer
+          x-omitempty: false
+        collectorBatchSize:
+          type: integer
+        collectorMaxWaitTime:
           type: string
-          nullable: true
-          example: '01:00:00'
-        lastBillingTime:
-          description: |
-            The last billing time in RFC3339 format (e.g., '2025-09-01T00:00:00Z' or '2025-09-01T00:00:00+08:00').
-            This timestamp represents when the end time of the latest bill.
+          format: duration
+        slaThreshold:
+          type: number
+          description: The SLA threshold value for the cluster.
+    affectedClusterItem:
+      description: a cluster which is affected by the vulnerability
+      properties:
+        id:
+          description: the ID of the cluster
           type: string
-          format: date-time
-          nullable: true
-          example: '2025-09-02T00:00:00Z'
-        cpuPrice:
-          description: The price of CPU, the unit is 'Core'
+        name:
+          description: the name of the cluster
           type: string
-          nullable: true
-        memoryPrice:
-          description: The price of Memory, the unit is 'GB'
+        displayName:
+          description: the display name of the cluster
           type: string
-          nullable: true
-        storagePrice:
-          description: The price of Storage, the unit is 'GB'
+        clusterType:
+          description: the type of the cluster
           type: string
-          nullable: true
-        backupPrice:
-          description: The price of Backup, the unit is 'GB'
+        engine:
+          description: the engine of the cluster
           type: string
-          nullable: true
-        timezone:
-          description: |
-            The timezone used for billing calculations and time alignment, specified as an IANA timezone identifier.
-
-            This timezone determines:
-            - When daily billing periods start and end (aligned to midnight in this timezone)
-            - How input timestamps are converted and normalized for billing calculations
-            - The timezone context for scheduled billing operations
-
-            Examples of valid timezone values:
-            - "UTC" - Coordinated Universal Time
-            - "Asia/Shanghai" - China Standard Time (CST, UTC+8)
-            - "America/New_York" - Eastern Time (EST/EDT, UTC-5/-4)
-            - "Europe/London" - Greenwich Mean Time/British Summer Time (GMT/BST, UTC+0/+1)
-
-            **The system defaults to UTC and not support to change for now.**
+        orgName:
+          description: the name of the organization
           type: string
-          nullable: true
-          example: UTC
-    BasicTask:
-      type: object
-      description: Task information
+    refItem:
+      description: a reference of the vulnerability
       properties:
-        taskId:
-          description: Task ID
+        rType:
+          description: the type of the reference
+          type: string
+        url:
+          description: the URL of the reference
           type: string
-          nullable: true
       required:
-        - taskId
-    aggregationTimeType:
-      description: The type of aggregation time
-      enum:
-        - yearly
-        - monthly
-        - quarterly
-        - daily
-      type: string
-      nullable: true
-    aggregationGroupType:
-      description: The type of aggregation group
-      enum:
-        - global
-        - organization
-        - project
-        - cluster
-      type: string
-      nullable: true
-    Bill:
-      type: object
-      description: Task information
+        - rType
+        - url
+    vulnListItem:
+      description: a vulnerability which affected the cluster
       properties:
-        dataTime:
-          description: |
-            The Unix timestamp (seconds since epoch) representing the start of the billing period.
-          type: integer
-          format: int64
-          example: 1756656000
-        price:
-          description: The total price
-          type: string
-        clusterID:
-          description: The ID of cluster
+        cveId:
+          description: the CVE ID of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        clusterName:
-          description: The Name of cluster
+        engineName:
+          description: the engine name of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        clusterDisplayName:
-          description: The Display Name of cluster
+        productName:
+          description: the product name of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        engine:
-          description: Cluster Application Engine
+        versions:
+          description: the versions of the product which are affected by the vulnerability
+          type: array
+          items:
+            type: string
+        fixedVersions:
+          description: the fixed versions of the product which fixed the vulnerability
+          type: array
+          items:
+            type: string
+        affectedClusters:
+          description: the clusters which are affected by the vulnerability
+          type: array
+          items:
+            $ref: '#/components/schemas/affectedClusterItem'
+        detail:
+          description: the detail of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        version:
-          description: Cluster Application Version
+        severity:
+          description: the severity of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        mode:
-          description: Cluster topology mode
+        cvssVector:
+          description: the CVSS vector and score of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        orgName:
-          description: The Name of organization
+        publishedAt:
+          description: the published time of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-        projectName:
-          description: The Name of project
+          format: date-time
+        modifiedAt:
+          description: the modified time of the vulnerability
           type: string
-          nullable: true
-          x-omitempty: true
-    BillList:
-      type: object
-      description: list price details in date range
+          format: date-time
+        refs:
+          description: the references of the vulnerability
+          type: array
+          items:
+            $ref: '#/components/schemas/refItem'
+      required:
+        - cveId
+        - engineName
+        - productName
+        - versions
+        - severity
+        - publishedAt
+        - modifiedAt
+    vulnList:
+      description: a list of vulnerabilities
       properties:
         items:
-          description: Items of the price
+          description: a list of vulnerabilities
           items:
-            $ref: '#/components/schemas/Bill'
+            $ref: '#/components/schemas/vulnListItem'
           type: array
+        pageResult:
+          $ref: '#/components/schemas/pageResult'
       required:
         - items
-    MeteringTrack:
       type: object
-      description: RTS metering track information
+    vulnUploadFormData:
+      description: the data of the upload task
+      type: object
+      required:
+        - file
       properties:
-        clusterID:
-          description: The ID of cluster
+        file:
           type: string
-          nullable: true
-          x-omitempty: true
-        orgName:
-          description: The Name of organization
+          format: binary
+          description: the data file, zip or other format
+    markVulnsAsIgnored:
+      description: the data of the mark request
+      type: object
+      required:
+        - cveId
+        - engineName
+        - productName
+      properties:
+        cveId:
           type: string
-          nullable: true
-          x-omitempty: true
-        projectName:
-          description: The Name of project
+          description: the CVE ID of the vulnerability
+        engineName:
           type: string
-          nullable: true
-          x-omitempty: true
-        environmentID:
-          description: The ID of environment
+          description: the engine name of the vulnerability
+        productName:
           type: string
-          nullable: true
-          x-omitempty: true
-        startTime:
-          description: The clipped start time of the metering track in Unix timestamp (seconds since epoch)
-          type: integer
-          format: int64
-          example: 1756656000
-        endTime:
-          description: The clipped end time of the metering track in Unix timestamp (seconds since epoch)
-          type: integer
-          format: int64
-          example: 1756663200
-        cpu:
-          description: The CPU usage tracked for the interval
+          description: the product name of the vulnerability
+    vulnItem:
+      description: a vulnerability which affected the cluster
+      properties:
+        cveId:
+          description: the CVE ID of the vulnerability
           type: string
-        memory:
-          description: The memory usage tracked for the interval
+        detail:
+          description: the detail of the vulnerability
           type: string
-        storage:
-          description: The storage usage tracked for the interval
+        severity:
+          description: the severity of the vulnerability
           type: string
-        backup:
-          description: The backup usage tracked for the interval
+        cvssVector:
+          description: the CVSS vector and score of the vulnerability
           type: string
-    MeteringTrackList:
+        publishedAt:
+          description: the published time of the vulnerability
+          type: string
+          format: date-time
+        modifiedAt:
+          description: the modified time of the vulnerability
+          type: string
+          format: date-time
+        refs:
+          description: the references of the vulnerability
+          type: array
+          items:
+            $ref: '#/components/schemas/refItem'
+      required:
+        - cveId
+        - severity
+        - publishedAt
+        - modifiedAt
+    clusterVulns:
+      description: a list of vulnerabilities which affected the cluster
       type: object
-      description: list metering tracks in date range
+      required:
+        - items
       properties:
         items:
-          description: Items of the metering tracks
-          items:
-            $ref: '#/components/schemas/MeteringTrack'
           type: array
-        pagination:
-          $ref: '#/components/schemas/paginationResult'
-      required:
-        - items
-    SLACluster:
+          items:
+            $ref: '#/components/schemas/vulnItem'
+    engineSchedulingPolicy:
       type: object
-      description: The cluster summary used by SLA calculation results. SLA responses can be built from historical outage data, so general cluster list fields may be unavailable.
+      description: Engine-level default scheduling policy for a specific engine and engine mode.
       properties:
         id:
           type: string
-          description: ID of cluster.
-        name:
+          description: Id of engine scheduling policy.
+        schedulingPolicyType:
+          description: Scheduling policy type applied by default to matching clusters unless overridden by a environment-level or cluster-level setting.
+          $ref: '#/components/schemas/schedulingPolicyType'
+        engine:
           type: string
-          description: Name of cluster.
-        displayName:
+          description: Database engine that this policy applies to. Used together with `engineMode`.
+        engineMode:
           type: string
-          description: Display name of cluster.
-        orgName:
+          description: Engine mode that this policy applies to, such as `standalone` or `replication`.
+        description:
           type: string
-          description: Org Name.
-        environmentName:
+          description: Human-readable description of the engine scheduling policy.
+      required:
+        - engine
+        - engineMode
+        - schedulingPolicyType
+    target_role:
+      type: string
+      enum:
+        - Primary
+        - '*'
+      description: |
+        Role name to match. Use `*` to match all roles, including components without an explicit role.
+      default: '*'
+    target:
+      type: object
+      description: Identifies one side of a scheduling rule match, including component and role.
+      properties:
+        component:
           type: string
-          description: Environment Name.
-        engine:
+          description: |
+            Component name to match. Use `*` to match all components for the selected engine mode.
+          default: '*'
+        role:
+          $ref: '#/components/schemas/target_role'
+    engineSchedulingRule:
+      type: object
+      properties:
+        id:
           type: string
-          description: Cluster Application Engine.
-        clusterType:
-          $ref: '#/components/schemas/clusterType'
-        createdAt:
+          description: Id of engine scheduling rule.
+        name:
           type: string
-          format: date-time
-          x-nullable: true
-          description: The timestamp when the cluster was created, when available.
-        status:
+          description: Rule name, used to reference this rule when applying scheduling policies to a cluster.
+        engine:
           type: string
-          description: The SLA calculation status for the cluster.
-        version:
+          description: Database engine type this rule applies to. Used to match rules to clusters by engine.
+        engineMode:
           type: string
-          description: Cluster Application Version.
-    OutageRecord:
+          description: Cluster mode this rule applies to. Used to match rules to clusters by mode.
+        targetSelector:
+          type: array
+          description: Selects the two mutually exclusive targets that this rule applies to. The array length must be exactly 2.
+          items:
+            $ref: '#/components/schemas/target'
+        schedulingPolicyType:
+          description: Scheduling policy type to apply when this rule matches.
+          $ref: '#/components/schemas/schedulingPolicyType'
+        description:
+          type: string
+          description: Optional description of the scheduling rule.
+        default:
+          description: Indicates whether this rule is used as the fallback when no other rule matches.
+          type: boolean
+          nullable: true
+      required:
+        - name
+        - engine
+        - engineMode
+        - targetSelector
+        - schedulingPolicyType
+    environmentEngineOption:
       type: object
-      description: Records the outage events of a cluster for SLA calculation. It is designed to ensure that for any given cluster, there can be at most one active outage record at any time.
       required:
-        - clusterID
+        - id
+        - engineName
+        - mode
+        - networkModes
+        - envId
+        - envName
       properties:
         id:
           type: string
-          description: The unique identifier for the outage record.
-        clusterID:
+          description: record id
+        engineName:
           type: string
-          description: The id of cluster.
-        outageStartTime:
-          type: integer
-          format: int64
-          description: The Unix timestamp (in seconds) when the outage began (UTC).
-        outageEndTime:
-          type: integer
-          format: int64
-          nullable: true
-          description: The Unix timestamp (in seconds) when the outage was resolved (UTC). A null value indicates that the outage is still ongoing.
-        lastFailureReason:
+          description: engine name
+        mode:
           type: string
-          nullable: true
-          description: The error message from the last failed probe.
-        failureCount:
-          type: integer
-          format: int32
-          nullable: true
-          description: The number of consecutive failures in this outage event.
-          default: 1
-        createdAt:
+          description: engine mode
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: network modes configured for this engine+mode+env combination
+        envId:
+          type: string
+          format: uuid
+          description: environment id
+        envName:
+          type: string
+          description: environment name
+        createTime:
           type: string
           format: date-time
-          description: The timestamp when the record was created.
-          readOnly: true
-        updatedAt:
+          description: create time
+        updateTime:
           type: string
           format: date-time
-          description: The timestamp when the record was last updated.
-          readOnly: true
-    OutageRecordList:
+          description: update time
+    environmentEngineOptionList:
       type: array
-      description: A list of outage records.
       items:
-        $ref: '#/components/schemas/OutageRecord'
-    SLA:
+        $ref: '#/components/schemas/environmentEngineOption'
+    environmentEngineOptionCreate:
       type: object
-      description: The SLA (Service Level Agreement) for a cluster.
+      required:
+        - engineName
+        - mode
+        - networkModes
       properties:
-        cluster:
-          type: object
-          $ref: '#/components/schemas/SLACluster'
-        detail:
+        engineName:
+          type: string
+          description: engine name
+        mode:
+          type: string
+          description: engine mode
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: network modes
+    environmentEngineOptionUpdate:
+      type: object
+      required:
+        - networkModes
+      properties:
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: environment engine option to update
+    engineNetworkModeSupported:
+      type: object
+      properties:
+        supported:
+          type: array
+          items:
+            $ref: '#/components/schemas/networkMode'
+          description: supported network modes
+        notSupportedVersions:
           type: object
-          $ref: '#/components/schemas/OutageRecordList'
-        sla:
-          type: number
-          description: The SLA value for the cluster.
-        targetThreshold:
-          type: number
-          description: The target SLA threshold value for the cluster.
-        totalDuration:
-          type: integer
-          format: int64
-          description: The total duration of the outage records.
-        totalDowntime:
-          type: integer
-          format: int64
-          description: The total downtime duration of the outage records.
-    SLAList:
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          description: not supported versions, key is networkMode, value is array of versions
+    engineNetworkModeOptions:
       type: array
-      description: A list of SLA records.
       items:
-        $ref: '#/components/schemas/SLA'
-    ClustersSLA:
+        type: object
+        required:
+          - engineName
+          - mode
+          - networkModes
+        properties:
+          engineName:
+            type: string
+            description: engine name
+          mode:
+            type: string
+            description: engine mode
+          networkModes:
+            type: array
+            items:
+              $ref: '#/components/schemas/networkMode'
+            description: available network modes for this engine+mode
+    channelStatus:
+      enum:
+        - Pending
+        - Initializing
+        - Running
+        - Finished
+        - Failed
+        - Pausing
+        - Paused
+        - Deleting
+      type: string
+    dataReplicationEndpointType:
+      enum:
+        - custom
+        - kubeblocks
+      type: string
+    authType:
+      enum:
+        - basic
+      type: string
+    basicAuthModel:
       type: object
-      description: The SLA (Service Level Agreement) for a cluster.
       properties:
-        items:
-          type: object
-          $ref: '#/components/schemas/SLAList'
-        total:
-          type: integer
-          format: int64
-          description: The total number of cluster SLA records.
-    DailySLA:
+        userName:
+          type: string
+        password:
+          type: string
+          description: if password is not provided when patch replication channel, it means not to modify the password
+          nullable: true
+    customEndpoint:
       type: object
-      description: The SLA (Service Level Agreement) for a cluster on a specific date.
       properties:
-        date:
+        connectionString:
+          description: display connection string information, including connection details such as url, database, etc
           type: string
-          description: The date for which the SLA is calculated, formatted as YYYY-MM-DD.
-        sla:
-          type: number
-          description: The SLA value for the cluster on the specified date. Null indicates that the cluster was not existing on that date.
-          x-omitempty: false
+        connection:
+          type: string
+        authType:
+          $ref: '#/components/schemas/authType'
+        basicAuth:
+          $ref: '#/components/schemas/basicAuthModel'
           nullable: true
-    DailySLAList:
-      type: array
-      description: A list of daily SLA records.
-      items:
-        $ref: '#/components/schemas/DailySLA'
-    SLASettings:
+    kubeblocksEndpoint:
       type: object
       properties:
+        environmentID:
+          type: string
         environmentName:
           type: string
-          description: The name of the environment.
-        probeInterval:
+        clusterID:
           type: string
-          format: duration
-        probeTimeout:
+        clusterName:
           type: string
-          format: duration
-        enableProbeRetry:
-          type: boolean
-          x-omitempty: false
-        probeRetryCount:
-          type: integer
-          x-omitempty: false
-        probeRetryInterval:
+        displayName:
           type: string
-          format: duration
-        probeEngines:
+          nullable: true
+    dataChannelListEndpoint:
+      type: object
+      properties:
+        engineName:
+          type: string
+        endpointType:
+          $ref: '#/components/schemas/dataReplicationEndpointType'
+        custom:
+          $ref: '#/components/schemas/customEndpoint'
+          nullable: true
+        kubeblocks:
+          $ref: '#/components/schemas/kubeblocksEndpoint'
+          nullable: true
+        extraCfgs:
+          type: object
+          additionalProperties:
+            type: string
+          nullable: true
+    dataChannelItem:
+      type: object
+      properties:
+        channelID:
+          type: string
+        channelName:
+          type: string
+        orgName:
+          type: string
+        channelStatus:
+          $ref: '#/components/schemas/channelStatus'
+        environmentID:
+          type: string
+        environmentName:
+          type: string
+        project:
+          type: string
+        kubernetesName:
+          type: string
+        standardDefinition:
+          type: string
+        source:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        target:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        replicationObjects:
+          $ref: '#/components/schemas/dataChannelObject'
+        modules:
           type: array
           items:
             type: string
-        probePoolSize:
-          type: integer
-          x-omitempty: false
-        collectorBatchSize:
-          type: integer
-        collectorMaxWaitTime:
+        events:
+          type: array
+          items:
+            $ref: '#/components/schemas/eventObject'
+        createdAt:
           type: string
-          format: duration
-        slaThreshold:
-          type: number
-          description: The SLA threshold value for the cluster.
-    affectedClusterItem:
-      description: a cluster which is affected by the vulnerability
-      properties:
-        id:
-          description: the ID of the cluster
+          format: date-time
+        FinishedAt:
           type: string
-        name:
-          description: the name of the cluster
+          format: date-time
+          nullable: true
+    dataChannelList:
+      type: array
+      items:
+        $ref: '#/components/schemas/dataChannelItem'
+    dataChannelModuleProgress:
+      type: object
+      properties:
+        moduleName:
           type: string
-        displayName:
-          description: the display name of the cluster
+        kubernetesName:
           type: string
-        clusterType:
-          description: the type of the cluster
+          nullable: true
+        progress:
+          type: number
+          format: double
+          nullable: true
+        status:
           type: string
-        engine:
-          description: the engine of the cluster
+        message:
           type: string
-        orgName:
-          description: the name of the organization
+          nullable: true
+    dataChannelProgress:
+      type: object
+      properties:
+        progress:
+          type: number
+          format: double
+          nullable: true
+        moduleProgress:
+          type: array
+          items:
+            $ref: '#/components/schemas/dataChannelModuleProgress'
+    dataChannelDetail:
+      type: object
+      properties:
+        channel:
+          $ref: '#/components/schemas/dataChannelItem'
+        progress:
+          $ref: '#/components/schemas/dataChannelProgress'
+    customEndpointCreate:
+      type: object
+      properties:
+        connection:
           type: string
-    refItem:
-      description: a reference of the vulnerability
+        authType:
+          $ref: '#/components/schemas/authType'
+        basicAuth:
+          $ref: '#/components/schemas/basicAuthModel'
+          nullable: true
+    dataChannelEndpointCreate:
+      type: object
       properties:
-        rType:
-          description: the type of the reference
+        engineName:
           type: string
-        url:
-          description: the URL of the reference
+        definitionName:
           type: string
-      required:
-        - rType
-        - url
-    vulnListItem:
-      description: a vulnerability which affected the cluster
+        endpointType:
+          $ref: '#/components/schemas/dataReplicationEndpointType'
+        custom:
+          $ref: '#/components/schemas/customEndpointCreate'
+          nullable: true
+        kubeblocks:
+          $ref: '#/components/schemas/kubeblocksEndpoint'
+          nullable: true
+        extraCfgs:
+          type: object
+          additionalProperties:
+            type: string
+          nullable: true
+    dataChannelParameterKeyValue:
+      type: object
       properties:
-        cveId:
-          description: the CVE ID of the vulnerability
+        key:
           type: string
-        engineName:
-          description: the engine name of the vulnerability
+        value:
           type: string
-        productName:
-          description: the product name of the vulnerability
+      required:
+        - key
+        - value
+    dataReplicationCreate:
+      type: object
+      properties:
+        channelName:
           type: string
-        versions:
-          description: the versions of the product which are affected by the vulnerability
-          type: array
-          items:
-            type: string
-        fixedVersions:
-          description: the fixed versions of the product which fixed the vulnerability
+        modules:
           type: array
           items:
             type: string
-        affectedClusters:
-          description: the clusters which are affected by the vulnerability
+        environmentID:
+          type: string
+        project:
+          type: string
+          default: kubeblocks-cloud-ns
+        standardDefinition:
+          type: string
+        source:
+          $ref: '#/components/schemas/dataChannelEndpointCreate'
+        target:
+          $ref: '#/components/schemas/dataChannelEndpointCreate'
+        replicationObjects:
+          $ref: '#/components/schemas/dataChannelObject'
+        events:
           type: array
           items:
-            $ref: '#/components/schemas/affectedClusterItem'
-        detail:
-          description: the detail of the vulnerability
-          type: string
-        severity:
-          description: the severity of the vulnerability
+            $ref: '#/components/schemas/eventObject'
+        parameters:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              $ref: '#/components/schemas/dataChannelParameterKeyValue'
+          nullable: true
+    dataReplicationUpdate:
+      type: object
+      properties:
+        clusterUpdates:
+          $ref: '#/components/schemas/dataReplicationCreate'
+        isRestart:
+          type: boolean
+          nullable: true
+    dataChannelResponse:
+      type: object
+      properties:
+        channelID:
           type: string
-        cvssVector:
-          description: the CVSS vector and score of the vulnerability
+        channelName:
           type: string
-        publishedAt:
-          description: the published time of the vulnerability
+        createdAt:
           type: string
           format: date-time
-        modifiedAt:
-          description: the modified time of the vulnerability
+        updatedAt:
           type: string
           format: date-time
-        refs:
-          description: the references of the vulnerability
-          type: array
-          items:
-            $ref: '#/components/schemas/refItem'
-      required:
-        - cveId
-        - engineName
-        - productName
-        - versions
-        - severity
-        - publishedAt
-        - modifiedAt
-    vulnList:
-      description: a list of vulnerabilities
-      properties:
-        items:
-          description: a list of vulnerabilities
-          items:
-            $ref: '#/components/schemas/vulnListItem'
-          type: array
-        pageResult:
-          $ref: '#/components/schemas/pageResult'
-      required:
-        - items
-      type: object
-    vulnUploadFormData:
-      description: the data of the upload task
+          nullable: true
+    dataCheckType:
+      type: string
+      description: Type of check to run. A standalone check runs exactly one type.
+      enum:
+        - struct
+        - snapshot
+    dataCheckStatus:
+      type: string
+      enum:
+        - Running
+        - Finished
+        - Failed
+    dataCheckListSummary:
       type: object
-      required:
-        - file
       properties:
-        file:
-          type: string
-          format: binary
-          description: the data file, zip or other format
-    markVulnsAsIgnored:
-      description: the data of the mark request
+        is_consistent:
+          type: boolean
+          nullable: true
+        miss_count:
+          type: integer
+          format: int64
+        diff_count:
+          type: integer
+          format: int64
+        skip_count:
+          type: integer
+          format: int64
+        sql_count:
+          type: integer
+          format: int64
+    dataCheckListItem:
       type: object
-      required:
-        - cveId
-        - engineName
-        - productName
       properties:
-        cveId:
+        checkID:
           type: string
-          description: the CVE ID of the vulnerability
-        engineName:
+        checkName:
           type: string
-          description: the engine name of the vulnerability
-        productName:
+        orgName:
           type: string
-          description: the product name of the vulnerability
-    vulnItem:
-      description: a vulnerability which affected the cluster
-      properties:
-        cveId:
-          description: the CVE ID of the vulnerability
+        checkType:
+          $ref: '#/components/schemas/dataCheckType'
+        checkStatus:
+          $ref: '#/components/schemas/dataCheckStatus'
+        checkSummary:
+          $ref: '#/components/schemas/dataCheckListSummary'
+          nullable: true
+        environmentID:
           type: string
-        detail:
-          description: the detail of the vulnerability
+        environmentName:
           type: string
-        severity:
-          description: the severity of the vulnerability
+        project:
           type: string
-        cvssVector:
-          description: the CVSS vector and score of the vulnerability
+        source:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        target:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        replicationObjects:
+          $ref: '#/components/schemas/dataChannelObject'
+        errorMessage:
           type: string
-        publishedAt:
-          description: the published time of the vulnerability
+          nullable: true
+        createdAt:
           type: string
           format: date-time
-        modifiedAt:
-          description: the modified time of the vulnerability
+        updatedAt:
           type: string
           format: date-time
-        refs:
-          description: the references of the vulnerability
-          type: array
-          items:
-            $ref: '#/components/schemas/refItem'
-      required:
-        - cveId
-        - severity
-        - publishedAt
-        - modifiedAt
-    clusterVulns:
-      description: a list of vulnerabilities which affected the cluster
+        finishedAt:
+          type: string
+          format: date-time
+          nullable: true
+    dataCheckList:
+      type: array
+      items:
+        $ref: '#/components/schemas/dataCheckListItem'
+    dataCheckTableSummary:
       type: object
-      required:
-        - items
       properties:
-        items:
+        schema:
+          type: string
+        tb:
+          type: string
+        target_schema:
+          type: string
+        target_tb:
+          type: string
+        checked_count:
+          type: integer
+          format: int64
+        miss_count:
+          type: integer
+          format: int64
+        diff_count:
+          type: integer
+          format: int64
+        skip_count:
+          type: integer
+          format: int64
+    dataCheckSummary:
+      type: object
+      properties:
+        is_consistent:
+          type: boolean
+          nullable: true
+        miss_count:
+          type: integer
+          format: int64
+        diff_count:
+          type: integer
+          format: int64
+        skip_count:
+          type: integer
+          format: int64
+        sql_count:
+          type: integer
+          format: int64
+        tables:
           type: array
           items:
-            $ref: '#/components/schemas/vulnItem'
-    engineSchedulingPolicy:
+            $ref: '#/components/schemas/dataCheckTableSummary'
+    dataCheckItem:
       type: object
-      description: Engine-level default scheduling policy for a specific engine and engine mode.
       properties:
-        id:
+        orgName:
           type: string
-          description: Id of engine scheduling policy.
-        schedulingPolicyType:
-          description: Scheduling policy type applied by default to matching clusters unless overridden by a environment-level or cluster-level setting.
-          $ref: '#/components/schemas/schedulingPolicyType'
-        engine:
+        checkID:
           type: string
-          description: Database engine that this policy applies to. Used together with `engineMode`.
-        engineMode:
+        checkName:
           type: string
-          description: Engine mode that this policy applies to, such as `standalone` or `replication`.
-        description:
+        checkType:
+          $ref: '#/components/schemas/dataCheckType'
+        checkStatus:
+          $ref: '#/components/schemas/dataCheckStatus'
+        checkSummary:
+          $ref: '#/components/schemas/dataCheckSummary'
+          nullable: true
+        environmentID:
           type: string
-          description: Human-readable description of the engine scheduling policy.
-      required:
-        - engine
-        - engineMode
-        - schedulingPolicyType
-    target_role:
+        environmentName:
+          type: string
+        project:
+          type: string
+        source:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        target:
+          $ref: '#/components/schemas/dataChannelListEndpoint'
+        replicationObjects:
+          $ref: '#/components/schemas/dataChannelObject'
+        errorMessage:
+          type: string
+          nullable: true
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+        finishedAt:
+          type: string
+          format: date-time
+          nullable: true
+    dataCheckDetailType:
       type: string
       enum:
-        - Primary
-        - '*'
-      description: |
-        Role name to match. Use `*` to match all roles, including components without an explicit role.
-      default: '*'
-    target:
+        - miss
+        - diff
+    dataCheckDiffValue:
       type: object
-      description: Identifies one side of a scheduling rule match, including component and role.
       properties:
-        component:
+        src:
           type: string
-          description: |
-            Component name to match. Use `*` to match all components for the selected engine mode.
-          default: '*'
-        role:
-          $ref: '#/components/schemas/target_role'
-    engineSchedulingRule:
+          nullable: true
+        dst:
+          type: string
+          nullable: true
+        src_type:
+          type: string
+          nullable: true
+        dst_type:
+          type: string
+          nullable: true
+    dataCheckDetailItem:
       type: object
       properties:
-        id:
+        key:
           type: string
-          description: Id of engine scheduling rule.
-        name:
+          description: Struct check object key. Present for struct details; omitted for snapshot row details.
+        schema:
           type: string
-          description: Rule name, used to reference this rule when applying scheduling policies to a cluster.
-        engine:
+          description: Source schema or database from the requested detail scope.
+        tb:
           type: string
-          description: Database engine type this rule applies to. Used to match rules to clusters by engine.
-        engineMode:
+          description: Source table from the requested detail scope.
+        target_schema:
           type: string
-          description: Cluster mode this rule applies to. Used to match rules to clusters by mode.
-        targetSelector:
-          type: array
-          description: Selects the two mutually exclusive targets that this rule applies to. The array length must be exactly 2.
-          items:
-            $ref: '#/components/schemas/target'
-        schedulingPolicyType:
-          description: Scheduling policy type to apply when this rule matches.
-          $ref: '#/components/schemas/schedulingPolicyType'
-        description:
+          nullable: true
+          description: Target schema or database for snapshot details when routing changes the target object.
+        target_tb:
           type: string
-          description: Optional description of the scheduling rule.
-        default:
-          description: Indicates whether this rule is used as the fallback when no other rule matches.
-          type: boolean
           nullable: true
-      required:
-        - name
-        - engine
-        - engineMode
-        - targetSelector
-        - schedulingPolicyType
-    environmentEngineOption:
+          description: Target table for snapshot details when routing changes the target object.
+        id_col_values:
+          type: object
+          additionalProperties: {}
+        src_sql:
+          type: string
+          nullable: true
+        diff_col_values:
+          type: object
+          additionalProperties:
+            $ref: '#/components/schemas/dataCheckDiffValue'
+          nullable: true
+        src_row:
+          type: object
+          additionalProperties: true
+          nullable: true
+        dst_row:
+          type: object
+          additionalProperties: true
+          nullable: true
+        dst_sql:
+          type: string
+          nullable: true
+    dataCheckDetails:
       type: object
       required:
-        - id
-        - engineName
-        - mode
-        - networkModes
-        - envId
-        - envName
+        - items
       properties:
-        id:
-          type: string
-          description: record id
-        engineName:
-          type: string
-          description: engine name
-        mode:
-          type: string
-          description: engine mode
-        networkModes:
+        items:
           type: array
           items:
-            type: string
-          description: network modes configured for this engine+mode+env combination
-        envId:
+            $ref: '#/components/schemas/dataCheckDetailItem'
+        pagination:
+          $ref: '#/components/schemas/paginationResult'
+    dataReplicationOpsType:
+      description: data replication ops type
+      enum:
+        - pause
+        - resume
+        - restart
+      type: string
+    eventItem:
+      type: object
+      properties:
+        eventID:
           type: string
-          format: uuid
-          description: environment id
-        envName:
+        eventName:
           type: string
-          description: environment name
-        createTime:
+        eventTime:
           type: string
           format: date-time
-          description: create time
-        updateTime:
+        eventMessage:
           type: string
-          format: date-time
-          description: update time
-    environmentEngineOptionList:
+        operator:
+          type: string
+        operatorID:
+          type: string
+          nullable: true
+    dataReplicationEventList:
       type: array
       items:
-        $ref: '#/components/schemas/environmentEngineOption'
-    environmentEngineOptionCreate:
+        $ref: '#/components/schemas/eventItem'
+    replicationObjectQuery:
       type: object
-      required:
-        - engineName
-        - mode
-        - networkModes
       properties:
-        engineName:
+        sourceEngineDefinition:
           type: string
-          description: engine name
-        mode:
+        targetEngineDefinition:
           type: string
-          description: engine mode
-        networkModes:
-          type: array
-          items:
-            type: string
-          description: network modes
-    environmentEngineOptionUpdate:
+        endpoint:
+          $ref: '#/components/schemas/dataChannelEndpointCreate'
+        nodeType:
+          type: string
+          nullable: true
+        nodeValue:
+          type: string
+          nullable: true
+        queryNodeType:
+          type: string
+          nullable: true
+    preCheckCreate:
       type: object
-      required:
-        - networkModes
       properties:
-        networkModes:
+        modules:
           type: array
           items:
             type: string
-          description: environment engine option to update
-    engineNetworkModeSupported:
+        environmentID:
+          type: string
+        source:
+          $ref: '#/components/schemas/dataChannelEndpointCreate'
+        target:
+          $ref: '#/components/schemas/dataChannelEndpointCreate'
+        replicationObjects:
+          $ref: '#/components/schemas/dataChannelObject'
+    dataReplicationChannelContainer:
       type: object
       properties:
-        supported:
-          type: array
-          items:
-            $ref: '#/components/schemas/networkMode'
-          description: supported network modes
-        notSupportedVersions:
-          type: object
-          additionalProperties:
-            type: array
-            items:
-              type: string
-          description: not supported versions, key is networkMode, value is array of versions
-    engineNetworkModeOptions:
-      type: array
-      items:
-        type: object
-        required:
-          - engineName
-          - mode
-          - networkModes
-        properties:
-          engineName:
-            type: string
-            description: engine name
-          mode:
-            type: string
-            description: engine mode
-          networkModes:
-            type: array
-            items:
-              $ref: '#/components/schemas/networkMode'
-            description: available network modes for this engine+mode
+        name:
+          type: string
+        isMainContainer:
+          type: boolean
+          default: false
+        isInitContainer:
+          type: boolean
+          default: false
+    dataReplicationParametersResponseDetail:
+      type: object
+      properties:
+        displayName:
+          type: string
+        desc:
+          $ref: '#/components/schemas/internationalDesc'
+        key:
+          type: string
+        defaultValue:
+          type: string
+        value:
+          type: string
+        valueType:
+          $ref: '#/components/schemas/parameterValueType'
+      required:
+        - key
+    dataReplicationParametersResponse:
+      type: object
+      description: the parameters of the data channel, the key is the module name, the value is the parameter template
+      additionalProperties:
+        type: array
+        items:
+          $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
   responses:
     '204':
       description: No Content