openapi: 3.0.1
info:
  title: OCP Cloud OpenAPI
  description: "OCP Cloud OpenAPI provides programmatic access to OceanBase Cloud\
    \ Platform services. This API allows you to manage OceanBase database instances,\
    \ tenants, users, databases, security configurations, monitoring metrics, backups,\
    \ and other cloud resources."
  version: v1.0.0-release
  contact:
    name: OceanBase Cloud Support
    url: https://www.oceanbase.com
    email: support@oceanbase.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: "https://{environment}.oceanbase.com"
    description: OceanBase Cloud API Server
    variables:
      environment:
        default: api-cloud-cn
        description: API environment
        enum:
          - api-cloud-cn
          - api-cloud
paths:
  /api/v2/datasource/datasources:
    get:
      summary: 查询数据源列表
      description: |
        查询数据源列表。请求头必须带 X-Ob-Project-Id、X-Ob-Org-Id、Action=DssInnerHttp。
      operationId: listDataSources
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Dss-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          schema:
            type: string
          example: org-xxxxxxxx
        - name: page
          in: query
          schema:
            type: string
          description: 页码。
          example: "1"
        - name: size
          in: query
          schema:
            type: string
          description: 分页大小。
          example: "200"
        - name: name
          in: query
          description: 数据源名称列表，多值
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - 数据源名称
        - name: fullFuzzySearchKeyword
          in: query
          description: 全模糊搜索关键词
          schema:
            type: string
          example: env
        - name: cloudProvider
          in: query
          description: 资源或数据源所在云厂商
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - ALIYUN
        - name: regionName
          in: query
          description: 地域名称（与 region 二选一或同义）
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - cn-hangzhou
        - name: databaseType
          in: query
          description: 数据库类型列表
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - MYSQL
        - name: status
          in: query
          description: 任务或资源当前状态
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - ONLINE
      responses:
        "200":
          description: 成功，分页列表
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PaginatedResponseDataSource"
        "403":
          description: 无权限
    post:
      summary: 创建数据源
      description: |
        创建数据源。请求体中必须带 uid；请求头必须带 X-Ob-Project-Id、X-Ob-Org-Id（商业中台鉴权），
        以及 Action=DssInnerHttp（DSS 内部接口鉴权）。
      operationId: createDataSource
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Dss-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，用于商业中台鉴权
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDataSourceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SuccessResponseDataSource"
        "400":
          description: 请求参数校验失败
        "403":
          description: 无权限
  /api/v2/datasource/datasources/{id}:
    delete:
      summary: 删除数据源
      description: |
        删除数据源。请求体/上下文需带 uid，请求头需带 X-Ob-Project-Id、X-Ob-Org-Id、Action=DssInnerHttp。
      operationId: deleteDataSource
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Dss-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          schema:
            type: string
          example: org-xxxxxxxx
        - name: id
          in: path
          description: 数据源主键 ID
          required: true
          schema:
            type: integer
            format: int64
          example: 244
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SuccessResponseDataSource"
        "403":
          description: 无权限
        "404":
          description: 数据源不存在
  /api/v2/instances/{instanceId}/disconnectStandbyInstance:
    post:
      summary: DisconnectStandbyInstance
      operationId: DisconnectStandbyInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RemoveStandbyInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DisconnectInstanceResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 解耦备实例接口，解除主集群与备实例的容灾关系
      tags:
        - 多云产品实例相关RestAPI
  /api/v2/instances/{instanceId}/failoverStandbyInstance:
    post:
      summary: FailoverStandbyInstance
      operationId: FailoverStandbyInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RemoveStandbyInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DisconnectInstanceResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 容灾切换接口，激活备集群解耦主备关系，如有全局地址等功能也会切换到备集群
      tags:
        - 多云产品实例相关RestAPI
  /api/v2/instances/{instanceId}/instanceName:
    put:
      summary: ModifyInstanceName
      operationId: ModifyInstanceName
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyInstanceNameRequestV2"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceNameResponseV2"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改OceanBase集群实例的显示名称。
      tags:
        - 多云产品实例相关RestAPI
  /api/v2/instances/{instanceId}/instanceType:
    get:
      summary: DescribeInstanceType
      description: 获取集群类型
      operationId: describeInstanceType
      parameters:
        - name: requestId
          in: query
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
          schema:
            type: string
        - name: instanceId
          in: path
          description: OceanBase集群ID
          required: true
          example: obcluster-*****
          schema:
            type: string
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OBCloudResultObcloudInstanceDo"
  /api/v2/instances/{instanceId}/nodes/options:
    get:
      summary: 查询节点监控的可选节点列表
      operationId: DescribeNodeOptions
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/NodeOptionDTO"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取可用于监控查询的节点列表选项。
      tags:
        - 多云Mysql模式监控metrics的RestAPI
  /api/v2/instances/{instanceId}/nodes/{nodeId}/metrics:
    post:
      summary: 查询集群节点监控
      operationId: DescribeNodeMetrics
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: nodeId
          in: path
          required: true
          schema:
            type: string
          description: 节点标识。
          example: node-1
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeMetricsRequestV2"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/JSONArray"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群节点级别的监控指标数据，包括CPU、内存、磁盘IO等。
      tags:
        - 多云Mysql模式监控metrics的RestAPI
  /api/v2/instances/{instanceId}/proxies:
    post:
      summary: 变更 ODP 集群规格配置
      operationId: ModifyOdpClusterSpec
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyOdpClusterSpecRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ODP集群架构升级。请求成功后返回创建的资源信息。
      tags:
        - 多云 ODP 相关 API
    get:
      summary: 查询实例对应的 ODP 集群
      operationId: DescribeProxyClusterForInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceODPForMonitorResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询实例对应的 ODP 集群。返回相关资源的详细信息。
      tags:
        - 多云 ODP 相关 OpenAPI
    put:
      summary: 变更 ODP 集群规格配置
      operationId: ModifyOdpClusterSpec_proxies
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyOdpClusterSpecRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 变更 ODP 集群规格配置。修改后的配置可能需要一定时间生效。
      tags:
        - 多云 ODP 相关 OpenAPI
  /api/v2/instances/{instanceId}/switchoverInstance:
    post:
      summary: SwitchoverInstance
      operationId: SwitchoverInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SwitchoverInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/SwitchoverInstanceResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 主备切换接口，将目标实例切换为主集群。仅在主备库都正常的情况下可以切换
      tags:
        - 多云产品实例相关RestAPI
  /api/v2/instances/{instanceId}/tenantCreateConstraints:
    get:
      summary: 查询租户创建约束
      operationId: GetTenantCreateConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: tenantModel
          in: query
          required: false
          schema:
            type: string
          description: 租户模式
          example: MYSQL
        - name: tenantMode
          in: query
          required: true
          schema:
            type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        - name: timeZoneSearchKey
          in: query
          required: false
          schema:
            type: string
          description: Time zone search key参数
          example: 2026-02-25T15:40:43Z
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/TenantCreateConstraints"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取创建租户时的约束条件，包括可用的租户模式、字符集、时区列表等配置选项。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenantCreateCpuConstraints:
    get:
      summary: 查询租户创建cpu约束
      operationId: GetTenantCreateCpuConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/UnitCpuConstraint"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取创建租户时可选的CPU规格列表，用于资源规划。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenantCreateMemConstraints:
    get:
      summary: 查询租户创建内存约束
      operationId: GetTenantCreateMemConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: unitNum
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: Unit 数量。
          example: 1
        - name: cpu
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: 处理器核数或规格信息。
          example: 4
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/UnitCpuMemConstraint"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 根据指定的CPU核数和节点数，获取创建租户时可选的内存规格范围。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants:
    get:
      summary: 条件查询租户
      operationId: DescribeTenants
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: tenantName
          in: query
          required: false
          schema:
            type: string
          description: 租户名称
          example: pay_core
        - name: tagList
          in: query
          required: false
          schema:
            type: string
          description: 标签列表
          example: "[{tagKey=env, tagValue=prod}]"
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataTenantDTO"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 条件查询租户。返回相关资源的详细信息。
      tags:
        - 多云OB租户相关API
    post:
      summary: 创建租户
      operationId: CreateTenants
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTenantRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateTenantResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 在指定OceanBase集群中创建新租户，需指定租户名、资源规格、字符集等配置。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}:
    get:
      summary: 查询特定租户
      operationId: DescribeTenant
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/TenantDTO"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: '*** 已拆分出接口describeTenantBasicInfo，只保留 ODP，binlog，RAG等相关字段，云平台领域相关基础字段的迭代请使用
        describeTenantBasicInfo 接口，勿在本接口上修改。'
      tags:
        - 多云OB租户相关API
    put:
      summary: 修改租户
      operationId: UpdateTenant
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTenantRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/SimpleTenantResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 更新租户的配置信息，如资源规格、描述等。修改可能需要一定时间生效。
      tags:
        - 多云OB租户相关API
    delete:
      summary: 删除租户
      operationId: DeleteTenant
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/SimpleTenantResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除指定租户及其所有数据。此操作不可逆，请谨慎执行。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/anomalySql:
    get:
      summary: 查询AnomalySQL
      operationId: DescribeOasAnomalySQLList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
          description: 排序顺序
          example: DESC
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
        - name: sqlId
          in: query
          required: false
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询AnomalySQL。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/databases:
    get:
      summary: DescribeDatabases
      operationId: DescribeDatabases
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: databaseName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: |-
            ---
            - "test_db"
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingData"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取指定租户内的所有数据库列表，支持分页查询。返回数据库名称、字符集、状态等信息。
      tags:
        - 多云Mysql模式Database相关RestAPI
    post:
      summary: CreateDatabase
      operationId: CreateDatabase
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDatabaseRequestV2"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    additionalProperties:
                      type: string
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 在指定租户内创建新数据库，需指定数据库名称和字符集。
      tags:
        - 多云Mysql模式Database相关RestAPI
    delete:
      operationId: DeleteDatabases
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteDatabasesParamDo"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户内的指定数据库。此操作会删除数据库内所有数据，不可恢复。
      tags:
        - 多云Mysql模式Database相关RestAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/metrics:
    post:
      operationId: DescribeTenantMetrics
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeMetricsRequestV2"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/JSONArray"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Describe Tenant Metrics
      tags:
        - 多云Mysql模式监控metrics的RestAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink:
    get:
      summary: 查询租户的privatelink地址信息
      operationId: DescribeTenantPrivateLink
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: addressId
          in: query
          required: false
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/TenantConnectionDTO"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户的PrivateLink私网连接地址信息，用于VPC内网访问。
      tags:
        - 多云OB租户地址相关API
    delete:
      summary: 删除privatelink地址
      operationId: DeletePrivatelinkConnection
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: addressId
          in: query
          required: true
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户的PrivateLink终端节点。删除后相关私网连接将不可用。
      tags:
        - 多云OB租户地址相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/user:
    post:
      summary: 租户private link service增加白名单用户
      operationId: AddPrivatelinkServiceUser
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddTenantPlServiceUserRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/AddTenantPlServiceUserResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 为租户的PrivateLink服务添加白名单用户，允许指定账号访问私网服务。
      tags:
        - 多云OB租户地址相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/publicaddress:
    get:
      summary: 查询租户的公网主地址
      operationId: DescribeTenantPublicAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/TenantConnectionDTO"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户的公网访问地址信息，包括域名、端口等。
      tags:
        - 多云OB租户地址相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups:
    get:
      summary: DescribeTenantSecurityIpGroups
      operationId: DescribeTenantSecurityIpGroups
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingData"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取租户的IP白名单组列表，用于访问控制。
      tags:
        - 多云白名单模块API
    post:
      summary: CreateTenantSecurityIpGroup
      operationId: CreateTenantSecurityIpGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McModifyTenantSecurityIpGroupRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifyTenantSecurityIpGroupResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 为租户创建新的IP白名单组，配置允许访问的IP地址范围。
      tags:
        - 多云白名单模块API
    put:
      summary: ModifyTenantSecurityIpGroup
      operationId: ModifyTenantSecurityIpGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McModifyTenantSecurityIpGroupRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifyTenantSecurityIpGroupResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户IP白名单组的配置，更新允许访问的IP地址列表。
      tags:
        - 多云白名单模块API
    delete:
      summary: DeleteTenantSecurityIpGroup
      operationId: DeleteTenantSecurityIpGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McDeleteTenantSecurityIpGroupRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDeleteTenantSecurityIpGroupResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户的IP白名单组。删除后相关IP将无法访问租户。
      tags:
        - 多云白名单模块API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/slowSql:
    get:
      summary: 查询SlowSQL
      operationId: DescribeOasSlowSQLList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
        - name: sqlId
          in: query
          required: false
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询慢SQL日志，获取执行时间超过阈值的SQL语句及其执行详情。
      tags:
        - 多云SQL诊断相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/text:
    get:
      summary: 查询SQL文本
      operationId: DescribeOasSQLText_text
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: true
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: parameterized
          in: query
          required: false
          schema:
            type: boolean
          description: Parameterized
          example: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询SQL文本。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantModifyCpuConstraints:
    get:
      summary: 查询租户修改cpu规格约束
      operationId: GetTenantModifyCpuConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/UnitCpuConstraint"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取修改租户CPU规格时可选的配置列表。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantModifyMemConstraints:
    get:
      summary: 查询租户修改内存规格约束
      operationId: GetTenantModifyMemConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: unitNum
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: Unit 数量。
          example: 1
        - name: cpu
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: 处理器核数或规格信息。
          example: 4
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/UnitCpuMemConstraint"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 根据当前CPU配置，获取修改租户内存规格时的可选范围。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantModifyResourceConstraints:
    get:
      summary: 查询租户修改资源规格约束
      operationId: GetTenantModifyResourceConstraints
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/TenantModifyResourceConstraints"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取修改租户资源规格时的约束条件，包括可扩展的资源范围。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantName:
    put:
      summary: 修改租户名称
      operationId: ModifyTenantName
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantNameRequestV2"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantNameResponseV2"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户的显示名称。名称修改后会影响连接字符串。
      tags:
        - 多云OB租户相关API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers:
    get:
      summary: 查询租户内的用户
      operationId: DescribeTenantUsers
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: userName
          in: query
          required: false
          schema:
            type: string
          description: 数据库登录用户名
          example: admin
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: searchKey
          in: query
          required: false
          schema:
            type: string
          description: 搜索关键字
          example: env
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询指定租户内的所有数据库用户列表，支持分页和关键字搜索。返回用户名、权限、创建时间等信息。
      tags:
        - 多云Mysql模式下租户用户的相关RestAPI
    delete:
      summary: 删除租户内特定用户
      operationId: DeleteTenantUsers
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteTenantUserParamDo"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 批量删除租户内的数据库用户。删除用户会同时移除该用户的所有权限和会话。
      tags:
        - 多云Mysql模式下租户用户的相关RestAPI
    post:
      summary: 创建租户内的用户
      operationId: CreateTenantUser
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateUserParamDo"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 在指定租户内创建新的数据库用户，可指定用户名、密码和初始权限。
      tags:
        - 多云Mysql模式下租户用户的相关RestAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/password:
    put:
      summary: 修改租户内的用户密码
      operationId: ModifyTenantUserPassword
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: userName
          in: path
          required: true
          schema:
            type: string
          description: 数据库登录用户名
          example: admin
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyUserPasswordParamDo"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户内指定数据库用户的登录密码。密码修改后立即生效，现有连接不受影响。
      tags:
        - 多云Mysql模式下租户用户的相关RestAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/topSql:
    get:
      summary: 查询TopSQL
      operationId: DescribeOasTopSQLList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: 结果数量限制
          example: 100
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
        - name: sqlId
          in: query
          required: false
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: customColumns
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: Custom columns参数
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询指定时间范围内的TopSQL列表，按执行时间、次数等指标排序，用于SQL性能分析。
      tags:
        - 多云SQL诊断相关API
  /api/v2/oms/project:
    get:
      summary: 查询项目详情
      description: |
        查询项目详情。对应 CommonProjectController.describeProject。
        在 AWS 网关上为 GET 请求，参数通过 query 传递。
        实际请求：GET /api/v2/oms/project?Action=DescribeProject&id=xxx&uid=xxx
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: describeProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
        - name: id
          in: query
          description: 资源唯一标识。
          required: true
          example: "244"
          schema:
            type: string
            example: np_7befdmp08juo
        - name: uid
          in: query
          description: 用户ID（可选）
          required: false
          example: "200006001999"
          schema:
            type: string
            example: "200006001999"
      responses:
        "200":
          description: 成功，data 为项目详情
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultProjectDetail"
    post:
      summary: 创建项目
      description: |
        创建数据迁移/同步项目。对应 CommonProjectController.createProject。
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: createProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为创建的项目ID
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultString"
    delete:
      summary: 删除项目
      description: |
        删除项目。对应 CommonProjectController.deleteProject。实际请求：DELETE /api/v2/oms/project。
        认证：HTTP Digest (-u 'ak:sk' --digest)。请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: deleteProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
            example: u6ayhdbufx7u5lpw90jhw7lc
          description: 多云项目ID
          example: proj-xxxxxxxx
        - name: X-Ob-Org-Id
          in: header
          required: true
          schema:
            type: string
            example: acpryz9pbt252whpeighrtem
          description: 多云组织ID
          example: org-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/modifyRecords:
    get:
      summary: 查询项目修改记录列表
      description: |
        根据项目ID查询项目的修改记录列表。对应 CommonModifyProjectController.listProjectModifyRecords。
        在 AWS 网关上为 GET 请求，参数通过 query 传递。
        实际请求：GET /api/v2/oms/project?Action=ListProjectModifyRecords&id=xxx&uid=xxx
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: listProjectModifyRecords
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
        - name: id
          in: query
          description: 资源唯一标识。
          required: true
          example: "244"
          schema:
            type: string
            example: np_7befdmp08juo
        - name: uid
          in: query
          description: 用户ID（可选）
          required: false
          example: "200006001999"
          schema:
            type: string
            example: "200006001999"
      responses:
        "200":
          description: 成功，data 为修改记录列表
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultModifyRecordList"
    put:
      summary: 修改传输对象记录（加减表）
      description: |
        创建修改传输对象记录（加减表），仅支持 RUNNING/FAILED/SUSPEND 状态的项目。对应 CommonModifyProjectController.createProjectModifyRecords。
        实际请求：PUT /api/v2/oms/project?Action=CreateProjectModifyRecords，请求体 JSON：id、uid、databases、transferMapping、precheckId（可选）。
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: createProjectModifyRecords
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateProjectModifyRecordsRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为创建的修改记录ID（long）
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultModifyRecordId"
  /api/v2/oms/project/modifyRecords/cancel:
    post:
      summary: 取消修改记录
      description: |
        根据修改记录ID取消修改操作，仅支持 PENDING 状态的记录。对应 CommonModifyProjectController.cancelProjectModifyRecord。
        实际请求：POST /api/v2/oms/project?Action=CancelProjectModifyRecord
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: cancelProjectModifyRecord
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/modifyRecords/retry:
    post:
      summary: 重试修改记录
      description: |
        根据修改记录ID重试修改操作，仅支持 FAILED 状态的记录。对应 CommonModifyProjectController.retryProjectModifyRecords。
        实际请求：POST /api/v2/oms/project?Action=RetryProjectModifyRecords
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: retryProjectModifyRecords
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/modifyRecords/stop:
    post:
      summary: 终止修改记录
      description: |
        根据修改记录ID终止修改操作，仅支持 RUNNING/FAILED 状态的记录，不可恢复。对应 CommonModifyProjectController.stopProjectModifyRecords。
        实际请求：POST /api/v2/oms/project?Action=StopProjectModifyRecords
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: stopProjectModifyRecords
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/release:
    post:
      summary: 释放项目
      description: |
        释放项目。对应 CommonProjectController.releaseProject。
        实际请求：POST /api/v2/oms/project?Action=ReleaseProject
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: releaseProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReleaseProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/resume:
    post:
      summary: 恢复项目
      description: |
        恢复项目。对应 CommonProjectController.resumeProject。
        实际请求：POST /api/v2/oms/project?Action=ResumeProject
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: resumeProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ResumeProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/start:
    post:
      summary: 启动项目
      description: |
        启动项目。对应 CommonProjectController.startProject。
        实际请求：POST /api/v2/oms/project?Action=StartProject
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: startProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StartProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/steps:
    get:
      summary: 查询项目步骤
      description: |
        查询项目步骤列表。对应 CommonProjectController.describeProjectSteps。
        在 AWS 网关上为 GET 请求，参数通过 query 传递。
        实际请求：GET /api/v2/oms/project?Action=DescribeProjectSteps&id=xxx&uid=xxx
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: describeProjectSteps
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
        - name: id
          in: query
          description: 资源唯一标识。
          required: true
          example: "244"
          schema:
            type: string
            example: np_7befdmp08juo
        - name: uid
          in: query
          description: 用户ID（可选）
          required: false
          example: "200006001999"
          schema:
            type: string
            example: "200006001999"
      responses:
        "200":
          description: 成功，data 为项目步骤列表
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultProjectStepList"
  /api/v2/oms/project/stop:
    post:
      summary: 暂停项目
      description: |
        暂停项目。对应 CommonProjectController.stopProject。
        实际请求：POST /api/v2/oms/project?Action=StopProject
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: stopProject
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StopProjectRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/oms/project/updateConfig:
    put:
      summary: 更新项目配置
      description: |
        更新项目配置，全量替换式更新（需传入完整配置，未传即删，仅差异项会落库）。对应 CommonProjectController.updateProjectConfig。
        实际请求：PUT /api/v2/oms/project?Action=UpdateProjectConfig，请求体 JSON：id、uid、fullTransferConfig 等配置项。
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: updateProjectConfig
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateProjectConfigRequest"
        required: true
      responses:
        "200":
          description: 成功，data 为空
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultVoid"
  /api/v2/commodityService/completeOrderParam:
    post:
      summary: CompleteOrderParam
      operationId: CompleteOrderParam
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CompleteOrderParamRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CompleteOrderParamResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CompleteOrderParam。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/commodityService/orderInfo:
    post:
      summary: OrderInfo
      operationId: OrderInfo
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/QueryOrderInfoRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CommodityServiceBaseResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: OrderInfo。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/commodityService/orderVerify:
    post:
      summary: OrderVerify
      operationId: OrderVerify
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OrderVerifyRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CommodityServiceBaseResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: OrderVerify。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/commodityService/payOrderCallBack:
    post:
      summary: PayOrderCallBack
      operationId: PayOrderCallBack
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PayOrderCallBackRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CommodityServiceBaseResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: PayOrderCallBack。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/commodityService/processMessage:
    post:
      summary: ProcessMessage
      operationId: ProcessMessage
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProcessMessageRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CommodityServiceBaseResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ProcessMessage。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances:
    get:
      summary: DescribeInstances
      description: "下面接口需要调用 用户控制台侧接口controller, 避免循环加载注解, 由用户控制台侧注解进行鉴权 , 因此去掉此处\
        OcpAnnotation和OcpAuth注解,"
      operationId: DescribeInstances
      parameters:
        - name: instanceName
          in: query
          required: false
          schema:
            type: string
          description: 集群名称
          example: test-cluster
        - name: tenantSearchKey
          in: query
          required: false
          schema:
            type: string
          description: Tenant search key参数
          example: env
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: instanceId
          in: query
          required: false
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tagList
          in: query
          required: false
          schema:
            type: string
          description: 标签列表
          example: "[{tagKey=env, tagValue=prod}]"
        - name: organizationId
          in: query
          required: false
          schema:
            type: string
          description: Organization id参数
          example: resource-123456
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataDescribeInstancesResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      tags:
        - MultiCloudOpenAPI
    post:
      summary: CreateInstance
      description: "以下接口由于没有用户控制台侧接口, 因此直接调用service层, 同时加上OcpAnnotation和OcpAuth注解"
      operationId: CreateInstance
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudCreateInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      tags:
        - MultiCloudOpenAPI
    delete:
      summary: DeleteInstance
      operationId: DeleteInstance
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteInstanceOpenRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DeleteInstanceResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除指定的OceanBase集群实例。此操作会删除实例内所有数据，不可恢复。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}:
    get:
      summary: DescribeInstance
      operationId: DescribeInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取指定OceanBase集群实例的详细信息，包括规格、状态、创建时间等。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/address/info:
    get:
      summary: 获取代理地址列表
      operationId: DescribeTenantAddressInfo
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: tenantIds
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
          description: Tenant ids参数
          example:
            - t4louaeei****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataTenantDTOOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取代理地址列表。返回相关资源的详细信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/availableRoZones:
    get:
      summary: 获取集群的可变更只读副本可用区列表
      operationId: DescribeInstanceAvailableRoZones
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeInstanceAvailableRoZonesRequestOpenApi"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceAvailableRoZonesResponseOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取集群的可变更只读副本可用区列表。返回相关资源的详细信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/backup/data/check:
    post:
      summary: PreCheckCreateDataBackupTask
      operationId: PreCheckCreateDataBackupTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/PreCheckCreateDataBackupTaskResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: PreCheckCreateDataBackupTask。请求成功后返回创建的资源信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/data/sets:
    get:
      summary: DescribeDataBackupSet
      operationId: DescribeDataBackupSet
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: startTime
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: checkBackupSetDownloadEnable
          in: query
          required: false
          schema:
            type: boolean
          description: Check backup set download enable参数
          example: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataDescribeDataBackupSetResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeDataBackupSet。返回相关资源的详细信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/data/sets/{backupTaskId}:
    get:
      summary: DescribeOneDataBackupSet
      operationId: DescribeOneDataBackupSet
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: backupTaskId
          in: path
          required: true
          schema:
            type: string
          description: Backup task id参数
          example: backup_task_123456
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: checkBackupSetDownloadEnable
          in: query
          required: false
          schema:
            type: boolean
          description: Check backup set download enable参数
          example: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeDataBackupSetResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeOneDataBackupSet。返回相关资源的详细信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/data/start:
    post:
      summary: CreateDataBackupTask
      operationId: CreateDataBackupTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDataBackupTaskRequestV2OpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    additionalProperties:
                      type: string
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CreateDataBackupTask。请求成功后返回创建的资源信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/link:
    post:
      summary: CreateBackupSetDownloadLink
      operationId: CreateBackupSetDownloadLink
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateBackupSetDownloadLinkRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateBackupSetDownloadLinkResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CreateBackupSetDownloadLink。请求成功后返回创建的资源信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/link/{downloadTaskId}:
    get:
      summary: DescribeBackupSetDownloadLink
      operationId: DescribeBackupSetDownloadLink
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: downloadTaskId
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: Download task id参数
          example: 10001
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeBackupSetDownloadLinkResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeBackupSetDownloadLink。返回相关资源的详细信息。
      tags:
        - 多云备份恢复相关OpenAPI
    delete:
      summary: DeleteBackupSetDownloadTask
      operationId: DeleteBackupSetDownloadTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: downloadTaskId
          in: path
          required: true
          schema:
            type: integer
            format: int64
          description: Download task id参数
          example: 10001
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DeleteBackupSetDownloadTask。此操作可能不可逆，请谨慎执行。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/overview:
    get:
      summary: DescribeBackupInfo
      operationId: DescribeBackupInfo
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeBackupInfoResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeBackupInfo。返回相关资源的详细信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/restore:
    post:
      summary: CreateTenantRestoreTask
      operationId: CreateTenantRestoreTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTenantRestoreTaskRequestV2OpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    additionalProperties:
                      type: string
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CreateTenantRestoreTask。请求成功后返回创建的资源信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/restore/tasks:
    get:
      summary: DescribeRestoreTask
      operationId: DescribeRestoreTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: startTime
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: queryInstanceRole
          in: query
          required: false
          schema:
            type: string
          description: 恢复任务查询视角，SOURCE 表示按源实例查询，TARGET 表示按目标实例查询
          example: TARGET
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataDescribeRestoreTaskResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeRestoreTask。返回相关资源的详细信息。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/restore/tenants:
    get:
      summary: DescribeRestorableTenants
      operationId: DescribeRestorableTenants
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: restoreType
          in: query
          required: false
          schema:
            type: string
          description: Restore type参数
          example: NORMAL
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeRestorableTenantsRequestV2OpenAPI"
          description: Open request参数
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/DescribeRestorableTenantsResponseV2OpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取可用于恢复的租户和备份集列表。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/backup/strategy:
    get:
      summary: DescribeBackupStrategy
      operationId: DescribeBackupStrategy
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeBackupStrategyResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取集群的备份策略配置，包括备份周期、保留时间等。
      tags:
        - 多云备份恢复相关OpenAPI
    post:
      summary: ModifyBackupStrategy
      operationId: ModifyBackupStrategy
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyBackupStrategyRequestV2OpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    additionalProperties:
                      type: string
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改集群的备份策略配置。
      tags:
        - 多云备份恢复相关OpenAPI
  /api/v2/instances/{instanceId}/capacity/resourceProfile:
    get:
      summary: 查询一个集群的 CPU/内存/磁盘 资源，以及各个租户资源的使用趋势评估报告
      operationId: DescribeInstanceCapacityProfile
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeCapacityResourceRequestOpenAPI"
          description: Open request参数
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询一个集群的 CPU/内存/磁盘 资源，以及各个租户资源的使用趋势评估报告
      tags:
        - 多云容量中心相关OpenAPI
  /api/v2/instances/{instanceId}/dataMergeTime:
    get:
      summary: DescribeTenantsDataMergeTime
      operationId: DescribeTenantsDataMergeTime
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeTenantsDataMergeTime。返回相关资源的详细信息。
      tags:
        - 多云产品实例合并相关OpenAPI
    put:
      summary: ModifyInstanceDataMergeTime
      operationId: ModifyInstanceDataMergeTime
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyInstanceDataMergeTimeRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ModifyInstanceDataMergeTime。修改后的配置可能需要一定时间生效。
      tags:
        - 多云产品实例合并相关OpenAPI
  /api/v2/instances/{instanceId}/merge:
    get:
      summary: DescribeInstanceMergeDetail
      operationId: DescribeInstanceMergeDetail
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: tenantId
          in: query
          required: false
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: lastCount
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: Last count参数
          example: 3
        - name: startTime
          in: query
          required: false
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: false
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeInstanceMergeDetail。返回相关资源的详细信息。
      tags:
        - 多云产品实例合并相关OpenAPI
    post:
      summary: MergeInstanceData
      operationId: MergeInstanceData
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MergeInstanceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/Object"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: MergeInstanceData。请求成功后返回创建的资源信息。
      tags:
        - 多云产品实例合并相关OpenAPI
  /api/v2/instances/{instanceId}/nodeNum:
    put:
      summary: ModifyInstanceNodeNum
      operationId: ModifyInstanceNodeNum
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudModifyInstanceNodeNumRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ModifyInstanceNodeNum。修改后的配置可能需要一定时间生效。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/operations:
    get:
      summary: 获取集群操作信息
      operationId: DescribeInstanceOperation
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeInstanceOperationParamDoOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceOperationResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取集群操作信息。返回相关资源的详细信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/parameters:
    get:
      summary: DescribeInstanceParameters
      operationId: DescribeInstanceParameters
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/OcpParameterDTOOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeInstanceParameters。返回相关资源的详细信息。
      tags:
        - 多云参数管理模块Open API
    put:
      summary: UpdateInstanceParameters
      operationId: UpdateInstanceParameters
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/ObParameterValueOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CheckParameterResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: UpdateInstanceParameters。修改后的配置可能需要一定时间生效。
      tags:
        - 多云参数管理模块Open API
  /api/v2/instances/{instanceId}/parameters/history:
    get:
      summary: DescribeInstanceParametersHistory
      operationId: DescribeInstanceParametersHistory
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/McDescribeParametersHistoryRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeParametersHistoryResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeInstanceParametersHistory。返回相关资源的详细信息。
      tags:
        - 多云参数管理模块Open API
  /api/v2/instances/{instanceId}/readonlyInstance:
    get:
      summary: DescribeReadonlyInstances
      operationId: DescribeReadonlyInstances
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: physicalZone
          in: query
          required: false
          schema:
            type: string
          description: 物理可用区
          example: zone_1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeReadonlyInstancesResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeReadonlyInstances。返回相关资源的详细信息。
      tags:
        - MultiCloudOpenAPI
    post:
      operationId: CreateReadonlyInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudCreateReadOnlyInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Create Read Only Instance
      tags:
        - MultiCloudOpenAPI
    delete:
      operationId: DeleteReadonlyInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudDeleteReadOnlyInstanceRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Delete Read Only Instance
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/readonlyInstance/diskSize:
    put:
      operationId: ModifyReadonlyInstanceDiskSize
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudModifyReadOnlyInstanceDiskSizeRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Modify Read Only Instance Disk Size
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/readonlyInstance/nodeNum:
    put:
      operationId: ModifyReadonlyInstanceNodeNum
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudModifyReadOnlyInstanceNodeNumRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Modify Read Only Instance Node Num
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/readonlyInstance/spec:
    put:
      operationId: ModifyReadonlyInstanceSpec
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudModifyReadOnlyInstanceSpecRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: Modify Read Only Instance Spec
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/security/securityConfig:
    get:
      summary: 集群安全检测项
      operationId: DescribeInstanceSecurityConfigs
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: checkId
          in: query
          required: false
          schema:
            type: string
          description: Check id参数
          example: resource-123456
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceSecurityConfigsResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 集群安全检测项。返回相关资源的详细信息。
      tags:
        - 多云安全评估相关OpenAPI
  /api/v2/instances/{instanceId}/security/ssl:
    get:
      summary: 查询SSL链路加密信息
      operationId: DescribeInstanceSSL
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeInstanceSSLResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群实例的SSL加密配置状态和证书信息。
      tags:
        - 多云SSL相关OpenAPI
    put:
      summary: 开启/关闭/更新SSL链路加密
      operationId: ModifyInstanceSSL
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyInstanceSSLRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceSSLResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改集群实例的SSL加密配置，启用或禁用SSL连接。
      tags:
        - 多云SSL相关OpenAPI
  /api/v2/instances/{instanceId}/security/tde:
    get:
      summary: 查询集群下租户加密信息
      operationId: DescribeTenantEncryption
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: tenantName
          in: query
          required: false
          schema:
            type: string
          description: 租户名称
          example: pay_core
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantEncryptionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群下租户加密信息。返回相关资源的详细信息。
      tags:
        - 多云 TDE 相关 OpenAPI
  /api/v2/instances/{instanceId}/security/tenantSecurityConfig:
    get:
      summary: 租户安全检测项
      operationId: DescribeTenantSecurityConfigs
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: query
          required: false
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: checkId
          in: query
          required: false
          schema:
            type: string
          description: Check id参数
          example: resource-123456
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantSecurityConfigsResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 租户安全检测项。返回相关资源的详细信息。
      tags:
        - 多云安全评估相关OpenAPI
  /api/v2/instances/{instanceId}/securityIpGroups:
    get:
      summary: DescribeSecurityIpGroups
      operationId: DescribeSecurityIpGroups
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingData"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeSecurityIpGroups。返回相关资源的详细信息。
      tags:
        - 多云白名单模块OpenAPI
    post:
      summary: CreateSecurityIpGroup
      operationId: CreateSecurityIpGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McModifySecurityIpGroupRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifySecurityIpGroupRequestOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CreateSecurityIpGroup。请求成功后返回创建的资源信息。
      tags:
        - 多云白名单模块OpenAPI
    put:
      summary: ModifySecurityIps
      operationId: ModifySecurityIps
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McModifySecurityIpGroupRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifySecurityIpGroupRequestOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ModifySecurityIps。修改后的配置可能需要一定时间生效。
      tags:
        - 多云白名单模块OpenAPI
    delete:
      summary: DeleteSecurityIpGroup
      operationId: DeleteSecurityIpGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McDeleteSecurityIpGroupRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDeleteSecurityIpGroupRequestOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DeleteSecurityIpGroup。此操作可能不可逆，请谨慎执行。
      tags:
        - 多云白名单模块OpenAPI
  /api/v2/instances/{instanceId}/session/stats:
    get:
      summary: 查询当前集群实时诊断-会话的统计信息，包括租户维度的会话数、活跃会话数、7天内死锁信息
      operationId: DescribeOasSessionStatistics
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: tenantId
          in: query
          required: false
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询当前集群实时诊断-会话的统计信息，包括租户维度的会话数、活跃会话数、7天内死锁信息
      tags:
        - 多云OAS集群维度SQL诊断相关Open API
  /api/v2/instances/{instanceId}/spec:
    put:
      summary: ModifyInstanceSpec
      operationId: ModifyInstanceSpec
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MultiCloudModifyInstanceSpecRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyInstanceResponseV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 调整集群实例的资源规格，包括节点数、CPU、内存等配置。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/sqlaudit/info:
    get:
      summary: 查询集群SQL审计服务信息
      operationId: DescribeInstanceSqlAuditServiceInfo
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSqlAuditsRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/McDescribeSqlCollectorRetentionResponseOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群SQL审计服务信息。返回相关资源的详细信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/sqlaudit/modify:
    put:
      summary: 修改SQL审计服务时长（集群下所有租户）
      operationId: ModifySqlCollectorRetention
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifySqlCollectorRetentionRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifySqlCollectorRetentionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改SQL审计服务时长（集群下所有租户）。修改后的配置可能需要一定时间生效。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/sqlaudit/open:
    post:
      summary: 开启SQL审计服务(集群)
      operationId: CreateInstanceSqlAuditService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateSqlAuditServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 开启SQL审计服务(集群)。请求成功后返回创建的资源信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/startCluster:
    put:
      summary: StartCluster
      operationId: StartCluster
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: string
                    description: 业务数据(object)
                    example: |-
                      ---
                      id: "resource-123456"
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: StartCluster。修改后的配置可能需要一定时间生效。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/statistics:
    get:
      summary: 查询当前集群实时诊断-SQL的统计信息，包括租户维度的 可疑SQL/SlowSQL 汇总信息
      operationId: DescribeOasDiagStatistics
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: tenantId
          in: query
          required: false
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询当前集群实时诊断-SQL的统计信息，包括租户维度的 可疑SQL/SlowSQL 汇总信息
      tags:
        - 多云OAS集群维度SQL诊断相关Open API
  /api/v2/instances/{instanceId}/stopCluster:
    put:
      summary: StopCluster
      operationId: StopCluster
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: string
                    description: 业务数据(object)
                    example: |-
                      ---
                      id: "resource-123456"
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: StopCluster。修改后的配置可能需要一定时间生效。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/tagList:
    post:
      summary: ModifyInstanceTagList
      operationId: ModifyInstanceTagList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ResourceTagRequestV2OpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ModifyInstanceTagList。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/operations:
    get:
      summary: 获取租户操作信息
      operationId: DescribeTenantOperation
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeTenantOperationParamDoOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantOperationResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取租户操作信息
      tags:
        - MultiCloudOpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/address:
    get:
      summary: 查询租户地址
      operationId: DescribeTenantAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: addressId
          in: query
          required: true
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/TenantConnectionDTOOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户的网络连接地址列表，包括私网和公网地址。
      tags:
        - 多云OB租户相关OpenAPI
    post:
      summary: 新建租户地址
      operationId: CreateTenantAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMcTenantAddressRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateMcTenantAddressResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 为租户创建新的网络连接地址。
      tags:
        - 多云OB租户相关OpenAPI
    delete:
      summary: 删除租户地址
      operationId: DeleteTenantAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: addressId
          in: query
          required: true
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户的指定网络连接地址。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/addressPort:
    put:
      summary: 修改租户地址端口
      operationId: ModifyTenantAddressPort
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantAddressPortRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantAddressPortResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户连接地址的端口号。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/availableRoZones:
    get:
      summary: 查询租户可变更的只读副本的可用区列表
      operationId: DescribeTenantAvailableRoZones
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeAvailableRoZonesRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeAvailableRoZonesResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户可变更的只读副本的可用区列表。返回相关资源的详细信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/binlog/commodity:
    get:
      summary: DescribeBinlogCommodityProduceInfo
      operationId: DescribeBinlogCommodityProduceInfo
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: orderId
          in: query
          required: false
          schema:
            type: string
          description: Order id参数
          example: order_123456789
        - name: uid
          in: query
          required: false
          schema:
            type: string
          description: 用户 ID。
          example: "200006001999"
        - name: productType
          in: query
          required: true
          schema:
            type: string
          description: Product type参数
          example: OB_CLUSTER
        - name: tradeInstanceId
          in: query
          required: true
          schema:
            type: string
          description: Trade instance id参数
          example: trade-123456
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeBinlogCommodityProduceInfoResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeBinlogCommodityProduceInfo。返回相关资源的详细信息。
      tags:
        - MultiCloudBinlogCommodityOpenAPI
    post:
      summary: ProduceBinlogCommodityInstance
      operationId: ProduceBinlogCommodityInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProduceBinlogCommodityInstanceRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ProduceBinlogCommodityInstanceResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ProduceBinlogCommodityInstance。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudBinlogCommodityOpenAPI
    put:
      summary: OperateBinlogCommodityInstance
      operationId: OperateBinlogCommodityInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/OperateBinlogCommodityInstanceRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OperateBinlogCommodityInstanceResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: OperateBinlogCommodityInstance。修改后的配置可能需要一定时间生效。
      tags:
        - MultiCloudBinlogCommodityOpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/binlog/commodity/precheck:
    post:
      summary: PreCheckBinlogCommodityInstance
      operationId: PreCheckBinlogCommodityInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PreCheckBinlogCommodityInstanceRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/PreCheckBinlogCommodityInstanceResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: PreCheckBinlogCommodityInstance。请求成功后返回创建的资源信息。
      tags:
        - MultiCloudBinlogCommodityOpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/binlog/service:
    get:
      summary: DescribeBinlogService
      operationId: DescribeBinlogService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeBinlogServiceResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询Binlog服务的配置和状态信息。
      tags:
        - MultiCloudBinlogOpenAPI
    post:
      summary: CreateBinlogService
      operationId: CreateBinlogService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateBinlogServiceRequestForOpenApi"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateBinlogServiceResponseForOpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 为租户创建Binlog服务，用于数据同步和CDC场景。
      tags:
        - MultiCloudBinlogOpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/databases/{databaseName}/authorization:
    post:
      summary: 修改角色列表
      operationId: ModifyDatabaseUserRoles
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: databaseName
          in: path
          required: true
          schema:
            type: string
          description: 数据库名称
          example: |-
            ---
            - "test_db"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyDatabaseUserRolesParamDoOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改角色列表。请求成功后返回创建的资源信息。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/databasesByTenantId:
    get:
      summary: 获取数据库列表
      operationId: DescribeDatabasesByTenantId
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: withTables
          in: query
          required: false
          schema:
            type: boolean
          description: With tables参数
          example: true
        - name: pageSize
          in: query
          required: false
          schema:
            type: string
          description: 分页大小
          example: "10"
        - name: pageNumber
          in: query
          required: false
          schema:
            type: string
          description: 分页页码
          example: "1"
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取指定租户内的所有数据库列表，支持分页查询。返回数据库名称、字符集、状态等信息。
      tags:
        - 多云Mysql模式Database相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/domainPrefix:
    put:
      summary: 修改租户域名前缀
      operationId: ModifyTenantAddressDomainPrefix
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantAddressDomainPrefixRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantAddressDomainPrefixResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户连接地址的域名前缀。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/outlines/history:
    get:
      summary: 近期绑定历史记录
      operationId: DescribeOptimizedRecords
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 近期绑定历史记录。返回相关资源的详细信息。
      tags:
        - 多云计划绑定相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/outlines/historyTask:
    get:
      summary: 查询优化记录
      operationId: DescribeOasOutlineHistory
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询优化记录。返回相关资源的详细信息。
      tags:
        - 多云计划绑定相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/outlines/task:
    post:
      summary: 提交一个outline创建任务
      operationId: CreateOasOutlineTask
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McCreateOutlineRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 提交一个outline创建任务。请求成功后返回创建的资源信息。
      tags:
        - 多云计划绑定相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/parameters:
    get:
      summary: DescribeTenantParameters
      operationId: DescribeTenantParameters
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/OcpParameterDTOOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeTenantParameters。返回相关资源的详细信息。
      tags:
        - 多云参数管理模块Open API
    put:
      summary: UpdateTenantParameters
      operationId: UpdateTenantParameters
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/ObParameterValueOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CheckParameterResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: UpdateTenantParameters。修改后的配置可能需要一定时间生效。
      tags:
        - 多云参数管理模块Open API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/parameters/history:
    get:
      summary: DescribeTenantParametersHistory
      operationId: DescribeTenantParametersHistory
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/McDescribeParametersHistoryRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeParametersHistoryResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeTenantParametersHistory。返回相关资源的详细信息。
      tags:
        - 多云参数管理模块Open API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/primaryZone:
    put:
      summary: 修改租户主可用区
      operationId: ModifyTenantPrimaryZone
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantPrimaryZoneRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantPrimaryZoneResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户的主可用区设置，用于故障切换和负载均衡。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/confirmation:
    post:
      summary: 确认完成 private link 私网连接
      operationId: ConfirmPrivatelinkConnection
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConfirmTenantPlServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 确认完成 private link 私网连接。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/connection:
    post:
      summary: 连接 private link 私网地址
      operationId: ConnectPrivatelinkService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConnectTenantPlServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ConnectTenantPlServiceResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 连接 private link 私网地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/endpoint:
    delete:
      summary: 删除 private link 地址
      operationId: DeletePrivatelinkEndpoint
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: addressId
          in: query
          required: false
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
        - name: endpointId
          in: query
          required: false
          schema:
            type: string
          description: Endpoint id参数
          example: ep-xxxxxx
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: 任务或资源当前状态
          example: |-
            ---
            - "ONLINE"
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户的PrivateLink终端节点。删除后相关私网连接将不可用。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/readonly:
    post:
      summary: 创建租户的私网只读地址
      operationId: CreateReadonlyPrivatelink
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateReadonlyConnectionRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateReadonlyConnectionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 创建租户的私网只读地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/readwrite:
    post:
      summary: 创建租户的私网读写分离地址
      operationId: CreateReadwritePrivatelink
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateReadonlyConnectionRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateReadonlyConnectionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 创建租户的私网读写分离地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/service:
    post:
      summary: 创建租户的 private link 私网主地址
      operationId: CreatePrivatelinkService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTenantPlServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateTenantPlServiceResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 创建租户的 private link 私网主地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/publicKey:
    get:
      summary: 获取租户用户加密使用密钥
      operationId: DescribeEncryptionPublicKey
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: encryptionType
          in: query
          required: true
          schema:
            type: string
          description: Encryption type参数
          example: NORMAL
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取租户用户加密使用密钥。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplica:
    post:
      summary: 修改只读副本的可用区列表
      operationId: ModifyTenantReadonlyReplica
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantReadonlyReplicaRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantReadonlyReplicaResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改只读副本的可用区列表。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplicaCreateCpuConstraints:
    get:
      summary: 查询只读副本创建时的 CPU 约束
      operationId: GetTenantCpuConstraintsForCreate
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: logicalZone
          in: query
          required: true
          schema:
            type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/ReadonlyZoneCpuConstraintOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询只读副本创建时的 CPU 约束
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplicaCreateMemConstraints:
    get:
      summary: 查询只读副本创建时的内存约束
      operationId: GetTenantMemConstraintsForCreate
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: logicalZone
          in: query
          required: true
          schema:
            type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        - name: unitNum
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: Unit 数量。
          example: 1
        - name: cpu
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: 处理器核数或规格信息。
          example: 4
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ReadonlyZoneCpuMemConstraintOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询只读副本创建时的内存约束
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplicaModifyCpuConstraints:
    get:
      summary: 查询只读副本变配时的 CPU 约束
      operationId: GetTenantCpuConstraintsForModify
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: logicalZone
          in: query
          required: true
          schema:
            type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/ReadonlyZoneCpuConstraintOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询只读副本变配时的 CPU 约束
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/readonlyReplicaModifyMemConstraints:
    get:
      summary: 查询只读副本变配时的内存约束
      operationId: GetTenantMemConstraintsForModify
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: logicalZone
          in: query
          required: true
          schema:
            type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        - name: unitNum
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: Unit 数量。
          example: 1
        - name: cpu
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: 处理器核数或规格信息。
          example: 4
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ReadonlyZoneCpuMemConstraintOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询只读副本变配时的内存约束
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/tde:
    post:
      summary: 租户开启透明加密
      operationId: ModifyTenantEncryption
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantEncryptionRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantEncryptionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 租户开启透明加密。请求成功后返回创建的资源信息。
      tags:
        - 多云 TDE 相关 OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/serviceNetwork:
    post:
      summary: 新建租户服务网卡地址
      operationId: CreateTenantServiceNetworkAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateServiceNetworkAddressRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateMcTenantAddressResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 新建租户服务网卡地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/serviceNetwork/{addressId}:
    delete:
      summary: 删除租户服务网卡地址
      operationId: DeleteTenantServiceNetworkAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: addressId
          in: path
          required: true
          schema:
            type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户服务网卡地址。此操作可能不可逆，请谨慎执行。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions:
    get:
      summary: 查询实时会话信息
      operationId: DescribeProcessStatsComposition
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: 任务或资源当前状态
          example: |-
            ---
            - "ONLINE"
        - name: sqlText
          in: query
          required: false
          schema:
            type: string
          description: SQL语句文本
          example: SELECT * FROM users WHERE id = 1
        - name: clientIp
          in: query
          required: false
          schema:
            type: string
          description: Client ip参数
          example: successful
        - name: serverIp
          in: query
          required: false
          schema:
            type: string
          description: Server ip参数
          example: 10.0.0.10
        - name: users
          in: query
          required: false
          schema:
            type: string
          description: Users参数
          example: admin
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeProcessListCompositionDTOOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询实时会话信息。返回相关资源的详细信息。
      tags:
        - 多云会话相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions/analysis:
    get:
      summary: 会话10秒分析
      operationId: DescribeSessionAnalysis
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeSessionAnalysisResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 会话10秒分析。返回相关资源的详细信息。
      tags:
        - 多云会话相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions/batchKill:
    post:
      summary: 关闭会话
      operationId: BatchKillProcessList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CloseSessionParamOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McKillAllProcessResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 关闭会话。请求成功后返回创建的资源信息。
      tags:
        - 多云会话相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/criteria:
    get:
      summary: SQL审计查询条件
      operationId: DescribeTenantSqlAuditQuery
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSqlAuditsRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeSqlAuditQueryResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: SQL审计查询条件。返回相关资源的详细信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/data:
    get:
      summary: 查询SQL审计数据
      operationId: DescribeSqlAudits
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSqlAuditsRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeSqlAuditsResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询SQL审计数据。返回相关资源的详细信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/delete:
    put:
      summary: 关闭SQL审计服务(租户)
      operationId: DeleteTenantSqlAuditService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateSqlAuditServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 关闭SQL审计服务(租户)。修改后的配置可能需要一定时间生效。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/modify:
    put:
      summary: 修改SQL审计服务时长（租户）
      operationId: ModifyTenantSqlCollectorRetention
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifySqlCollectorRetentionRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McModifySqlCollectorRetentionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改SQL审计服务时长（租户）。修改后的配置可能需要一定时间生效。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/open:
    post:
      summary: 开启SQL审计服务(租户)
      operationId: CreateTenantSqlAuditService
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateSqlAuditServiceRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 开启SQL审计服务(租户)。请求成功后返回创建的资源信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqlaudit/serviceInfo:
    get:
      summary: 查询租户SQL审计服务信息
      operationId: DescribeTenantSqlAuditServiceInfo
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSqlAuditsRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/McDescribeSqlCollectorRetentionResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户SQL审计服务信息。返回相关资源的详细信息。
      tags:
        - 多云SQL审计相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/anomalySql:
    get:
      summary: 查询可疑SQL详情
      operationId: DescribeOasSQLDiagnosis
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询可疑SQL详情。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/details:
    get:
      summary: SQL详情
      operationId: DescribeOasSQLDetails
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSQLDetailRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: SQL详情。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/history:
    get:
      summary: SQL历史
      operationId: DescribeOasSQLHistoryList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSQLHistoryRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: SQL历史。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/outline:
    get:
      summary: 绑定信息
      operationId: DescribeOutlineBinding
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: tableName
          in: query
          required: false
          schema:
            type: string
          description: Table name参数
          example: orders
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: isConcurrentLimit
          in: query
          required: false
          schema:
            type: boolean
          description: Is concurrent limit参数
          example: true
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: formatSqlId
          in: query
          required: false
          schema:
            type: string
          description: Format sql id参数
          example: sql_123456789
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 绑定信息。返回相关资源的详细信息。
      tags:
        - 多云计划绑定相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/plan:
    get:
      summary: SQL执行计划
      operationId: DescribeOasSQLPlans
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeSqlPlanRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: SQL执行计划。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/sampleSql:
    get:
      summary: 查询Sample SQL 的原始SQL文本列表
      operationId: DescribeSampleSqlRawTexts
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: true
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: limit
          in: query
          required: true
          schema:
            type: integer
            format: int32
          description: 结果数量限制
          example: 100
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询Sample SQL 的原始SQL文本列表。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/samples:
    get:
      summary: 查询慢 SQL 执行明细
      operationId: DescribeOasSlowSQLSamples
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询慢 SQL 执行明细。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/topPlanGroup:
    get:
      summary: 查询 SQL 执行计划
      operationId: DescribeOasSQLPlanGroup
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
        - name: planUnionHash
          in: query
          required: false
          schema:
            type: string
          description: Plan union hash参数
          example: plan_123456789
        - name: returnBriefInfo
          in: query
          required: false
          schema:
            type: boolean
          description: Return brief info参数
          example: true
        - name: checkOutlineStatus
          in: query
          required: false
          schema:
            type: boolean
          description: Check outline status参数
          example: true
        - name: formatSqlId
          in: query
          required: false
          schema:
            type: string
          description: Format sql id参数
          example: sql_123456789
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询 SQL 执行计划。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/trends:
    get:
      summary: 查询 SQL 执行历史
      operationId: DescribeOasSQLTrends
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: dbName
          in: query
          required: true
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询 SQL 执行历史。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sqls/{sqlId}/tuningAdvices:
    get:
      summary: 查询单个 SQL 的调优建议
      operationId: DescribeSQLTuningAdvices
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: sqlId
          in: path
          required: true
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: true
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询单个 SQL 的调优建议。返回相关资源的详细信息。
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantReadableScn:
    get:
      summary: 获取租户同步位点信息
      operationId: DescribeTenantReadableScn
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantReadableScnResponse"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取租户同步位点信息。返回相关资源的详细信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantSingleTunnelSLBAddress:
    post:
      summary: 新建租户singleTunnelSLB地址
      operationId: CreateTenantSingleTunnelSLBAddress
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMcTenantSingleTunnelSLBAddressRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateMcTenantAddressResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 新建租户singleTunnelSLB地址。请求成功后返回创建的资源信息。
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUserPasswordValidateRule:
    get:
      summary: 查询租户的用户密码规则
      operationId: DescribeTenantUserPasswordValidateRule
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeUserPasswordValidateRuleResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户的用户密码规则。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
    put:
      summary: 设置租户的用户密码规则
      operationId: ModifyTenantUserPasswordValidateRule
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantUserPasswordValidateRuleRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeUserPasswordValidateRuleResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 设置租户的用户密码规则。修改后的配置可能需要一定时间生效。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/authorization:
    post:
      summary: 修改用户权限
      operationId: ModifyTenantUserRoles
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: userName
          in: path
          required: true
          schema:
            type: string
          description: 数据库登录用户名
          example: admin
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyUserRolesParamDoOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OcpDbUserDoV2OpenApi"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改用户权限。请求成功后返回创建的资源信息。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description:
    put:
      summary: 修改租户内的用户备注信息
      operationId: ModifyTenantUserDescription
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: userName
          in: path
          required: true
          schema:
            type: string
          description: 数据库登录用户名
          example: admin
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantUserDescriptionParamDoOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户内的用户备注信息。修改后的配置可能需要一定时间生效。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/status:
    put:
      summary: 修改租户内的用户锁定状态
      operationId: ModifyTenantUserStatus
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: userName
          in: path
          required: true
          schema:
            type: string
          description: 数据库登录用户名
          example: admin
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyUserStatusParamDoOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户内的用户锁定状态。修改后的配置可能需要一定时间生效。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/units/{unitId}:
    put:
      summary: 发起unit迁移
      operationId: MigrateResourceUnit
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: unitId
          in: path
          required: true
          schema:
            type: string
          description: Unit id参数
          example: resource-123456
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MigrateResourceUnitRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 发起unit迁移。修改后的配置可能需要一定时间生效。
      tags:
        - 多云OB unit相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/userRoles:
    get:
      summary: 获取可用角色列表
      operationId: DescribeUserRoles
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantUserRolesResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取可用角色列表。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式下租户用户的相关OpenAPI
  /api/v2/instances/{instanceId}/topology:
    get:
      summary: DescribeInstanceTopology
      operationId: DescribeInstanceTopology
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/TopologyDoV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取集群实例的拓扑结构信息，包括Zone分布、节点列表等。
      tags:
        - MultiCloudOpenAPI
  /api/v2/operationEvents:
    get:
      summary: DescribeOperationEvents
      operationId: DescribeOperationEvents
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openParamRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeOperationEventRequestOpenAPI"
          description: Open param request参数
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataOperationEventDoV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeOperationEvents。返回相关资源的详细信息。
      tags:
        - 操作事件相关RestAPI
  /api/v2/services/monitor/customConfig:
    get:
      summary: 查询自定义监控报表
      operationId: DescribeCustomMonitorConfig
      parameters:
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeCustomMonitorConfigRequestOpenAPI"
          description: Open request参数
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/ObCloudMultiCustomMonitorConfigDtoOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询自定义监控报表。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式监控metrics的OpenAPI
    put:
      summary: 更新自定义监控报表
      operationId: UpdateCustomMonitorConfig
      parameters:
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/CustomMonitorConfigRequestOpenAPI"
          description: Open request参数
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 更新自定义监控报表。修改后的配置可能需要一定时间生效。
      tags:
        - 多云Mysql模式监控metrics的OpenAPI
  /api/v2/services/monitor/frequency:
    get:
      summary: 获取集群监控频率
      operationId: DescribeMonitorFrequency
      parameters:
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeMonitorFrequencyRequestOpenAPI"
          description: Open request参数
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 获取集群监控频率。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式监控metrics的OpenAPI
  /api/v2/services/monitor/metrics:
    get:
      summary: 查询监控指标列表
      operationId: DescribeMetricClass
      parameters:
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeMetricClassRequestOpenAPI"
          description: Open request参数
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/ObCloudMutiMetricClassVoOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询监控指标列表。返回相关资源的详细信息。
      tags:
        - 多云Mysql模式监控metrics的OpenAPI
  /api/v2/uid/operationEvents:
    get:
      summary: DescribeOperationEventsForUid
      operationId: DescribeOperationEventsForUid
      parameters:
        - name: request
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeOperationEventsRequestV2OpenAPI"
          description: Request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/OBCloudPagingDataDescribeOperationEventsResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DescribeOperationEventsForUid。返回相关资源的详细信息。
      tags:
        - 操作事件相关RestAPI
  /api/v2/services/DescribeMetricsData:
    post:
      summary: 查询监控趋势图
      operationId: DescribeMetricsData
      parameters:
        - name: requestId
          in: query
          required: false
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Caller-Source
          in: header
          required: true
          schema:
            type: string
          description: X- caller- source参数
          example: openapi
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DescribeMetricsDataRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties:
                        $ref: "#/components/schemas/Object"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询监控趋势图数据，支持多种指标类型和时间范围。
      tags:
        - 多云Mysql模式监控metrics的RestAPI
  /api/v2/tags:
    get:
      summary: 查询标签列表
      description: 查询标签列表，返回组织下所有标签的 key-value 信息。
      operationId: DescribeIamTags
      parameters:
        - name: orgId
          in: query
          description: 组织ID
          required: true
          example: ukp31txz9tmk6yqckhoxl356
          schema:
            type: string
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DescribeTagsResponse"
    post:
      summary: 批量创建标签
      description: 批量创建标签，支持同时创建多个标签 key-value 对。
      operationId: CreateIamTags
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTagsRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DescribeTagsResponse"
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
    put:
      summary: 更新标签
      description: 更新指定标签的 key 或 value 值。
      operationId: UpdateIamTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTagRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/UpdateTagResponse"
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
    delete:
      summary: 删除标签
      description: 删除指定的标签。
      operationId: DeleteIamTag
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteTagRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DeleteTagResponse"
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
  /api/v2/instances/{instanceId}/anomalyEvents:
    get:
      summary: 查询当前集群的异常事件信息
      operationId: DescribeInstanceAnomalyEvents
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询当前集群的异常事件信息
      tags:
        - 多云异常事件分析OpenAPI
  /api/v2/instances/{instanceId}/anomalySql:
    get:
      summary: 查询集群可疑SQL列表
      operationId: DescribeOasClusterAnomalySQLList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群可疑SQL列表
      tags:
        - 多云OAS集群维度SQL诊断相关Open API
  /api/v2/instances/{instanceId}/rcaResult:
    get:
      summary: 查询某个异常事件根因分析结果
      operationId: DescribeRcaRecord
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: eventId
          in: query
          required: true
          schema:
            type: string
          example: ocp-cloud-ops-event-123456
          description: 根因分析事件 ID
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询某个异常事件根因分析结果
      tags:
        - 多云异常事件分析OpenAPI
  /api/v2/instances/{instanceId}/slowSql:
    get:
      summary: 查询集群SlowSQL列表
      operationId: DescribeOasClusterSlowSQLList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
        - name: dynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Dynamic sql参数
          example: false
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询集群SlowSQL列表
      tags:
        - 多云OAS集群维度SQL诊断相关Open API
  /api/v2/instances/{instanceId}/tenants/{tenantId}/highRiskSql:
    get:
      summary: 查询高危SQL
      operationId: DescribeOasHighRiskSQL
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: dbName
          in: query
          required: false
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: nodeIp
          in: query
          required: false
          schema:
            type: string
          description: 节点IP
          example: 10.0.0.10
        - name: searchKeyWord
          in: query
          required: false
          schema:
            type: string
          description: SQL关键字
          example: update
        - name: sqlTextLength
          in: query
          required: false
          schema:
            type: integer
            format: int64
          description: SQL文本最大长度
          example: 65535
        - name: sqlId
          in: query
          required: false
          schema:
            type: string
          description: SQL语句唯一标识
          example: sql_123456789
        - name: filterCondition
          in: query
          required: false
          schema:
            type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        - name: httpServletRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/HttpServletRequest"
          description: Http servlet request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询高危SQL
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/indexes:
    get:
      summary: 查询索引信息
      operationId: DescribeIndexes
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: dbName
          in: query
          required: true
          schema:
            type: string
          description: 数据库名称
          example: test_db
        - name: tableName
          in: query
          required: true
          schema:
            type: string
          description: Table name参数
          example: orders
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询索引信息
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/schema:
    post:
      summary: 查询表Schema
      operationId: DescribeTableSchema
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/McDescribeTableSchemaRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询表Schema
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/sessions/groupBySqlId:
    get:
      summary: 会话管理按照SqlId汇总
      operationId: DescribeSessionStatsGroupBySqlId
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: 任务或资源当前状态
          example: |-
            ---
            - "ONLINE"
        - name: sqlText
          in: query
          required: false
          schema:
            type: string
          description: SQL语句文本
          example: SELECT * FROM users WHERE id = 1
        - name: clientIp
          in: query
          required: false
          schema:
            type: string
          description: Client ip参数
          example: successful
        - name: serverIp
          in: query
          required: false
          schema:
            type: string
          description: Server ip参数
          example: 10.0.0.10
        - name: users
          in: query
          required: false
          schema:
            type: string
          description: Users参数
          example: admin
        - name: sortField
          in: query
          required: false
          schema:
            type: string
          description: 排序字段
          example: createTime
        - name: sortOrder
          in: query
          required: false
          schema:
            type: string
          description: 排序顺序
          example: DESC
        - name: mergeDynamicSql
          in: query
          required: false
          schema:
            type: boolean
          description: Merge dynamic sql参数
          example: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 会话管理按照SqlId汇总
      tags:
        - 多云会话相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/tagList:
    post:
      summary: 修改特定租户的标签信息
      operationId: ModifyTenantTagList
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ResourceTagRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改特定租户的标签信息
      tags:
        - 多云OB租户相关OpenAPI
  /api/v2/instances/{instanceId}/tenants/{tenantId}/topSqlComparision:
    get:
      summary: sql执行对比
      operationId: DescribeTopSQLComparision
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID，用于追踪
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: startTime
          in: query
          required: true
          schema:
            type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        - name: endTime
          in: query
          required: true
          schema:
            type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        - name: baseLineStartTime
          in: query
          required: true
          schema:
            type: string
          example: 2026-02-25T15:40:43Z
          description: Top SQL 对比的基线起始时间，使用 RFC3339/ISO-8601 时间格式
        - name: baseLineEndTime
          in: query
          required: true
          schema:
            type: string
          example: 2026-02-25T16:40:43Z
          description: Top SQL 对比的基线结束时间，使用 RFC3339/ISO-8601 时间格式
        - name: server
          in: query
          required: false
          schema:
            type: string
          description: 服务器地址，通常为 OBServer 节点 IP
          example: 10.0.0.10
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: object
                    description: 业务数据(object)
                    example:
                      id: resource-123456
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: sql执行对比
      tags:
        - 多云SQL诊断相关OpenAPI
  /api/v2/oms/project/modifyRecord:
    get:
      summary: 查询修改记录详情
      description: |
        根据修改记录ID查询修改记录详情。对应 GetModifyRecord。
        在 AWS 网关上为 GET 请求，参数通过 query 传递。
        实际请求：GET /api/v2/oms/project/modifyRecord?Action=GetModifyRecord&id=xxx
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: getModifyRecord
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          schema:
            type: string
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
        - name: id
          in: query
          required: true
          schema:
            type: string
          description: 资源唯一标识。
          example: "244"
      responses:
        "200":
          description: 成功，data 为修改记录详情
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultModifyRecordDetail"
  /api/v2/oms/project/transferMapping:
    get:
      summary: 查询传输对象
      description: |
        查询项目的传输对象映射配置。对应 DescribeTransferMapping。
        在 AWS 网关上为 POST 请求，参数通过 query 传递。
        实际请求：POST /api/v2/oms/project/describeTransferMapping?Action=DescribeTransferMapping&id=xxx
        认证：HTTP Digest (-u 'ak:sk' --digest)。
        请求头必填：X-Ob-Project-Id、X-Ob-Org-Id。
      operationId: describeTransferMapping
      parameters:
        - name: requestId
          in: query
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Oms-Env
          in: header
          schema:
            type: string
          example: example-value
        - name: X-Ob-Org-Id
          in: header
          schema:
            type: string
          description: 组织 ID，所有接口必填。
          example: org-xxxxxxxx
        - name: id
          in: query
          required: true
          schema:
            type: string
          description: 资源唯一标识。
          example: "244"
      responses:
        "200":
          description: 成功，data 为传输对象映射配置
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OmsApiReturnResultTransferMapping"
  /maas/apikeys:
    get:
      summary: 查询 API Key 列表
      description: 分页查询指定组织和项目下的 API Key 列表。接口需要通过 IAM 鉴权， 并基于 uid、组织 ID 与项目 ID 校验访问范围。
      operationId: MaasListApiKeys
      parameters:
        - name: uid
          in: query
          description: 用户 ID。
          required: true
          schema:
            type: string
          example: "200006001999"
        - name: Action
          in: query
          description: 查询动作标识，与响应 action 字段 echo。也可通过同名 header 传入。
          required: false
          example: MaasListApiKeys
          schema:
            type: string
        - name: pageNumber
          in: query
          description: 页码，从 1 开始，默认 1。
          required: false
          schema:
            type: integer
            default: 1
          example: 1
        - name: pageSize
          in: query
          description: 每页条数，默认 10，最大 100；超出时服务端强制置为 20。
          required: false
          schema:
            type: integer
            default: 10
          example: 10
        - name: requestId
          in: header
          description: 请求唯一标识。与 X-Request-Id 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-Request-Id
          in: header
          description: 请求唯一标识。与 requestId 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-OB-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          required: true
          example: org-xxxxxxxx
          schema:
            type: string
        - name: X-OB-Project-Id
          in: header
          description: 项目 ID，所有接口必填。
          required: true
          example: proj-xxxxxxxx
          schema:
            type: string
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MaasListApiKeysResponse"
        "400":
          description: 请求参数校验失败
        "403":
          description: 无权限
        "500":
          description: 服务内部错误
    post:
      summary: 创建 API Key
      description: 创建新的 API Key。API Key 归属于指定组织和项目，创建时需要通过 IAM 鉴权，并校验名称唯一性、项目状态与操作权限。
      operationId: MaasCreateApiKey
      parameters:
        - name: uid
          in: query
          description: 用户 ID。
          required: true
          schema:
            type: string
          example: "200006001999"
        - name: requestId
          in: header
          description: 请求唯一标识。与 X-Request-Id 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-Request-Id
          in: header
          description: 请求唯一标识。与 requestId 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-OB-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          required: true
          example: org-xxxxxxxx
          schema:
            type: string
        - name: X-OB-Project-Id
          in: header
          description: 项目 ID，所有接口必填。
          required: true
          example: proj-xxxxxxxx
          schema:
            type: string
        - name: X-Ob-Product
          in: header
          description: 来源产品标识，传入时必须为受支持的产品枚举值。
          required: false
          schema:
            type: string
          example: example-value
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MaasCreateApiKeyRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MaasCreateApiKeyResponse"
        "400":
          description: 请求参数校验失败
        "403":
          description: 无权限
        "500":
          description: 服务内部错误
    delete:
      summary: 删除 API Key
      description: 按 API Key 的 uuid 删除指定项目下的 API Key。接口需要通过 IAM 鉴权， 并校验该 API Key 同时属于当前组织和项目。
      operationId: MaasDeleteApiKey
      parameters:
        - name: uid
          in: query
          description: 用户 ID。
          required: true
          schema:
            type: string
          example: "200006001999"
        - name: id
          in: query
          description: 资源唯一标识。
          required: true
          example: ak-xxxxxxxxxxxxxxxx
          schema:
            type: string
        - name: Action
          in: query
          description: 删除动作标识，与响应 action 字段 echo。也可通过同名 header 传入。
          required: false
          example: MaasDeleteApiKey
          schema:
            type: string
        - name: requestId
          in: header
          description: 请求唯一标识。与 X-Request-Id 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-Request-Id
          in: header
          description: 请求唯一标识。与 requestId 二选一，至少传一个。
          required: false
          example: req-abc123
          schema:
            type: string
        - name: X-OB-Org-Id
          in: header
          description: 组织 ID，所有接口必填。
          required: true
          example: org-xxxxxxxx
          schema:
            type: string
        - name: X-OB-Project-Id
          in: header
          description: 项目 ID，所有接口必填。
          required: true
          example: proj-xxxxxxxx
          schema:
            type: string
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MaasDeleteApiKeyResponse"
        "400":
          description: 请求参数校验失败
        "403":
          description: 无权限
        "404":
          description: API Key 不存在
        "500":
          description: 服务内部错误
  /api/v2/instances/{instanceId}/recyclebin/expiretime:
    put:
      tags:
        - 多云回收站相关OpenAPI
      summary: ModifyRecycleBinExpireTime
      description: 修改实例回收站数据过期时间
      operationId: ModifyRecycleBinExpireTime
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyRecycleBinExpireTimeRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyRecycleBinExpireTimeResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/recyclebin/flashback:
    post:
      tags:
        - 多云回收站相关OpenAPI
      summary: FlashbackInstanceRecycleBinObjects
      description: 实例回收站对象闪回/恢复
      operationId: FlashbackInstanceRecycleBinObjects
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FlashBackRecycleBinObjectsRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/BooleanResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/recyclebin/objects:
    get:
      tags:
        - 多云回收站相关OpenAPI
      summary: DescribeInstanceRecycleBin
      description: 查询实例回收站对象列表
      operationId: DescribeInstanceRecycleBin
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeRecycleBinRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeRecycleBinResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
    delete:
      tags:
        - 多云回收站相关OpenAPI
      summary: DeleteInstanceRecycleBinObjects
      description: 删除实例回收站对象
      operationId: DeleteInstanceRecycleBinObjects
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteRecycleBinObjectRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/BooleanResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/recyclebin/status:
    put:
      tags:
        - 多云回收站相关OpenAPI
      summary: ModifyInstanceRecycleBin
      description: 修改实例回收站启停状态
      operationId: ModifyInstanceRecycleBin
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyInstanceRecycleBinRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyRecycleBinStatusResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/recyclebin/summary:
    get:
      tags:
        - 多云回收站相关OpenAPI
      summary: DescribeInstanceRecycleBinSummary
      description: 查询实例回收站概要信息
      operationId: DescribeInstanceRecycleBinSummary
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeRecycleBinRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeRecycleBinSummaryResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/tenants/{tenantId}/recyclebin/flashback:
    post:
      tags:
        - 多云回收站相关OpenAPI
      summary: FlashbackTenantRecycleBinObjects
      description: 租户回收站对象闪回/恢复
      operationId: FlashbackTenantRecycleBinObjects
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/FlashBackRecycleBinObjectsRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/BooleanResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/tenants/{tenantId}/recyclebin/objects:
    get:
      tags:
        - 多云回收站相关OpenAPI
      summary: DescribeTenantRecycleBin
      description: 查询租户回收站对象列表
      operationId: DescribeTenantRecycleBin
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeRecycleBinRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeRecycleBinResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
    delete:
      tags:
        - 多云回收站相关OpenAPI
      summary: DeleteTenantRecycleBinObjects
      description: 删除租户回收站对象
      operationId: DeleteTenantRecycleBinObjects
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteRecycleBinObjectRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/BooleanResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/tenants/{tenantId}/recyclebin/status:
    put:
      tags:
        - 多云回收站相关OpenAPI
      summary: ModifyTenantRecycleBin
      description: 修改租户回收站启停状态
      operationId: ModifyTenantRecycleBin
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantRecycleBinRequestOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyRecycleBinStatusResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/tenants/{tenantId}/recyclebin/summary:
    get:
      tags:
        - 多云回收站相关OpenAPI
      summary: DescribeTenantRecycleBinSummary
      description: 查询租户回收站概要信息
      operationId: DescribeTenantRecycleBinSummary
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: openRequest
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/DescribeRecycleBinRequestOpenAPI"
          description: Open request参数
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeRecycleBinSummaryResponseV2OpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule:
    get:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 查询租户列加密规则
      operationId: DescribeTenantSensitiveRules
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: pageNumber
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页页码
          example: 1
        - name: pageSize
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: 分页大小
          example: 10
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantSensitiveRulesResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户列加密规则
    post:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 创建租户列加密规则
      operationId: CreateTenantSensitiveRule
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTenantSensitiveRuleRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CreateTenantSensitiveRuleResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 创建租户列加密规则
    put:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 修改租户列加密规则
      operationId: ModifyTenantSensitiveRule
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ModifyTenantSensitiveRuleRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/ModifyTenantSensitiveRuleResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户列加密规则
    delete:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 删除租户列加密规则
      operationId: DeleteTenantSensitiveRule
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteTenantSensitiveRuleRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DeleteTenantSensitiveRuleResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 删除租户列加密规则
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/authorization:
    post:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 更新租户列加密规则 Schema 授权
      operationId: UpdateTenantSensitiveRuleAuth
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTenantSensitiveRuleAuthRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/UpdateTenantSensitiveRuleAuthResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 更新租户列加密规则 Schema 授权
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/enabled:
    put:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 启用/禁用租户列加密规则
      operationId: UpdateTenantSensitiveRuleEnabled
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTenantSensitiveRuleEnabledRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/UpdateTenantSensitiveRuleEnabledResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 启用/禁用租户列加密规则
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/encryptionAlgorithms:
    get:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 查询租户列加密规则可用算法列表
      operationId: DescribeTenantSensitiveRuleEncryptionAlgorithms
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantSensitiveRuleEncryptionAlgorithmsResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户列加密规则可用算法列表
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/plainAccessUsers:
    get:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 查询租户用户级 PLAINACCESS 用户
      operationId: DescribeTenantPlainAccessUsers
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantPlainAccessUsersResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户用户级 PLAINACCESS 用户
    put:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 修改租户用户级 PLAINACCESS 用户列表
      operationId: UpdateTenantPlainAccessUsers
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTenantPlainAccessUsersRequest"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/UpdateTenantPlainAccessUsersResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 修改租户用户级 PLAINACCESS 用户列表
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/schema:
    get:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 查询租户用户表结构（列加密规则使用）
      operationId: DescribeTenantUserTableSchema
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/DescribeTenantUserTableSchemaResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 查询租户用户表结构（列加密规则使用）
  /api/v2/instances/{instanceId}/tenants/{tenantId}/security/sensitiveRule/supported:
    get:
      tags:
        - 多云列加密相关 OpenAPI
      summary: 校验租户是否支持列加密
      operationId: CheckTenantSensitiveRuleSupported
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: OceanBase集群ID
          example: obcluster-*****
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: 租户ID
          example: t4louaeei****
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/CheckTenantSensitiveRuleSupportedResponseOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: 校验租户是否支持列加密
  /api/v2/services/CreatePrometheusIntegration:
    post:
      tags:
        - Prometheus集成配置OpenAPI
      summary: CreatePrometheusIntegration
      operationId: CreatePrometheusIntegrationForOpenApi
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    allOf:
                      - $ref: "#/components/schemas/PrometheusIntegrationDtoOpenAPI"
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: CreatePrometheusIntegration
  /api/v2/services/DeletePrometheusIntegration:
    delete:
      tags:
        - Prometheus集成配置OpenAPI
      summary: DeletePrometheusIntegration
      operationId: DeletePrometheusIntegrationForOpenApi
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeletePrometheusIntegrationParamOpenAPI"
        required: true
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: boolean
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: DeletePrometheusIntegration
  /api/v2/services/ListPrometheusIntegration:
    get:
      tags:
        - Prometheus集成配置OpenAPI
      summary: ListPrometheusIntegration
      operationId: ListPrometheusIntegrationForOpenApi
      parameters:
        - name: requestId
          in: query
          required: true
          schema:
            type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        - name: X-Ob-Project-Id
          in: header
          required: true
          schema:
            type: string
          description: 项目 ID，所有接口必填。
          example: proj-xxxxxxxx
      responses:
        "200":
          description: 成功
          content:
            application/json:
              schema:
                type: object
                description: http api 响应结构体
                properties:
                  success:
                    type: boolean
                    description: 是否成功
                    example: true
                  errorCode:
                    type: string
                    description: 错误码
                    example: INVALID_PARAMETER
                  errorMessage:
                    type: string
                    description: 错误信息
                    example: Invalid parameter
                  data:
                    type: array
                    items:
                      allOf:
                        - $ref: "#/components/schemas/PrometheusIntegrationListDtoOpenAPI"
                      description: 业务数据(object)
                    description: 业务数据(object)
                  cost:
                    type: number
                    format: int64
                    description: 耗时
                    example: 1.0
                  server:
                    type: string
                    description: 服务器地址，通常为 OBServer 节点 IP
                    example: 10.0.0.10
                  requestId:
                    type: string
                    description: 请求id
                    example: d04eabba-acef-4f4b-96f1-c657876ca6f1
                  totalCount:
                    type: number
                    format: int64
                    description: 总记录数。
                    example: 100.0
                  extra:
                    type: object
                    description: 扩展信息。
                    example: {}
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/TooManyRequests"
      description: ListPrometheusIntegration
components:
  schemas:
    AddTenantPlServiceUserRequest:
      type: object
      description: Add租户PlService用户请求参数
      properties:
        userAccount:
          type: string
          description: 用户白名单账号
          example: "200006001999"
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
    AddTenantPlServiceUserResponse:
      type: object
      description: Add租户PlService用户响应结果
    AvailableRoZoneDo:
      type: object
      description: AvailableRo可用区数据对象
      properties:
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        zoneReplicaType:
          type: string
          description: 可用区副本类型。
          example: FULL
        zoneCopyId:
          type: integer
          format: int32
          description: 可用区副本编号。
          example: 1
        readOnlyZoneOperations:
          allOf:
            - $ref: "#/components/schemas/ReadOnlyZoneOperation"
          description: 只读副本可用区相关操作的准入结果。
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        replicaAliasName:
          type: string
          description: 副本展示别名。
          example: test-name
        readOnlyReplicaType:
          description: 只读副本类型
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
        readonlyInstanceId:
          type: string
          description: 只读实例ID
          example: obcluster-*****-ro
    BackupConnectInfo:
      type: object
      description: 备份连接信息
      properties:
        endpoint:
          type: string
          description: 端点地址
          example: oss-cn-hangzhou.aliyuncs.com
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        accessKeySecret:
          type: string
          description: 访问密钥Secret
          example: sk-xxxxxxxxxxxxxxxx
        uri:
          type: string
          description: 资源访问地址。
          example: oss://oceanbase-backup/backup
        storageType:
          allOf:
            - $ref: "#/components/schemas/BackupStorageType"
          description: 存储类型。
        bucketName:
          type: string
          description: 存储桶名称
          example: oceanbase-backup
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        appId:
          type: string
          description: 应用ID
          example: app-123456
        clusterName:
          type: string
          description: 集群备份目录，可以为空
          example: test-cluster
        applyKeys:
          type: array
          description: 申请使用的密钥列表。
          items:
            type: string
            description: 申请使用的密钥列表。
            example: |-
              ---
              - "backup_readonly_key"
          example:
            - backup_readonly_key
        usePublicNetwork:
          type: boolean
          description: 是否走公网连接
          example: false
        useCustomEndpoint:
          type: boolean
          description: 是否使用自定义端点
          example: false
        customEndpoint:
          type: string
          description: 自定义端点地址（当 useCustomEndpoint 为 true 时使用）
          example: oss-cn-hangzhou-internal.aliyuncs.com
    BackupMaintainMatchRuleV2:
      type: object
      properties:
        backupScheduleMode:
          description: 备份调度模式，例如按周或按月执行
          example: WEEK
          allOf:
            - $ref: "#/components/schemas/BackupModel"
        weeks:
          type: array
          description: 按周调度：1～7
          items:
            type: integer
            format: int32
            description: 按周调度：1～7
          example:
            - 1
            - 3
            - 5
        days:
          type: array
          description: 按月调度：1～31日
          items:
            type: integer
            format: int32
            description: 按月调度：1～31日
          example:
            - 1
            - 15
        month:
          type: integer
          format: int32
          description: 按年调度：1～12月
          example: 1
      description: Backup Maintain Match Rule  V2
    BackupMaintainMode:
      type: string
      description: 备份维护模式
    BackupMaintainStrategyV2:
      type: object
      properties:
        backupMaintainMode:
          allOf:
            - $ref: "#/components/schemas/BackupMaintainMode"
          description: 备份保留策略模式，用于控制按数量或按时间保留备份集
        maintainDay:
          type: integer
          format: int32
          description: 保留时长（永久保留时该值无效）
          example: 1
        reserveLogBackup:
          type: boolean
          description: 是否保留日志备份
          example: true
      description: Backup Maintain Strategy  V2
    BackupMode:
      type: string
      description: 备份Mode
    BackupSetRestoreSummary:
      type: object
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        setId:
          type: string
          description: 备份集ID
          example: backup_123456789
        checkpoint:
          type: string
          description: 备份集或恢复任务的检查点。
          example: 2026-02-25T15:40:43Z
        backupSetId:
          type: string
          description: 备份集ID
          example: backup_123456789
        downloadable:
          type: boolean
          description: 备份集是否可下载
          example: true
      description: Backup Set Restore Summary
    BackupStorageSizeInfo:
      type: object
      description: 备份StorageSize信息
      properties:
        totalBackupSize:
          type: number
          format: double
          description: standard类型，备份总大小：物理+逻辑，dataBackupSize+logBackupSize
          example: 200.0
        dataBackupSize:
          type: number
          format: double
          description: standard类型，数据备份大小，含免费
          example: 200.0
        logBackupSize:
          type: number
          format: double
          description: standard类型，日志备份大小，含免费
          example: 200.0
        freeBackupSize:
          type: number
          format: double
          description: standard类型，免费备份大小，相当于赠送空间
          example: 200.0
        freeLogBackupSize:
          type: number
          format: double
          description: standard类型，免费日志备份大小。当前仅在一方迁移集群中有效。非一方迁移集群，不允许设置改值。
          example: 200.0
        freeDataBackupSize:
          type: number
          format: double
          description: standard类型，免费数据备份大小。当前仅在一方迁移集群中有效。非一方迁移集群，不允许设置改值。
          example: 200.0
        chargeBackupSize:
          type: number
          format: double
          description: standard类型，总收费备份大小 = chargeDataBackupSize + chargeLogBackupSize
          example: 200.0
        chargeDataBackupSize:
          type: number
          format: double
          description: standard类型，收费数据备份大小
          example: 200.0
        chargeLogBackupSize:
          type: number
          format: double
          description: standard类型，收费日志备份大小
          example: 200.0
        chargeDataBackupSizeWithinSevenDays:
          type: number
          format: double
          description: standard类型，7天内收费的数据备份大小
          example: 200.0
        chargeLogBackupSizeWithinSevenDays:
          type: number
          format: double
          description: standard类型，7天内收费的日志备份大小
          example: 200.0
        chargeDataBackupSizeOutsideSevenDays:
          type: number
          format: double
          description: standard类型，7天外收费的数据备份大小
          example: 200.0
        chargeLogBackupSizeOutsideSevenDays:
          type: number
          format: double
          description: standard类型，7天外收费的日志备份大小
          example: 200.0
        backupVolumeUnit:
          allOf:
            - $ref: "#/components/schemas/ObStorageVolumeUnit"
          description: 备份存储容量的计量单位
        archiveDataSize:
          type: number
          format: double
          description: archive类型，本地归档数据存储大小
          example: 200.0
        archiveLogSize:
          type: number
          format: double
          description: archive类型，本地归档日志存储大小
          example: 200.0
        totalArchiveBackupSize:
          type: number
          format: double
          description: archive类型，本地归档备份总大小
          example: 200.0
    BackupStorageType:
      type: object
      description: 备份存储类型
    BackupTaskTriggerType:
      type: object
      description: 备份任务TriggerType
    BinlogComponent:
      type: object
      description: Binlog 组件参数
      properties:
        componentCode:
          type: string
          description: 组件编码。
          example: cpu
        componentValue:
          type: string
          description: 组件取值。
          example: 4C
    CheckParameterResponseOpenAPI:
      type: object
      description: Check参数响应结果OpenAPI
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        name:
          type: string
          description: 名称。
          example: 数据源名称
    CloseSessionParamOpenAPI:
      type: object
      description: Close会话参数OpenAPI
      properties:
        sessionList:
          type: string
          description: 会话 ID 列表。
          example: "12345,23456"
    CloudProvider:
      type: string
      description: 云厂商
      enum:
        - ALIYUN
        - HUAWEI
        - QCLOUD
        - AWS
        - AWSCN
        - GCP
        - AZURE
    CommodityServiceBaseResponse:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        success:
          type: boolean
          description: 请求是否成功
          example: true
        orderStatus:
          type: string
          description: 订单状态。
          example: SUCCESS
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
      description: 商品ServiceBase响应结果
    CompleteOrderParamRequestForOpenApi:
      type: object
      description: Complete订单参数请求参数ForOpenApi
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        sceneCode:
          type: string
          description: 场景代码
          example: CREATE_INSTANCE
        orderType:
          type: string
          description: 订单类型。
          example: CREATE
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ComponentDetailDTO"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        orderParams:
          type: object
          additionalProperties:
            type: string
          description: 订单参数
          example:
            cpu: "4"
            diskSize: "200"
            memory: "16"
    CompleteOrderParamResponseForOpenApi:
      type: object
      description: Complete订单参数响应结果ForOpenApi
      properties:
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ComponentDetailDTO"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        success:
          type: boolean
          description: 请求是否成功
          example: true
        orderStatus:
          type: string
          description: 订单状态。
          example: SUCCESS
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
    ComponentDetailDTO:
      type: object
      description: 组件详情数据传输对象
      properties:
        commodityId:
          type: string
          description: 商品ID
          example: resource-123456
        componentCode:
          type: string
          description: 组件编码。
          example: cpu
        componentName:
          type: string
          description: 组件名称
          example: CPU
        componentValue:
          type: string
          description: 组件取值。
          example: 4C
        componentValueName:
          type: string
          description: 组件值名称
          example: 4 Core
        componentValueTag:
          type: string
          description: 组件值标签
          example: standard
        completeList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ComponentDetailDTO"
            description: 完成列表
          description: 完成列表
          example:
            - id: resource-123456
    ConfirmTenantPlServiceRequestOpenAPI:
      type: object
      description: Confirm租户PlService请求参数OpenAPI
      properties:
        addressId:
          type: string
          description: 即vip service group name
          example: rs-private-internet-*****
        endpointId:
          type: string
          description: Endpoint 标识。
          example: ep-xxxxxx
    ConnectTenantPlServiceRequestOpenAPI:
      type: object
      description: Connect租户PlService请求参数OpenAPI
      properties:
        endpointId:
          type: string
          description: Endpoint 标识。
          example: ep-xxxxxx
        addressId:
          type: string
          description: "即vip service group name, 可选"
          example: rs-private-internet-*****
        userEndpointAddress:
          type: string
          description: 用户自定义的endpoint地址，可选
          example: 10.0.0.10
    ConnectTenantPlServiceResponseOpenAPI:
      type: object
      description: Connect租户PlService响应结果OpenAPI
    ConnectionStatus:
      type: string
      description: 连接测试状态
      enum:
        - SUCCESS
        - FAILED
        - UNKNOWN
    CpuDoV2:
      type: object
      description: CPU数据对象V
      properties:
        totalCpu:
          type: number
          format: double
          description: CPU 总核数。
          example: 4.0
        usedCpu:
          type: number
          format: double
          description: 已使用 CPU 核数。
          example: 4.0
        originalTotalCpu:
          type: number
          format: double
          description: 变更前 CPU 总核数。
          example: 4.0
        unitCpu:
          type: number
          format: double
          description: Unit 处理器规格。
          example: 2.0
    CpuDoV2OpenAPI:
      type: object
      description: CPU数据对象VOpenAPI
      properties:
        totalCpu:
          type: number
          format: double
          description: CPU 总核数。
          example: 4.0
        usedCpu:
          type: number
          format: double
          description: 已使用 CPU 核数。
          example: 4.0
    CreateBackupSetDownloadLinkRequestOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        backupSetId:
          type: string
          description: 备份集ID
          example: backup_123456789
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
        - backupSetId
      description: 创建备份SetDownloadLink请求参数OpenAPI
    CreateBackupSetDownloadLinkResponseV2OpenAPI:
      type: object
      properties:
        downloadTaskId:
          type: integer
          format: int64
          description: Download task id参数
          example: 10001
      description: 创建备份SetDownloadLink响应结果VOpenAPI
    CreateBinlogServiceRequestForOpenApi:
      type: object
      description: 创建BinlogService请求参数ForOpenApi
      properties:
        diskCapacityInMB:
          type: integer
          format: int32
          description: 磁盘容量，单位 MB。
          example: 102400
        logRetentionTimeInHour:
          type: integer
          format: int32
          description: 日志保留时长，单位为小时。
          example: 72
        ddlCompatMode:
          type: boolean
          description: Binlog DDL 兼容模式。
          example: true
        tenantCpuCount:
          type: integer
          format: int32
          description: 租户 CPU 核数。
          example: 4
        orgId:
          type: string
          description: 组织ID
          example: ukp31txz9tmk6yqckhox****
    CreateBinlogServiceResponseForOpenApi:
      type: object
      description: 创建BinlogService响应结果ForOpenApi
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
    CreateDataBackupTaskRequestV2OpenAPI:
      type: object
      description: 创建数据备份任务请求参数VOpenAPI
      properties:
        needPreCheck:
          type: boolean
          description: 是否需要备份预检查
          example: true
        backupObjectType:
          type: string
          description: "cluster: 集群，tenant：租户，database：库，table：表 see {@link com.oceanbase.cloud.backup.facade.enums.BackupObjectType}"
          example: tenant
        backupPolicy:
          type: string
          description: "manual: 手动，automatic: 调度 see {@link com.oceanbase.cloud.backup.utils.BackupPolicy}"
          example: manual
        tenantId:
          type: string
          description: 当backupObjectType=tenant时，该参数必选
          example: t4louaeei****
        databaseTables:
          type: string
          description: 当backupObjectType=database/table时，该参数必选
          example: test_db.orders
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
        hybridStorageEnabled:
          type: boolean
          description: 是否启用混合存储备份（obcloud + 用户自有OSS） 混合存储类型备份会在备份完成后将数据复制到用户自有的OSS中
          example: false
        hybridStorageInfo:
          allOf:
            - $ref: "#/components/schemas/HybridStorageInfo"
          description: 混合存储信息。
          example:
            storageType: OSS
            bucketName: oceanbase-backup
    CreateDataSourceRequest:
      type: object
      description: 创建数据源请求体（对应 InnerDataSource）
      properties:
        uid:
          type: string
          description: 创建该数据源的用户 uid，请求中必带
          example: user-123
        instanceId:
          type: string
          description: OB 实例 ID
          example: instance-123
        instanceType:
          allOf:
            - $ref: "#/components/schemas/InstanceType"
          description: 实例类型
        name:
          type: string
          description: 数据源名称，不可首尾空格
          example: 数据源名称
        host:
          type: string
          description: 数据库主机地址
          example: your-host
        port:
          type: integer
          description: 数据库端口
          example: 2881
        username:
          type: string
          description: 数据库登录用户名
          example: admin
        password:
          type: string
          description: 数据库账号密码（明文，仅内部接口）
          example: your-password
        sysTenantUsername:
          type: string
          description: OB 系统租户账号用户名
          example: pay_core
        sysTenantPassword:
          type: string
          description: OB 系统租户账号密码
          example: your-password
        cloudProvider:
          allOf:
            - $ref: "#/components/schemas/CloudProvider"
          description: 资源或数据源所在云厂商
        regionName:
          type: string
          description: 地域名称（与 region 二选一或同义）
          example: cn-hangzhou
        region:
          type: string
          description: 部署该数据库实例所属地域，与 regionName 语义一致时可选其一
          example: cn-hangzhou
        databaseType:
          allOf:
            - $ref: "#/components/schemas/DataSourceType"
          description: 数据库类型
        networkAccessType:
          allOf:
            - $ref: "#/components/schemas/NetworkAccessType"
          description: 网络访问方式，例如公网、私网或 Endpoint
        tenantId:
          type: string
          description: OB 租户 ID
          example: t4louaeei****
        instanceName:
          type: string
          description: OB 实例名称
          example: test-cluster
        tenantName:
          type: string
          description: OB 租户名称
          example: pay_core
        visible:
          type: boolean
          description: 数据源是否对用户可见（是否临时数据源）
          default: true
          example: true
        description:
          type: string
          description: 数据源描述
          example: 用于业务交易的租户
      required:
        - uid
        - name
        - cloudProvider
        - region
        - databaseType
        - instanceType
        - networkAccessType
    CreateDatabaseRequestV2:
      type: object
      description: 创建数据库请求参数V
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        encoding:
          type: string
          description: 字符集。
          example: utf8mb4
        collation:
          type: string
          description: 字符序排序规则。
          example: utf8mb4_general_ci
        description:
          type: string
          description: Description
          example: 用于业务交易的租户
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
    CreateInstanceResponseV2OpenApi:
      type: object
      properties:
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
        dryRunResult:
          type: boolean
          description: 预检查的结果
          example: true
      description: 创建集群实例响应结果VOpenApi
    CreateMcTenantAddressRequestOpenAPI:
      type: object
      description: 创建管控租户地址请求参数OpenAPI
      properties:
        vipServiceType:
          type: string
          description: 地址类型
          example: PRIVATE
        vpcConnectionInfoId:
          type: integer
          format: int64
          description: peering连接ID，非云厂商的id
          example: 10001
        proxySetting:
          allOf:
            - $ref: "#/components/schemas/ProxySetting"
          description: ODP 数据库代理配置，用于创建租户连接地址时指定代理规格、节点数和部署参数
    CreateMcTenantAddressResponseOpenAPI:
      type: object
      properties:
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
      description: 创建管控租户地址响应结果OpenAPI
    CreateMcTenantSingleTunnelSLBAddressRequestOpenAPI:
      type: object
      description: 创建管控租户SingleTunnelSLB地址请求参数OpenAPI
      properties:
        userVpcId:
          type: string
          description: 用户VCP ID
          example: vpc-xxxxx
        userVpcOwnerId:
          type: string
          description: 用户 VPC 所属账号标识。
          example: "200006001999"
        userVswitchId:
          type: string
          description: 用户 Vswitch ID
          example: vsw-xxxxx
        vipServiceType:
          type: string
          description: 地址类型
          example: PRIVATE
        zoneIdList:
          type: array
          description: 用户选择的zone
          items:
            type: string
            description: 用户选择的zone
            example: |-
              ---
              - "cn-hangzhou-i"
              - "cn-hangzhou-j"
          example:
            - cn-hangzhou-i
            - cn-hangzhou-j
        trafficStrategy:
          type: string
          description: 流量策略
          example: ZONE_FIRST
        replicaParams:
          type: string
          description: 选择副本
          example: cn-hangzhou-i:F:1
        disasterRecoveryReplicaParams:
          type: string
          description: 选择容灾副本
          example: cn-hangzhou-i:F:1
        balancedStrategy:
          type: string
          description: 均衡策略
          example: BALANCED
        disasterRecoveryStrategy:
          type: string
          description: "容灾策略, 副本不可用时自动查主副本"
          example: PRIMARY_FIRST
    CreateProjectModifyRecordsRequest:
      type: object
      description: 创建修改传输对象记录请求体，对应 ModifyProjectMappingRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: 项目ID
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
        databases:
          type: array
          description: 数据库对象列表（库表映射）
          items:
            type: object
            description: 数据库列表。
        transferMapping:
          type: object
          description: 传输对象/匹配规则
          example:
            databases:
              - test_db
            mode: SPECIFIC
        precheckId:
          type: string
          description: 加表场景预检查ID（可选）
          example: 预检查ID(可选)
      required:
        - id
    CreateProjectRequest:
      type: object
      description: 创建项目请求体
      properties:
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        name:
          type: string
          description: 项目名称，不能包含空格
          example: 数据源名称
        type:
          type: string
          description: 项目类型，MIGRATION 数据迁移 / SYNC 数据同步
          enum:
            - MIGRATION
            - SYNC
          example: MIGRATION
        sourceDatasourceId:
          type: string
          description: 源端数据源ID
          example: resource-123456
        sinkDatasourceId:
          type: string
          description: 目标端数据源ID
          example: resource-123456
        transferMapping:
          type: object
          description: 传输对象映射，mode 支持 SPECIFIC/WILDCARD/COMPLEX
          properties:
            mode:
              type: string
              description: SPECIFIC 指定对象 / WILDCARD 匹配规则 / COMPLEX 混合
              example: NORMAL
            subMode:
              type: string
              description: 传输对象映射子模式
              nullable: true
              example: SPECIFIC
            whiteTableRules:
              type: array
              description: 白名单表匹配规则列表
              items:
                description: 白名单表匹配规则列表
                example: "[test_db.test_table]"
              example:
                - test_db.test_table
            whiteViewRules:
              type: array
              description: 白名单视图匹配规则列表
              items:
                description: 白名单视图匹配规则列表
                example: "[test_db.test_view]"
              example:
                - test_db.test_view
            schemas:
              type: array
              description: 库表映射列表
              items:
                type: object
                properties:
                  name:
                    type: string
                    description: 名称。
                    example: 数据源名称
                  mappedName:
                    type: string
                    description: 映射后的目标名称
                    example: target_name
                  tables:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: 名称。
                          example: 数据源名称
                        mappedName:
                          type: string
                          description: 映射后的目标名称
                          example: target_name
                        whereClause:
                          type: string
                          description: 过滤条件，如 user_id > 100
                          example: user_id > 100
                      description: 库表映射中的表映射列表
                    description: 库表映射中的表映射列表
                    example:
                      - name: test_table
                        mappedName: target_table
                        whereClause: user_id > 100
                description: 库表映射列表
              example:
                - name: test_db
                  mappedName: target_db
                  tables:
                    - name: test_table
                      mappedName: target_table
                      whereClause: user_id > 100
          example:
            databases:
              - test_db
            mode: SPECIFIC
        commonTransferConfig:
          type: object
          description: 通用传输配置
          properties:
            tableCategory:
              type: string
              description: 表类别，如 ALL
              example: ALL
          example:
            throttle: 100
            timezone: +08:00
        enableFullTransfer:
          type: boolean
          description: 是否启用全量传输
          example: true
        enableStructTransfer:
          type: boolean
          description: 是否启用结构传输
          example: true
        enableIncrTransfer:
          type: boolean
          description: 是否启用增量传输
          example: true
        fullTransferConfig:
          type: object
          description: 全量传输配置
          properties:
            allowDestTableNotEmpty:
              type: boolean
              description: 是否允许目标表非空
              example: false
            writeWorkerNum:
              type: integer
              description: 写入并发数
              example: 8
            readWorkerNum:
              type: integer
              description: 读取并发数
              example: 8
          example:
            enable: true
        structTransferConfig:
          type: object
          description: 结构传输配置
          properties:
            enableIndexBehind:
              type: boolean
              description: 是否在表结构迁移后创建索引
              example: true
          example:
            enable: true
        incrTransferConfig:
          type: object
          properties:
            recordTypeWhiteList:
              type: array
              description: 增量数据类型，如 INSERT/DELETE/UPDATE/DDL
              items:
                type: string
                description: 增量同步的记录类型白名单
                example: "[INSERT, UPDATE, DELETE]"
              example:
                - INSERT
                - UPDATE
                - DELETE
            incrSyncThreadCount:
              type: integer
              description: 增量同步线程数
              example: 4
            supportDDLTypes:
              type: array
              description: 增量同步支持的 DDL 类型列表
              items:
                type: string
                description: 增量同步支持的 DDL 类型列表
                example: "[CREATE_TABLE, ALTER_TABLE]"
              example:
                - CREATE_TABLE
                - ALTER_TABLE
            incrOnlineDdlConfig:
              type: array
              items:
                description: 增量同步在线 DDL 配置列表
                example: |
                  - ddlType: ALTER_TABLE
                    strategy: ONLINE
              description: 增量同步在线 DDL 配置列表
              example:
                - ddlType: ALTER_TABLE
                  strategy: ONLINE
          description: 增量配置
          example:
            enable: true
        labelIds:
          type: array
          description: 标签ID集合
          items:
            type: string
            description: 标签ID集合
            example: |-
              ---
              - "label-123456"
          example:
            - label-123456
        id:
          type: string
          description: 项目ID（可选，不传则自动生成）
          example: np_7befdmp08juo
      required:
        - type
        - sourceDatasourceId
        - sinkDatasourceId
    CreateReadonlyConnectionRequestOpenAPI:
      type: object
      description: 创建Readonly连接请求参数OpenAPI
      properties:
        zoneIdList:
          type: array
          description: 用户选择的zone
          items:
            type: string
            description: 用户选择的zone
            example: |-
              ---
              - "cn-hangzhou-i"
              - "cn-hangzhou-j"
          example:
            - cn-hangzhou-i
            - cn-hangzhou-j
        userAccount:
          type: string
          description: 在privatelink service中需要加白的用户账号
          example: "200006001999"
        trafficStrategy:
          type: string
          description: 流量策略
          example: ZONE_FIRST
        replicaParams:
          type: string
          description: 选择副本
          example: cn-hangzhou-i:F:1
        disasterRecoveryReplicaParams:
          type: string
          description: 选择容灾副本
          example: cn-hangzhou-i:F:1
        balancedStrategy:
          type: string
          description: 均衡策略
          example: BALANCED
        disasterRecoveryStrategy:
          type: string
          description: "容灾策略, 副本不可用时自动查主副本"
          example: PRIMARY_FIRST
        vpcConnectionInfoId:
          type: integer
          format: int64
          description: peering连接ID，非云厂商的id
          example: 10001
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        proxySetting:
          allOf:
            - $ref: "#/components/schemas/ProxySetting"
          description: ODP 数据库代理配置，用于创建只读连接地址时指定代理规格、节点数和部署参数
    CreateReadonlyConnectionResponseOpenAPI:
      type: object
      description: 创建Readonly连接响应结果OpenAPI
      properties:
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
    CreateServiceNetworkAddressRequestOpenAPI:
      type: object
      properties:
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        subnetId:
          type: string
          description: 子网标识。
          example: subnet-xxxxxx
        vipServiceType:
          type: string
          description: 地址类型
          example: PRIVATE
        zoneIdList:
          type: array
          description: 用户选择的zone
          items:
            type: string
            description: 用户选择的zone
            example: |-
              ---
              - "cn-hangzhou-i"
              - "cn-hangzhou-j"
          example:
            - cn-hangzhou-i
            - cn-hangzhou-j
        trafficStrategy:
          type: string
          description: 流量策略
          example: ZONE_FIRST
        replicaParams:
          type: string
          description: 选择副本
          example: cn-hangzhou-i:F:1
        disasterRecoveryReplicaParams:
          type: string
          description: 选择容灾副本
          example: cn-hangzhou-i:F:1
        balancedStrategy:
          type: string
          description: 均衡策略
          example: BALANCED
        disasterRecoveryStrategy:
          type: string
          description: "容灾策略, 副本不可用时自动查主副本"
          example: PRIMARY_FIRST
      description: 创建ServiceNetwork地址请求参数OpenAPI
    CreateSqlAuditServiceRequestOpenAPI:
      type: object
      description: 创建SQLAuditService请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        retentionTime:
          type: integer
          format: int32
          description: 数据保留时长。
          example: 30
        hotDays:
          type: integer
          format: int32
          description: 热数据保留天数。
          example: 7
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    CreateTagsRequest:
      type: object
      description: 批量创建标签请求参数
      properties:
        orgId:
          type: string
          description: 组织ID
          example: ukp31txz9tmk6yqckhox****
        tagValueList:
          type: array
          description: 标签 value 列表
          items:
            allOf:
              - $ref: "#/components/schemas/TagValueInput"
            description: 标签 value 列表
          example:
            - tagKey: env
              tagValue: prod
      required:
        - orgId
        - tagValueList
    CreateTenantAddressOperation:
      type: object
      description: 创建租户地址Operation
    CreateTenantPlServiceRequestOpenAPI:
      type: object
      description: 创建租户PlService请求参数OpenAPI
      properties:
        userAccount:
          type: string
          description: 用户加白的账号
          example: "200006001999"
        plServiceId:
          type: string
          description: PrivateLink 服务 ID。
          example: plsvc-xxxxxx
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        isSharedPlService:
          type: boolean
          description: 是否共享pl_service
          example: false
    CreateTenantPlServiceResponseOpenAPI:
      type: object
      description: 创建租户PlService响应结果OpenAPI
      properties:
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
    CreateTenantRequestOpenAPI:
      type: object
      description: 创建租户请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: 集群id
          example: obcluster-*****
        tenantName:
          type: string
          description: 租户名
          example: pay_core
        tenantId:
          type: string
          description: 租户id，适用于已生成租户id的情况，例如：主备库
          example: t4louaeei****
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        primaryZone:
          type: string
          description: 主zone
          example: cn-hangzhou-i
        charset:
          type: string
          description: 字符集
          example: utf8mb4
        collation:
          type: string
          description: 字符序排序规则。
          example: utf8mb4_general_ci
        description:
          type: string
          description: 描述
          example: 用于业务交易的租户
        whitelist:
          type: string
          description: 白名单
          example: "127.0.0.1,10.0.0.0/8"
        timeZone:
          type: string
          description: 时区
          example: +08:00
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        memory:
          type: integer
          format: int32
          description: 资源规格中的内存信息
          example: 16
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        environment:
          type: string
          description: 环境
          example: PROD
        enablePublicLink:
          type: boolean
          description: 是否创建公网地址
          example: false
        parameterTemplate:
          type: string
          description: 参数模板
          example: oltp
        createParams:
          type: object
          description: 创建tenant的参数
          additionalProperties:
            type: string
          example:
            lower_case_table_names: "1"
            read_only: "false"
        tenantCompatibilityModeEnum:
          description: 租户兼容模式，通常为 MySQL 或 Oracle
          example: MYSQL
          allOf:
            - $ref: "#/components/schemas/TenantCompatibilityModeEnum"
        proxyAddressMasterZone:
          type: string
          description: 代理地址主zone
          example: cn-hangzhou-i
        proxySetting:
          allOf:
            - $ref: "#/components/schemas/ProxySetting"
          description: 租户代理连接配置，用于创建租户时同步创建或配置 ODP 连接地址
    CreateTenantResponseOpenAPI:
      type: object
      description: 创建租户响应结果OpenAPI
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        extra:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/Object"
          description: 扩展信息。
          example: {}
    CreateTenantRestoreTaskRequestV2OpenAPI:
      type: object
      description: 创建租户恢复任务请求参数VOpenAPI
      properties:
        sourceInstanceId:
          type: string
          description: 源实例 ID。
          example: obcluster-source
        sourceTenantId:
          type: string
          description: 源租户 ID。
          example: t4source****
        sourceTenants:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeRestorableTenantsResponseV2"
            description: 源租户列表。
          description: 源租户列表。
          example:
            - tenantId: t4louaeei****
              tenantName: pay_core
        sourceObTenantId:
          type: integer
          format: int64
          description: 源 OceanBase 租户 ID。
          example: 10001
        targetInstanceId:
          type: string
          description: 目标实例 ID。
          example: obcluster-target
        targetTenantName:
          type: string
          description: 目标租户名称。
          example: pay_core_restore
        targetTenantId:
          type: string
          description: 目标租户 ID。
          example: t4target****
        targetTenantPrimaryZone:
          type: string
          description: 目标租户 Primary Zone。
          example: cn-hangzhou-i
        targetTenantDescription:
          type: string
          description: 目标租户描述。
          example: 恢复后的目标租户
        tenantResource:
          allOf:
            - $ref: "#/components/schemas/RestoreTenantResource"
          description: 租户资源规格信息
        restoreTime:
          type: string
          format: date-time
          description: 恢复时间点。
          example: 2026-02-25T15:40:43Z
        restoreObjects:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/RestoreObject"
            description: 恢复对象列表。
          description: 恢复对象列表。
          example:
            - databaseName: test_db
              tableName: orders
        fromRemote:
          type: boolean
          description: 是否从异地备份恢复。
          example: false
        restoreObjectType:
          type: string
          description: 恢复对象类型，例如租户、数据库或表。
          example: tenant
        restoreMode:
          type: string
          description: 恢复模式。
          example: from_time_point
        tenantCache:
          type: integer
          format: int32
          description: 租户缓存开关。
          example: 0
        triggerByAsyncTask:
          type: boolean
          description: 是否由异步任务触发。
          example: false
        needToCheckTargetCluster:
          type: boolean
          description: 是否需要检查目标集群状态。
          example: true
        needToAddTargetTenantMeta:
          type: boolean
          description: 是否需要写入目标租户元数据。
          example: true
        needUpdateTargetClusterStatus:
          type: boolean
          description: 是否需要更新目标集群状态。
          example: true
        needToActiveTenantAfterRestored:
          type: boolean
          description: 恢复完成后是否需要激活目标租户。
          example: true
        needToUpgrade:
          type: boolean
          description: 恢复后是否需要升级。
          example: true
        needToStartTargetTenantLogBackup:
          type: boolean
          description: 是否需要启动目标租户日志备份。
          example: true
        needToCreateTenantSLB:
          type: boolean
          description: 是否需要创建租户 SLB。
          example: true
        isCrossCloudModeRestore:
          type: boolean
          description: 是否为跨云恢复。
          example: false
        crossCloudBackupInfo:
          allOf:
            - $ref: "#/components/schemas/CrossCloudBackupInfo"
          description: 跨云恢复使用的备份信息。
        restoreUsePublicNetwork:
          type: boolean
          description: 恢复是否使用公网。
          example: false
        restoreUseCustomEndpoint:
          type: boolean
          description: 恢复是否使用自定义 Endpoint。
          example: false
        backupCustomEndpoint:
          type: string
          description: 恢复时使用的备份自定义 Endpoint。
          example: oss-cn-hangzhou-internal.aliyuncs.com
        restoreTaskId:
          type: integer
          format: int64
          description: 恢复任务 ID。
          example: 10001
        method:
          type: string
          description: 操作方式。
          example: RESTORE
        backupSetId:
          type: string
          description: 备份集ID
          example: backup_123456789
        needToRestoreTenantWhiteList:
          type: boolean
          description: 是否需要恢复租户白名单。
          example: false
        needToCreateRestoreTaskData:
          type: boolean
          description: 是否需要创建恢复任务数据。
          example: true
        backupWhiteMode:
          type: string
          description: 恢复白名单处理模式。
          example: OVERWRITE
        restoreForValidation:
          type: boolean
          description: 是否抽检场景发起，默认false
          example: false
        validationBackupDest:
          type: string
          description: "抽检备份集的目标路径,restoreForValidation==true时必填"
          example: oss://oceanbase-backup/validation/backup_123456789
        restoreTenant:
          type: boolean
          description: 待恢复的租户信息。
          example: false
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
    CreateUserParamDo:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        userName:
          type: string
          description: 用户名称
          example: root
        password:
          type: string
          description: 用户密码。
          example: your-password
        userType:
          type: string
          description: 用户类型。
          example: NORMAL
        roles:
          type: string
          description: 角色列表。
          example: READONLY
        encryptionType:
          type: string
          description: Encryption type参数
          example: NORMAL
        globalPermissions:
          type: string
          description: 全局权限列表。
          example: READONLY
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
        host:
          type: string
          description: 数据库主机地址
          example: your-host
      description: 创建用户参数数据对象
    CrossCloudBackupInfo:
      type: object
      description: CrossCloud备份信息
      properties:
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        backupConnectInfo:
          allOf:
            - $ref: "#/components/schemas/BackupConnectInfo"
          description: 备份存储连接信息，包括 endpoint、bucket、访问凭据和存储类型
    CustomMonitorConfigRequestOpenAPI:
      type: object
      description: Custom监控配置请求参数OpenAPI
      properties:
        customMonitorDimension:
          type: string
          description: 自定义监控维度。
          example: TENANT
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        customMonitorConfigName:
          type: string
          description: 自定义监控配置名称。
          example: test-name
        newCustomMonitorConfigName:
          type: string
          description: 新的自定义监控配置名称。
          example: test-name
        customMonitorConfig:
          type: string
          description: 自定义监控配置内容。
          example: "{\"interval\":60,\"enabled\":true}"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    CustomUnitConfig:
      type: object
      description: 自定义Unit Config配置
      properties:
        cpuCores:
          type: integer
          format: int32
          description: cpu 核数
          example: 4
        memory:
          type: integer
          format: int32
          description: 资源规格中的内存信息
          example: 16
    DataBackupMode:
      type: object
      description: 数据备份Mode
    DataBasePrivilegeTypeEnum:
      type: string
      description: 特殊集群类型数据库权限类型枚举
    DataSource:
      type: object
      description: 数据源实体（响应）
      properties:
        id:
          type: integer
          format: int64
          description: 主键 ID，只读
          example: 244
        createTime:
          type: string
          format: date-time
          description: 创建时间，只读
          example: 2026-02-25T15:40:43Z
        updateTime:
          type: string
          format: date-time
          description: 更新时间，只读
          example: 2026-02-25T15:40:43Z
        uuid:
          type: string
          description: 唯一标识，只读
          example: resource-123456
        name:
          type: string
          description: 数据源名称
          example: 数据源名称
        creatorUid:
          type: string
          description: 创建人 uid，只读
          example: resource-123456
        projectId:
          type: string
          description: 项目 ID，只读
          example: hxq3ztx3377nby3v87ry****
        instanceId:
          type: string
          description: OB 实例 ID
          example: obcluster-*****
        tenantId:
          type: string
          description: OB 租户 ID
          example: t4louaeei****
        instanceName:
          type: string
          description: OB 实例名称
          example: test-cluster
        tenantName:
          type: string
          description: OB 租户名称
          example: pay_core
        username:
          type: string
          description: 数据库用户名
          example: admin
        host:
          type: string
          description: 主机
          example: your-host
        port:
          type: integer
          description: 端口
          example: 2881
        cloudProvider:
          allOf:
            - $ref: "#/components/schemas/CloudProvider"
          description: 资源或数据源所在云厂商
        region:
          type: string
          description: 地域。
          example: ap-guangzhou
        databaseType:
          allOf:
            - $ref: "#/components/schemas/DataSourceType"
          description: 数据库类型
        instanceType:
          allOf:
            - $ref: "#/components/schemas/InstanceType"
          description: 实例类型
        networkAccessType:
          allOf:
            - $ref: "#/components/schemas/NetworkAccessType"
          description: 网络访问方式，例如公网、私网或 Endpoint
        visible:
          type: boolean
          description: 是否对用户可见
          example: true
        description:
          type: string
          description: 描述
          example: 用于业务交易的租户
    DataSourceType:
      type: string
      description: 数据源数据库类型
      enum:
        - OB_MYSQL
        - OB_ORACLE
        - MYSQL
        - ORACLE
        - DORIS
        - TIDB
        - POSTGRESQL
        - KAFKA
    DeleteDatabasesParamDo:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        databaseNames:
          type: string
          description: 数据库名称列表。
          example: test_db
        force:
          type: boolean
          description: 是否强制执行。
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: 删除Databases参数数据对象
    DeleteInstanceOpenRequest:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      description: 删除集群实例Open请求参数
    DeleteInstanceResponse:
      type: object
      description: 删除集群实例响应结果
      properties:
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
        dryRunResult:
          type: boolean
          description: 预检查的结果
          example: true
        errorCode:
          type: string
          description: 错误码
          example: INVALID_PARAMETER
        errorMessage:
          type: string
          description: 错误信息
          example: Invalid parameter
    DeleteTagRequest:
      type: object
      description: 删除标签请求参数
      properties:
        orgId:
          type: string
          description: 组织ID
          example: ukp31txz9tmk6yqckhox****
        id:
          type: integer
          format: int64
          description: 标签 value ID（内层 ID）
          example: 244
      required:
        - orgId
        - id
    DeleteTagResponse:
      type: object
      description: 删除标签响应结果
      properties:
        Code:
          type: integer
          format: int32
          description: 响应状态码
          example: 200
        Deletable:
          type: boolean
          description: 是否可删除
          example: false
        Message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        RequestId:
          type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        Success:
          type: boolean
          description: 是否成功
          example: true
    DeleteTenantUserParamDo:
      type: object
      description: 删除租户用户参数数据对象
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        users:
          type: string
          description: Users参数
          example: admin
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeAvailableRoZonesRequestOpenAPI:
      type: object
      description: 查询AvailableRoZones请求参数OpenAPI
      properties:
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        memory:
          type: integer
          format: int32
          description: 资源规格中的内存信息
          example: 16
        logDisk:
          type: integer
          format: int32
          description: 日志盘大小（GB）
          example: 200
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
    DescribeAvailableRoZonesResponseOpenAPI:
      type: object
      description: 查询AvailableRoZones响应结果OpenAPI
      properties:
        zonesInfo:
          type: array
          description: 可用区信息列表
          items:
            allOf:
              - $ref: "#/components/schemas/TenantRoZoneInfoDoV2OpenAPI"
            description: 可用区信息列表
    DescribeBackupInfoResponseV2OpenAPI:
      type: object
      description: 查询备份信息响应结果VOpenAPI
      properties:
        backupStrategyStatus:
          description: 备份策略当前状态
          example: ONLINE
          allOf:
            - $ref: "#/components/schemas/BackupStrategyStatus"
        latestBackupTime:
          type: string
          format: date-time
          description: 上一次数据备份时间
          example: 2026-02-25T15:40:43Z
        nextBackupTime:
          type: string
          format: date-time
          description: 预期下一次数据备份时间
          example: 2026-02-25T15:40:43Z
        latestLogBackupCheckpoint:
          type: string
          format: date-time
          description: 日志备份位点
          example: 2026-02-25T15:40:43Z
        logBackupStatus:
          description: 日志备份当前状态
          example: ONLINE
          allOf:
            - $ref: "#/components/schemas/LogBackupStatus"
        logBackupDelaySeconds:
          type: integer
          format: int64
          description: 日志备份延迟，单位秒
          example: 1
        compactionStartTime:
          type: string
          format: date-time
          description: 合并起始时间
          example: 2026-02-25T15:40:43Z
        compactionEndTime:
          type: string
          format: date-time
          description: 合并结束时间
          example: 2026-02-25T15:40:43Z
        freeBackupDays:
          type: integer
          format: int32
          description: 免费备份天数
          example: 1
        localBackupStorageSizeInfo:
          allOf:
            - $ref: "#/components/schemas/BackupStorageSizeInfo"
          description: 本地备份存储容量统计
        remoteBackupStorageSizeInfo:
          allOf:
            - $ref: "#/components/schemas/BackupStorageSizeInfo"
          description: 异地备份存储容量统计
        remoteBackupEnable:
          type: boolean
          description: 是否允许异地备份
          example: true
        sparseBackupEnable:
          type: boolean
          description: 是否允许稀疏备份
          example: true
        backupDownloadEnable:
          type: boolean
          description: 是否允许下载备份集
          example: true
        logicalTableBackupEnabled:
          type: boolean
          description: 是否开启逻辑表备份
          example: true
        logicalTableBackupMaxNum:
          type: integer
          format: int64
          description: 逻辑表备份最大数量
          example: 3
        logicalDatabaseRestoreMaxNum:
          type: integer
          format: int64
          description: 逻辑库恢复最大数量
          example: 3
    DescribeBackupSetDownloadLinkResponseV2OpenAPI:
      type: object
      properties:
        downloadTaskId:
          type: integer
          format: int64
          description: Download task id参数
          example: 10001
        downloadTaskStatus:
          type: string
          description: 下载任务状态。
          example: ONLINE
        downloadTaskCreateTime:
          type: string
          description: 下载任务创建时间。
          example: 2026-02-25T15:40:43Z
        backupRestorableTime:
          type: string
          description: 备份集可恢复到的时间点。
          example: 2026-02-25T15:40:43Z
        backupSetId:
          type: string
          description: 备份集ID
          example: backup_123456789
        compressedBackupSetSize:
          type: number
          format: double
          description: 压缩后的备份集大小。
          example: 200.0
        internalUrl:
          type: string
          description: 内部下载地址。
          example: https://internal.example.com/backup/link
        urlExpiredTime:
          type: string
          description: 下载地址过期时间。
          example: 2026-02-25T15:40:43Z
        urlAliveTime:
          type: integer
          format: int64
          description: 下载地址有效时长。
          example: 1
      description: 查询备份SetDownloadLink响应结果VOpenAPI
    DescribeBackupStrategyResponseV2OpenAPI:
      type: object
      properties:
        scheduleTime:
          type: string
          description: 调度时间。
          example: 2026-02-25T15:40:43Z
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        backupModel:
          description: 数据备份调度模式，例如按周或按月
          example: PHYSICAL
          allOf:
            - $ref: "#/components/schemas/BackupModel"
        timeList:
          type: array
          items:
            type: integer
            format: int32
            description: 备份或调度时间列表。
          description: 备份或调度时间列表。
        lastDayOfMonth:
          type: boolean
          description: 是否为每月最后一天。
          example: true
        backupDataType:
          type: string
          description: 备份数据类型。
          example: NORMAL
        launchIncBackup:
          type: boolean
          description: 是否启用增量备份。
          example: true
        launchExpirationCleanup:
          type: boolean
          description: 是否启用过期备份清理。
          example: true
        cleanupScheduleTime:
          type: string
          description: 清理任务调度时间。
          example: 2026-02-25T15:40:43Z
        dataMaintainDays:
          type: integer
          format: int32
          description: 数据备份保留天数。
          example: 30
        nextBackupTime:
          type: string
          description: 预期下一次数据备份时间
          example: 2026-02-25T15:40:43Z
        offsite:
          type: string
          description: 是否启用异地备份。
          example: "OFF"
        crossRegionFlag:
          type: boolean
          description: 是否开启跨地域备份。
          example: true
        crossBorder:
          type: boolean
          description: 是否跨境。
          example: true
        retainMode:
          type: string
          description: 保留策略模式。
          example: DAYS
        remoteBackupRegion:
          type: string
          description: 异地备份地域。
          example: cn-hangzhou
        localBackupRegion:
          type: string
          description: 本地备份地域。
          example: cn-hangzhou
        remoteBackupStrategy:
          allOf:
            - $ref: "#/components/schemas/RemoteBackupStrategyV2"
          description: 异地备份策略配置
        archiveFlag:
          type: boolean
          description: 是否启用归档备份。
          example: true
        archiveBackupStrategy:
          allOf:
            - $ref: "#/components/schemas/LocalArchiveBackupStrategyV2"
          description: 本地归档备份策略配置
        remoteArchiveFlag:
          type: boolean
          description: 是否开启异地归档备份。
          example: true
        remoteArchiveBackupStrategy:
          allOf:
            - $ref: "#/components/schemas/RemoteArchiveBackupStrategyV2"
          description: 异地归档备份策略配置
        sparseBackupFlag:
          type: boolean
          description: 是否启用稀疏备份。
          example: true
        sparseBackupStrategies:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SparseBackupStrategyV2"
            description: 稀疏备份策略列表。
          description: 稀疏备份策略列表。
          example:
            - id: resource-123456
        backupMode:
          type: string
          description: 备份模式，例如物理备份或逻辑备份。
          example: physical
        backupStorageConfig:
          type: string
          description: 备份存储配置。
          example: "200"
        tenantIds:
          type: array
          items:
            type: string
            description: 租户 ID 列表。
            example: |-
              ---
              - "t4louaeei****"
          description: 租户 ID 列表。
          example:
            - t4louaeei****
        tenantScopeInfos:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BackupTenantScopeInfo"
            description: 备份策略适用的租户范围列表。
          description: 备份策略适用的租户范围列表。
          example:
            - tenantId: t4louaeei****
              tenantName: pay_core
      description: 查询备份Strategy响应结果VOpenAPI
    DescribeBinlogCommodityProduceInfoResponseForOpenApi:
      type: object
      description: 查询Binlog商品Produce信息响应结果ForOpenApi
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        orderStatus:
          type: string
          description: 订单状态。
          example: SUCCESS
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    DescribeBinlogServiceResponseForOpenApi:
      type: object
      description: "{@link TenantBinlogDTO}"
      properties:
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        diskCapacityInMB:
          type: integer
          format: int32
          description: 磁盘容量，单位 MB。
          example: 102400
        logRetentionTimeInHour:
          type: integer
          format: int32
          description: 日志保留时长，单位为小时。
          example: 72
        diskUsageInMB:
          type: integer
          format: int32
          description: 磁盘已使用容量，单位 MB。
          example: 20480
        binlogFile:
          type: string
          description: Binlog 文件名。
          example: mysql-bin.000001
        binlogOffset:
          type: string
          description: Binlog 位点偏移量。
          example: "154"
        rps:
          type: number
          format: double
          description: 每秒请求数。
          example: 120.5
        ddlCompatMode:
          type: boolean
          description: Binlog DDL 兼容模式。
          example: true
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        binlogSessionCount:
          type: integer
          format: int32
          description: Binlog 会话数量。
          example: 8
        currentTransferPosition:
          type: string
          description: 当前传输位点。
          example: mysql-bin.000001:154
        earliestTransferPosition:
          type: string
          description: 最早可传输位点。
          example: mysql-bin.000001:4
        tradeInstanceId:
          type: string
          description: Trade instance id参数
          example: trade-123456
        tradeInstanceStatus:
          type: string
          description: 交易实例状态。
          example: RUNNING
        chargeType:
          type: string
          description: 计费类型，例如按量付费或包年包月。
          example: POSTPAID
        storageType:
          type: string
          description: 存储类型。
          example: OSS
        cu:
          type: integer
          format: int32
          description: Binlog 服务计算单元数量。
          example: 2
        storageSize:
          type: integer
          format: int32
          description: 存储容量。
          example: 200
        freeCu:
          type: integer
          format: int32
          description: 可用 Binlog 计算单元数量。
          example: 1
        freeStorageSize:
          type: integer
          format: int32
          description: 可用存储容量。
          example: 100
        upperConvertRps:
          type: integer
          format: int64
          description: Binlog 转换链路 RPS 上限。
          example: 10000
        upperConvertIops:
          type: number
          format: float
          description: Binlog 转换链路 IOPS 上限。
          example: 1000.0
        upperDumpRps:
          type: integer
          format: int64
          description: Binlog dump 链路 RPS 上限。
          example: 10000
        upperDumpIops:
          type: number
          format: float
          description: Binlog dump 链路 IOPS 上限。
          example: 1000.0
        upperDumpConn:
          type: integer
          format: int32
          description: Binlog dump 连接数上限。
          example: 100
        upperScaleUp:
          type: integer
          format: int32
          description: 是否允许向上扩容。
          example: 1
        lowerScaleDown:
          type: integer
          format: int32
          description: 是否允许向下缩容。
          example: 1
        cuType:
          type: string
          description: Binlog 服务计算单元类型。
          example: STANDARD
    DescribeCapacityResourceRequestOpenAPI:
      type: object
      description: 查询容量资源请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeCustomMonitorConfigRequestOpenAPI:
      type: object
      description: 查询Custom监控配置请求参数OpenAPI
      properties:
        customMonitorDimension:
          type: string
          description: 自定义监控维度。
          example: TENANT
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeDataBackupSetResponseV2OpenAPI:
      type: object
      description: 查询数据备份Set响应结果VOpenAPI
      properties:
        backupSetId:
          type: string
          description: 备份集ID
          example: backup_123456789
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        backupMode:
          allOf:
            - $ref: "#/components/schemas/BackupMode"
          description: 备份模式，例如物理备份或逻辑备份。
        dataBackupMode:
          allOf:
            - $ref: "#/components/schemas/DataBackupMode"
          description: 数据备份方式，例如全量或增量
        backupObjectType:
          description: "cluster: 集群，tenant：租户，database：库，table：表 see {@link com.oceanbase.cloud.backup.facade.enums.BackupObjectType}"
          example: tenant
          allOf:
            - $ref: "#/components/schemas/BackupObjectType"
        dataVersion:
          type: integer
          format: int64
          description: 数据版本。
          example: 1
        dataBackupSize:
          type: number
          format: double
          description: standard类型，数据备份大小，含免费
          example: 200.0
        triggerMode:
          allOf:
            - $ref: "#/components/schemas/BackupTaskTriggerType"
          description: 备份任务触发方式，例如自动调度或手动触发
        checkpoint:
          type: string
          format: date-time
          description: 备份集或恢复任务的检查点。
          example: 2026-02-25T15:40:43Z
        startTime:
          type: string
          format: date-time
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          format: date-time
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        progress:
          type: string
          description: 任务进度。
          example: "1"
        status:
          description: 任务或资源当前状态
          example: ONLINE
          allOf:
            - $ref: "#/components/schemas/DataBackupTaskStatus"
        validity:
          description: 备份集有效性状态
          example: VALID
          allOf:
            - $ref: "#/components/schemas/BackupValidity"
        downloadEnabled:
          type: boolean
          description: 是否允许下载。
          example: true
        downloadTaskId:
          type: integer
          format: int64
          description: Download task id参数
          example: 10001
        tenantBackupSetList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeDataBackupSetResponseV2OpenAPI"
            description: 租户备份集列表。
          description: 租户备份集列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
    DescribeInstanceAvailableRoZonesRequestOpenApi:
      type: object
      description: 查询集群实例AvailableRoZones请求参数OpenApi
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeInstanceAvailableRoZonesResponseOpenApi:
      type: object
      description: 查询集群实例AvailableRoZones响应结果OpenApi
      properties:
        availableRoZones:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/AvailableRoZoneDo"
            description: 可创建只读副本的可用区列表。
          description: 可创建只读副本的可用区列表。
    DescribeInstanceODPForMonitorResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        proxyClusterForTenantResponseMcList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeTenantODPForMonitorResponse"
            description: 租户关联的 ODP 代理集群列表。
          description: 租户关联的 ODP 代理集群列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
      description: 查询集群实例ODPFor监控响应结果OpenAPI
    DescribeInstanceOperationParamDoOpenAPI:
      type: object
      description: 查询集群实例Operation参数数据对象OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        operations:
          type: string
          description: 操作准入项列表。
          example: "CreateTenant,ModifyTenantUnitResource"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
    DescribeInstanceOperationResponseOpenAPI:
      type: object
      description: 查询集群实例Operation响应结果OpenAPI
      properties:
        standardCapacityScaleVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例standard Capacity Scale入口是否可展示，以及不可展示时的原因码和提示信息
        standardCapacityScale:
          allOf:
            - $ref: "#/components/schemas/StandardCapacityScaleOperation"
          description: 实例standard Capacity Scale操作准入结果，以及不可执行时的原因码和提示信息
        temporaryCapacityScale:
          allOf:
            - $ref: "#/components/schemas/TemporaryCapacityScaleOperation"
          description: 实例temporary Capacity Scale操作准入结果，以及不可执行时的原因码和提示信息
        dataDiskAutoScale:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例data Disk Auto Scale操作准入结果，以及不可执行时的原因码和提示信息
        dataDiskAutoScaleVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例data Disk Auto Scale入口是否可展示，以及不可展示时的原因码和提示信息
        isolationOptimization:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例isolation Optimization操作准入结果，以及不可执行时的原因码和提示信息
        readOnlyReplica:
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaOperation"
          description: 实例read Only Replica操作准入结果，以及不可执行时的原因码和提示信息
        readOnlyReplicaVisible:
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaOperationVisible"
          description: 实例read Only Replica入口是否可展示，以及不可展示时的原因码和提示信息
        modifyOCUScaleConfig:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify OCUScale Config操作准入结果，以及不可执行时的原因码和提示信息
        createStandByInstanceVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Stand By Instance入口是否可展示，以及不可展示时的原因码和提示信息
        createStandByInstance:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Stand By Instance操作准入结果，以及不可执行时的原因码和提示信息
        deleteInstanceVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例delete Instance入口是否可展示，以及不可展示时的原因码和提示信息
        deleteInstance:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例delete Instance操作准入结果，以及不可执行时的原因码和提示信息
        changeChargeType:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例change Charge Type操作准入结果，以及不可执行时的原因码和提示信息
        modifyDeployMode:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Deploy Mode操作准入结果，以及不可执行时的原因码和提示信息
        createTenants:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Tenants操作准入结果，以及不可执行时的原因码和提示信息
        modifyMonitorFrequency:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Monitor Frequency操作准入结果，以及不可执行时的原因码和提示信息
        modifyDiskType:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Disk Type操作准入结果，以及不可执行时的原因码和提示信息
        migrateUnit:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例migrate Unit操作准入结果，以及不可执行时的原因码和提示信息
        cancelMigrateUnit:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例cancel Migrate Unit操作准入结果，以及不可执行时的原因码和提示信息
        createTenantAddress:
          allOf:
            - $ref: "#/components/schemas/CreateTenantAddressOperation"
          description: 实例create Tenant Address操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantPrimaryZoneVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Primary Zone入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantPrimaryZone:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Primary Zone操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantUnitResourceVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Unit Resource入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantUnitResource:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Unit Resource操作准入结果，以及不可执行时的原因码和提示信息
        createTenantUserVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Tenant User入口是否可展示，以及不可展示时的原因码和提示信息
        createTenantUser:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Tenant User操作准入结果，以及不可执行时的原因码和提示信息
        createDatabaseVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Database入口是否可展示，以及不可展示时的原因码和提示信息
        createDatabase:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例create Database操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantReadOnlyReplicaVisible:
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaOperationVisible"
          description: 实例modify Tenant Read Only Replica入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantReadOnlyReplica:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Read Only Replica操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantDefaultAiFunctionVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Default Ai Function入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantDefaultAiFunction:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Default Ai Function操作准入结果，以及不可执行时的原因码和提示信息
        modifyStandbyTenantSyncStrategy:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Standby Tenant Sync Strategy操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantSecurityIpGroupVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Security Ip Group入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantSecurityIpGroup:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 实例modify Tenant Security Ip Group操作准入结果，以及不可执行时的原因码和提示信息
    DescribeInstanceResponseV2OpenAPI:
      type: object
      description: 查询集群实例响应结果VOpenAPI
      properties:
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        instanceName:
          type: string
          description: 集群名称
          example: test-cluster
        instanceClass:
          type: string
          description: 集群规格
          example: 4C16G
        series:
          type: string
          description: 实例系列。
          example: NORMAL
        payType:
          type: string
          description: 付费类型。
          example: POSTPAID
        createTime:
          type: string
          description: |-
            "2020-12-23T04:14:48Z" <br/>
            创建时间
          example: 2026-02-25T15:40:43Z
        expireTime:
          type: string
          description: |-
            "2020-12-23T04:14:48Z" <br/>
            到期时间
          example: 2020-12-23T04:14:48Z
        availableZones:
          type: array
          description: |-
            ["h", "i", "j"] <br/>
            可用区域
          items:
            type: string
            description: |-
              ["h", "i", "j"] <br/>
              可用区域
            example: |-
              ---
              - "h"
          example:
            - h
        version:
          type: string
          description: |-
            "2.2.52" <br/>
            OB 版本
          example: 2.2.52
        obRpmVersion:
          type: string
          description: |-
            "4.2.1.0-100020042023102310" <br/>
            OB RPM版本
          example: 4.2.1.0-100020042023102310
        deployType:
          type: string
          description: |-
            'single' | 'multiple' | 'dual' <br/>
            部署类型: 单机房｜多机房｜双机房
          example: single
        diskType:
          type: string
          description: |-
            "cloud_essd_pl1" | "ephemeral_ssd" <br/>
            存储类型: ESSD云盘 | 本地SSD盘
          example: cloud_essd
        deployMode:
          type: string
          description: |-
            "1-1-1" <br/>
            部署模式
          example: 1-1-1
        replicaMode:
          type: string
          description: |-
            '2' | '3' <br/>
            全功能型副本数
          example: "2"
        dataMergeTime:
          type: string
          description: |-
            "02:00" <br/>
            数据合并时间
          example: 02:00
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        resource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2"
          description: 资源规格信息，包括 CPU、内存、磁盘和节点资源等
        cloudProvider:
          type: string
          description: 资源或数据源所在云厂商
          example: "[ALIYUN]"
        instanceType:
          type: string
          description: 实例类型
          example: DEDICATED
        instanceRole:
          type: string
          description: 实例角色，例如主实例或备实例。
          example: PRIMARY
        primaryInstanceId:
          type: string
          description: 2022-05-10 主库ID，仅当instanceRole=PHYSICAL_STANDBY时有效
          example: obcluster-primary
        standbyInstanceIds:
          type: array
          description: 2022-05-10 备库ID，仅当instanceRole=PRIMARY时有效
          items:
            type: string
            description: 2022-05-10 备库ID，仅当instanceRole=PRIMARY时有效
            example: |-
              ---
              - "obcluster-standby"
          example:
            - obcluster-standby
        customTenantLogTransferMethod:
          type: string
          description: 备库中客户自定义的跨云日志同步方式，仅当instanceRole=PHYSICAL_STANDBY时有效 枚举：NETWORK，ARCHIVE_LOG
          example: NETWORK
        saleChannel:
          type: string
          description: |-
            售卖渠道: overseas: 海外自营渠道 domestic: 国内自营渠道 aliyun_domestic: 阿里云国内站 huawei_mp_domestic: 华为云国内站 aws_mp_domestic: AWS国内站 aws-mp: AWS海外站
            aliyun_overseas: 阿里云海外站 gcp_mp: GCP Marketplace
          example: domestic
        managementMode:
          type: string
          description: 管理模式
          example: DBAAS
        tagList:
          type: array
          description: 集群实例标签列表
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 集群实例标签列表
          example:
            - tagKey: env
              tagValue: prod
        nodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        cpuArchitecture:
          type: string
          description: CPU 架构。
          example: "4"
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
        stopTime:
          type: string
          description: 停止时间。
          example: 2026-02-26T10:40:43Z
        storageArchitecture:
          type: string
          description: "存储架构,shareStorage/standardStorage 共享存储/标准存储"
          example: standardStorage
        storageDiskType:
          type: string
          description: 存储类型; 目前仅tp模式支持选择存储类型且仅支持OBPL1
          example: OBPL1
        originalDeployMode:
          type: string
          description: |-
            "1-1-1" <br/>
            原始部署模式
          example: 1-1-1
    DescribeInstanceSSLResponseOpenAPI:
      type: object
      description: 查询集群实例SSL响应结果OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        enableSSL:
          type: string
          description: 是否启用 SSL。
          example: "true"
        forceSSLSupport:
          type: boolean
          description: 是否支持强制 SSL。
          example: true
        forceSSL:
          type: string
          description: 是否强制使用 SSL。
          example: "ON"
        validPeriod:
          type: string
          description: SSL 证书有效期。
          example: "365"
        caUrl:
          type: string
          description: CA 证书下载地址。
          example: https://example.com/ca.pem
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        certificationType:
          type: string
          description: 证书类型。
          example: NORMAL
        autoUpdate:
          type: string
          description: 是否自动更新 SSL 证书。
          example: 2026-02-25
        certValid:
          type: boolean
          description: 证书是否有效。
          example: true
    DescribeInstanceSecurityConfigsResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        checkTime:
          type: string
          description: 检查时间。
          example: 2026-02-25T15:40:43Z
        checkId:
          type: string
          description: Check id参数
          example: resource-123456
        totalCheckCount:
          type: integer
          format: int32
          description: 检查项总数。
          example: 3
        totalRiskCount:
          type: integer
          format: int32
          description: 风险项总数。
          example: 3
        securityConfigs:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SecurityConfigInfoOpenAPI"
            description: 安全配置列表。
          description: 安全配置列表。
          example:
            - id: resource-123456
      description: 查询集群实例安全Configs响应结果OpenAPI
    DescribeMetricClassRequestOpenAPI:
      type: object
      description: 查询指标Class请求参数OpenAPI
      properties:
        metricScope:
          type: string
          description: 监控指标作用范围。
          example: TENANT
        metricType:
          type: string
          description: 监控指标类型。
          example: NORMAL
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeMetricsDataRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        metrics:
          type: string
          description: 指标名称列表
          example: cpu_usage
        labels:
          type: string
          description: 标签
          example: "tenantId,serverIp"
        groupByLabels:
          type: string
          description: 分组标签
          example: tenantId
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        sortMetricKey:
          type: string
          description: 排序指标键
          example: env
        sortOrder:
          type: string
          description: 排序顺序
          example: DESC
        limit:
          type: integer
          format: int32
          description: 结果数量限制
          example: 100
        maxDataPoints:
          type: integer
          format: int32
          description: 最大数据点数量。
          example: 1440
        aggregation:
          type: string
          description: 聚合方式
          example: AVG
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        isBackend:
          type: boolean
          description: 是否后端
          example: true
        isOpenApiRequest:
          type: boolean
          description: 是否OpenAPI请求
          example: true
        addNameInfo:
          type: boolean
          description: 添加名称信息
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: 查询Metrics数据请求参数
    DescribeMetricsRequestV2:
      type: object
      description: 查询Metrics请求参数V
      properties:
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        metrics:
          type: array
          items:
            type: string
            description: 指标名称列表
            example: |-
              ---
              - "cpu_usage"
          description: 指标名称列表
          example:
            - cpu_usage
        tenantIdList:
          type: array
          description: 租户Id列表
          items:
            type: string
            description: 租户Id列表
        nodeIdList:
          type: array
          description: 节点Id列表
          items:
            type: string
            description: 节点Id列表
            example: |-
              ---
              - "resource-123456"
          example:
            - resource-123456
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeModifyRecordResponse:
      type: object
      description: 修改记录响应，对应 DescribeModifyRecordResponse
      properties:
        id:
          type: integer
          format: int64
          description: 资源唯一标识。
          example: 244
        subProjectId:
          type: string
          description: 子项目id（增表时产生）
          example: hxq3ztx3377nby3v87ry****
        mergeRequestId:
          type: integer
          format: int64
          description: 合并父子项目工单id（加表场景）
          example: 1
        updateRequestId:
          type: integer
          format: int64
          description: 更新父项目工单id（减表或已有表对象更新）
          example: 1
        type:
          type: string
          description: 修改记录任务类型
          example: NORMAL
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        errorDetail:
          type: object
          description: 错误详情（状态为FAILED时）
          example:
            id: resource-123456
        databases:
          type: array
          description: 减少的对象等
          items:
            type: object
            description: 数据库列表。
        difference:
          type: object
          description: 修改前后对象差异
          example:
            id: resource-123456
        beforeTransferMapping:
          type: object
          description: 修改前传输对象
          example:
            mode: SPECIFIC
        afterTransferMapping:
          type: object
          description: 修改后传输对象
          example:
            mode: SPECIFIC
        gmtModified:
          type: string
          description: 修改时间
          example: 2026-02-26T10:40:43Z
    DescribeMonitorFrequencyRequestOpenAPI:
      type: object
      description: 查询监控Frequency请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeOperationEventRequestOpenAPI:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        resourceIdOrName:
          type: string
          description: 资源ID或者资源名称
          example: obcluster-*****
        callerUids:
          type: array
          items:
            type: string
            description: 调用者uid列表
            example: |-
              ---
              - "resource-123456"
          description: 调用者uid列表
          example:
            - resource-123456
        eventTypes:
          type: array
          items:
            type: string
            description: 事件类型列表
          description: 事件类型列表
        eventOperations:
          type: array
          items:
            type: string
            description: 事件操作列表
          description: 事件操作列表
        eventSources:
          type: array
          items:
            type: string
            description: 事件来源列表。
          description: 事件来源列表。
        eventMessage:
          type: string
          description: 事件消息。
          example: successful
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        startTimeLong:
          type: integer
          format: int64
          description: 开始时间戳。
          example: 1772026843000
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        endTimeLong:
          type: integer
          format: int64
          description: 结束时间戳。
          example: 1772095243000
        eventStatus:
          type: string
          description: 操作事件状态
          example: SUCCESS
        sortField:
          type: string
          description: 排序字段
          example: createTime
        sortOrder:
          type: string
          description: 排序顺序
          example: DESC
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        offset:
          type: integer
          format: int32
          description: 分页偏移量。
          example: 1
        queryKey:
          type: string
          description: 查询条件关键字
          example: env
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
      description: 查询Operation事件请求参数OpenAPI
    DescribeOperationEventsRequestV2OpenAPI:
      type: object
      properties:
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: 查询OperationEvents请求参数VOpenAPI
    DescribeProjectRequest:
      type: object
      description: 查询项目详情请求体，对应 CommonIdRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
      required:
        - id
    DescribeProxyServerResponseMc:
      type: object
      properties:
        proxyServerId:
          type: string
          description: ODP 代理节点 ID。
          example: proxy-123456
        proxyServerIp:
          type: string
          description: ODP 代理节点 IP 地址。
          example: 10.0.0.10
        spec:
          type: string
          description: 规格信息。
          example: 2C4G
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        version:
          type: string
          description: |-
            "2.2.52" <br/>
            OB 版本
          example: 2.2.52
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        servicePort:
          type: integer
          format: int32
          description: 服务端口。
          example: 2881
        diskType:
          type: string
          description: |-
            "cloud_essd_pl1" | "ephemeral_ssd" <br/>
            存储类型: ESSD云盘 | 本地SSD盘
          example: cloud_essd
        diskPl:
          type: string
          description: 磁盘性能级别。
          example: "200"
        diskId:
          type: string
          description: 磁盘标识。
          example: "200"
        diskSize:
          type: string
          description: 磁盘大小
          example: "200"
        resources:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ObcloudProxyResource"
            description: 资源列表。
          description: 资源列表。
          example:
            - id: resource-123456
      description: 查询ProxyServer响应结果管控
    DescribeReadonlyInstancesResponseV2OpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        readonlyInstances:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ReadonlyInstanceDoV2OpenAPI"
            description: 只读副本实例列表。
          description: 只读副本实例列表。
          example:
            - id: resource-123456
      description: 查询ReadonlyInstances响应结果VOpenAPI
    DescribeRestorableTenantsRequestV2OpenAPI:
      type: object
      description: 查询RestorableTenants请求参数VOpenAPI
      properties:
        tenantId:
          type: string
          description: 租户id，非必选，如果不为空表示只查询该租户的可恢复时间区间
          example: t4louaeei****
        backupSetId:
          type: string
          description: 备份集id，非必选，如果不为空表示只查询该备份集可支持恢复的租户
          example: backup_123456789
        restoreObjectType:
          type: string
          description: 恢复对象类型，例如租户、数据库或表。
          example: tenant
        fromRemote:
          type: boolean
          description: 是否异地发起可恢复时间解析
          example: false
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
    DescribeRestorableTenantsResponseV2:
      type: object
      description: 查询RestorableTenants响应结果V
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        checkpoint:
          type: string
          format: date-time
          description: 备份集或恢复任务的检查点。
          example: 2026-02-25T15:40:43Z
        timeIntervalList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TimeInterval"
            description: 时间区间列表。
          description: 时间区间列表。
          example:
            - id: resource-123456
        clusterId:
          type: string
          description: 集群ID
          example: obcluster-*****
        clusterName:
          type: string
          description: 集群备份目录，可以为空
          example: test-cluster
        obRpmVersion:
          type: string
          description: |-
            "4.2.1.0-100020042023102310" <br/>
            OB RPM版本
          example: 4.2.1.0-100020042023102310
        obVersion:
          type: string
          description: OceanBase 版本。
          example: 4.2.1.0
        sourceRegion:
          type: string
          description: 源地域
          example: cn-hangzhou
        tenantAlias:
          type: string
          description: 租户别名
          example: pay_core
        cpuNum:
          type: integer
          format: int32
          description: CPU 数量。
          example: 4
        memoryNum:
          type: integer
          format: int32
          description: 内存数量。
          example: 16
        usedDisk:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        method:
          type: string
          description: 操作方式。
          example: RESTORE
        backupSetRestoreSummaries:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BackupSetRestoreSummary"
            description: 可恢复备份集摘要列表。
          description: 可恢复备份集摘要列表。
          example:
            - id: resource-123456
        tenantDataBackupRemainDays:
          type: integer
          format: int32
          description: 租户数据备份剩余保留天数。
          example: 1
        obTenantId:
          type: string
          description: OceanBase 租户 ID。
          example: t4louaeei****
    DescribeSQLDetailRequestOpenAPI:
      type: object
      description: 查询SQL详情请求参数OpenAPI
      properties:
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        parseTable:
          type: boolean
          description: 是否解析表信息。
          example: true
        parameterized:
          type: boolean
          description: 是否返回参数化文本
          example: true
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        searchKeyWord:
          type: string
          description: SQL关键字
          example: update
        searchParam:
          type: string
          description: 搜索参数。
          example: tenantName
        searchRule:
          type: string
          description: 搜索规则。
          example: LIKE
        searchValue:
          type: string
          description: 搜索值。
          example: pay
        nodeIp:
          type: string
          description: 节点IP
          example: 10.0.0.10
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        filterCondition:
          type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        sortOrder:
          type: string
          description: 排序顺序
          example: DESC
        sortColumn:
          type: string
          description: 排序字段。
          example: createTime
        sqlTextLength:
          type: integer
          format: int64
          description: SQL文本最大长度
          example: 65535
        dynamicSql:
          type: boolean
          description: Dynamic sql参数
          example: false
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
        - startTime
        - endTime
    DescribeSQLHistoryRequestOpenAPI:
      type: object
      description: 查询SQLHistory请求参数OpenAPI
      properties:
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        isInnerConsole:
          type: boolean
          description: 是否为内部控制台请求。
          example: true
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        searchKeyWord:
          type: string
          description: SQL关键字
          example: update
        searchParam:
          type: string
          description: 搜索参数。
          example: tenantName
        searchRule:
          type: string
          description: 搜索规则。
          example: LIKE
        searchValue:
          type: string
          description: 搜索值。
          example: pay
        nodeIp:
          type: string
          description: 节点IP
          example: 10.0.0.10
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        filterCondition:
          type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        sortOrder:
          type: string
          description: 排序顺序
          example: DESC
        sortColumn:
          type: string
          description: 排序字段。
          example: createTime
        sqlTextLength:
          type: integer
          format: int64
          description: SQL文本最大长度
          example: 65535
        dynamicSql:
          type: boolean
          description: Dynamic sql参数
          example: false
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - sqlId
        - instanceId
        - startTime
        - endTime
    DescribeSqlAuditsRequestOpenAPI:
      type: object
      description: 查询SQLAudits请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        nodeIp:
          type: string
          description: 节点IP
          example: 10.0.0.10
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        searchKeyWord:
          type: string
          description: SQL关键字
          example: update
        searchKeyWordMethod:
          type: string
          description: SQL 关键字搜索方式。
          example: env
        userName:
          type: string
          description: 用户名称
          example: root
        operatorType:
          type: string
          description: 操作类型。
          example: NORMAL
        clientIp:
          type: string
          description: Client ip参数
          example: successful
        executeTimeMin:
          type: integer
          format: int32
          description: SQL 最小执行耗时。
          example: 1
        executeTimeMax:
          type: integer
          format: int32
          description: SQL 最大执行耗时。
          example: 1
        scanRowsMin:
          type: integer
          format: int32
          description: SQL 最小扫描行数。
          example: 1
        scanRowsMax:
          type: integer
          format: int32
          description: SQL 最大扫描行数。
          example: 1
        NeedMasking:
          type: boolean
          description: 是否需要脱敏。
          example: true
        sortField:
          type: string
          description: 排序字段
          example: createTime
        sortType:
          type: string
          description: 排序方式。
          example: NORMAL
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
        - tenantId
        - startTime
        - endTime
    DescribeSqlPlanRequestOpenAPI:
      type: object
      description: 查询SQLPlan请求参数OpenAPI
      properties:
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        isInnerConsole:
          type: boolean
          description: 是否为内部控制台请求。
          example: true
        returnBriefInfo:
          type: boolean
          description: Return brief info参数
          example: true
        planUnionHash:
          type: string
          description: Plan union hash参数
          example: plan_123456789
        checkOutlineStatus:
          type: boolean
          description: Check outline status参数
          example: true
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        searchKeyWord:
          type: string
          description: SQL关键字
          example: update
        searchParam:
          type: string
          description: 搜索参数。
          example: tenantName
        searchRule:
          type: string
          description: 搜索规则。
          example: LIKE
        searchValue:
          type: string
          description: 搜索值。
          example: pay
        nodeIp:
          type: string
          description: 节点IP
          example: 10.0.0.10
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        filterCondition:
          type: string
          description: 过滤条件，字段用@引用
          example: '@avgCpuTime > 20 and @executions > 100'
        sortOrder:
          type: string
          description: 排序顺序
          example: DESC
        sortColumn:
          type: string
          description: 排序字段。
          example: createTime
        sqlTextLength:
          type: integer
          format: int64
          description: SQL文本最大长度
          example: 65535
        dynamicSql:
          type: boolean
          description: Dynamic sql参数
          example: false
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
        - startTime
        - endTime
    DescribeTagsResponse:
      type: array
      description: 标签列表响应结果
      items:
        $ref: "#/components/schemas/TagKey"
    DescribeTenantConnectionODPForMonitorResponse:
      type: object
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        userVpcOwnerId:
          type: string
          description: 用户 VPC 所属账号标识。
          example: "200006001999"
        vSwitchId:
          type: string
          description: 交换机标识。
          example: vsw-xxxxx
        connectionZones:
          type: array
          description: 连接的zone
          items:
            type: string
            description: 连接的zone
            example: |-
              ---
              - "cn-hangzhou-i"
          example:
            - cn-hangzhou-i
        tenantEndpointId:
          type: string
          description: 多云v5 补充 tenantEndpoint Id
          example: te-xxxxxx
        addressId:
          type: string
          description: 多云里即vip service group name
          example: rs-private-internet-*****
        addressStatus:
          type: string
          description: 连接状态
          example: ONLINE
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        addressType:
          type: string
          description: 地址类型：MASTER，READONLY
          example: MASTER
        networkType:
          type: string
          description: 网络类型
          example: INTRANET
        role:
          type: string
          description: "连接类型, 读写/仅读. READWRITE/READONLY 有时候主地址也需要区分读写类型，备库的主地址是只读的"
          example: READWRITE
        userNameFormat:
          type: string
          description: 使用该地址时用户名格式：一段式、两段式
          example: TWO_PART
        useSSL:
          type: boolean
          description: 是否打开ssl
          example: false
        proxyClusterId:
          type: string
          description: 独占 k8s proxy cluster 集群ID
          example: proxy-123456
        proxyClusterInfo:
          allOf:
            - $ref: "#/components/schemas/ProxyClusterInfoDTO"
          description: 租户连接关联的 ODP 代理集群信息
        odpVersion:
          type: string
          description: ODP 版本。
          example: 4.2.1
        readStrategyConfigResponse:
          allOf:
            - $ref: "#/components/schemas/TenantAddressReadStrategyConfigDTO"
          description: 租户连接地址的读流量策略配置
        deleteSingleTunnelAddress:
          type: boolean
          description: 是否可以删除阿里云私网主地址
          example: true
        internetAddress:
          type: string
          description: 公网地址
          example: 8.8.8.8
        internetPort:
          type: integer
          format: int32
          description: 公网端口
          example: 2881
        internetDomain:
          type: string
          description: 公网地址
          example: pay-core-public.oceanbase.example.com
        internetAddressStatus:
          type: string
          description: 公网地址状态
          example: ONLINE
        internetMaxConnectionNum:
          type: integer
          format: int32
          description: 公网最大连接数
          example: 10000
        enableUpdateMaxConnectionNum:
          type: boolean
          description: 公网是否允许修改最大连接数
          example: true
        internetMaxConnectionNumLimit:
          type: integer
          format: int32
          description: 公网最大连接数 limit 限制
          example: 20000
        internetRpcPort:
          type: integer
          format: int32
          description: 公网 RPC 端口
          example: 2882
        internetProxyClusterId:
          type: string
          description: 公网proxy cluster id
          example: proxy-123456
        intranetAddress:
          type: string
          description: 私网地址
          example: 10.0.0.10
        intranetPort:
          type: integer
          format: int32
          description: 内网端口
          example: 2881
        intranetDomain:
          type: string
          description: 内网地址
          example: pay-core-private.oceanbase.example.com
        intranetAddressStatus:
          type: string
          description: 内网地址状态
          example: ONLINE
        maxConnectionNum:
          type: integer
          format: int32
          description: 私网最大连接数
          example: 10000
        maxConnectionNumLimit:
          type: integer
          format: int32
          description: 私网最大连接数修改 Limit 限制
          example: 20000
        intranetRpcPort:
          type: integer
          format: int32
          description: 私网 RPC 端口
          example: 2882
        enableRPc:
          type: boolean
          description: 是否开启 rpc ，旁路导入
          example: true
        intranetAddressMasterZoneId:
          type: string
          description: 主zone id
          example: cn-hangzhou-i
        intranetAddressSlaveZoneId:
          type: string
          description: 备zone id
          example: cn-hangzhou-j
        intranetProxyClusterId:
          type: string
          description: 私网的proxy cluster id
          example: proxy-123456
        privateLinkList:
          type: array
          description: private link列表信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantPrivateLinkDTO"
            description: private link列表信息
          example:
            - id: resource-123456
        intranetPeeringAddress:
          type: string
          description: peering地址
          example: 10.1.0.10
        intranetPeeringPort:
          type: integer
          format: int32
          description: peering地址端口
          example: 2881
        intranetPeeringDomain:
          type: string
          description: peering地址域名
          example: pay-core-peering.oceanbase.example.com
        intranetPeeringAddressStatus:
          type: string
          description: peering地址状态
          example: ONLINE
        intranetPeeringMaxConnectionNum:
          type: integer
          format: int32
          description: peering地址最大连接数
          example: 10000
        peeringDstVpcId:
          type: string
          description: peering地址对端vpc id
          example: vpc-peer-xxxxx
        peeringDstCidrList:
          type: string
          description: peering地址对端cidr
          example: 10.1.0.0/16
        peeringId:
          type: string
          description: 对等连接 ID。
          example: pcx-xxxxxx
        intranetPeeringProxyClusterId:
          type: string
          description: peering私网地址proxy cluster id
          example: proxy-123456
        proxyServerList:
          type: array
          description: 节点信息
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeProxyServerResponseMc"
            description: 节点信息
          example:
            - id: resource-123456
      description: 查询租户连接ODPFor监控响应结果
    DescribeTenantEncryptionResponseOpenAPI:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
          description: 总记录数。
          example: 100
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        tenantEncryptionList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TenantEncryptionDtoOpenAPI"
            description: 租户加密配置列表。
          description: 租户加密配置列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
      description: 查询租户加密响应结果OpenAPI
    DescribeTenantODPForMonitorResponse:
      type: object
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        describeTenantConnectionODPForMonitorResponseList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeTenantConnectionODPForMonitorResponse"
            description: 租户连接地址关联的 ODP 代理监控信息列表。
          description: 租户连接地址关联的 ODP 代理监控信息列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
      description: 查询租户ODPFor监控响应结果
    DescribeTenantOperationParamDoOpenAPI:
      type: object
      description: 查询租户Operation参数数据对象OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        unitId:
          type: string
          description: Unit id参数
          example: resource-123456
        operations:
          type: string
          description: 操作准入项列表。
          example: "CreateTenant,ModifyTenantUnitResource"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      required:
        - instanceId
        - tenantId
    DescribeTenantOperationResponseOpenAPI:
      type: object
      description: 查询租户Operation响应结果OpenAPI
      properties:
        migrateUnit:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户migrate Unit操作准入结果，以及不可执行时的原因码和提示信息
        cancelMigrateUnit:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户cancel Migrate Unit操作准入结果，以及不可执行时的原因码和提示信息
        createTenantAddress:
          allOf:
            - $ref: "#/components/schemas/CreateTenantAddressOperation"
          description: 租户create Tenant Address操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantPrimaryZoneVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户modify Tenant Primary Zone入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantPrimaryZone:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户modify Tenant Primary Zone操作准入结果，以及不可执行时的原因码和提示信息
        modifyTenantUnitResourceVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户modify Tenant Unit Resource入口是否可展示，以及不可展示时的原因码和提示信息
        modifyTenantUnitResource:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户modify Tenant Unit Resource操作准入结果，以及不可执行时的原因码和提示信息
        createTenantUserVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户create Tenant User入口是否可展示，以及不可展示时的原因码和提示信息
        createTenantUser:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户create Tenant User操作准入结果，以及不可执行时的原因码和提示信息
        createDatabaseVisible:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户create Database入口是否可展示，以及不可展示时的原因码和提示信息
        createDatabase:
          allOf:
            - $ref: "#/components/schemas/Operation"
          description: 租户create Database操作准入结果，以及不可执行时的原因码和提示信息
    DescribeTenantReadableScnResponse:
      type: object
      properties:
        readableScn:
          type: integer
          format: int64
          description: 租户当前可读 SCN。
          example: 1720000000000000000
      description: 查询租户ReadableScn响应结果
    DescribeTenantSecurityConfigsResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        checkTime:
          type: string
          description: 检查时间。
          example: 2026-02-25T15:40:43Z
        checkId:
          type: string
          description: Check id参数
          example: resource-123456
        totalCheckCount:
          type: integer
          format: int32
          description: 检查项总数。
          example: 3
        totalRiskCount:
          type: integer
          format: int32
          description: 风险项总数。
          example: 3
        tenantSecurityConfigs:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TenantSecurityConfigOpenAPI"
            description: 租户安全配置列表。
          description: 租户安全配置列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
      description: 查询租户安全Configs响应结果OpenAPI
    DescribeTenantUserRolesResponseOpenAPI:
      type: object
      description: 查询租户用户Roles响应结果OpenAPI
      properties:
        userRoleList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/UserRoleOpenAPI"
            description: 用户角色列表。
          description: 用户角色列表。
          example:
            - id: resource-123456
        globalPermissions:
          type: string
          description: 全局权限列表。
          example: READONLY
    DescribeUserPasswordValidateRuleResponseOpenAPI:
      type: object
      description: 查询用户PasswordValidateRule响应结果OpenAPI
      properties:
        userPasswordValidateRules:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/UserPasswordValidateRule"
            description: 用户密码校验规则列表。
          description: 用户密码校验规则列表。
    DisconnectInstanceResponse:
      type: object
      description: 解耦实例响应体
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    DiskDoV2:
      type: object
      description: 磁盘数据对象V
      properties:
        totalDiskSize:
          type: number
          format: double
          description: 磁盘总容量。
          example: 200.0
        usedDiskSize:
          type: number
          format: double
          description: 已使用磁盘容量。
          example: 200.0
        originalTotalDiskSize:
          type: number
          format: double
          description: 变更前磁盘总容量。
          example: 200.0
        totalDataSize:
          type: number
          format: double
          description: 数据总量。
          example: 200.0
        unitDiskSize:
          type: number
          format: double
          description: 单元磁盘大小
          example: 200.0
        availableDiskSize:
          type: number
          format: double
          description: "用户实际可用的存储大小（单位：GB） 计算公式：getAvailableDiskSize(unitDiskSize,\
            \ nodeCount, obVersion, shareStorageCluster)"
          example: 200.0
    DiskDoV2OpenAPI:
      type: object
      description: 磁盘数据对象VOpenAPI
      properties:
        totalDiskSize:
          type: number
          format: double
          description: 磁盘总容量。
          example: 200.0
        usedDiskSize:
          type: number
          format: double
          description: 已使用磁盘容量。
          example: 200.0
        totalDataSize:
          type: number
          format: double
          description: 数据总量。
          example: 200.0
        unitDiskSize:
          type: number
          format: double
          description: 单元磁盘大小
          example: 200.0
        availableDiskSize:
          type: number
          format: double
          description: 用户实际可用的存储大小（单位：GB）
          example: 200.0
    HttpServletRequest:
      type: object
      description: HttpServlet请求参数
    InstanceCommodityComponent:
      type: object
      properties:
        componentCode:
          type: string
          description: 组件编码。
          example: cpu
        componentValue:
          type: string
          description: 组件取值。
          example: 4C
      description: Instance Commodity Component
    InstanceType:
      type: string
      description: 数据库实例商品类型；网关可能接受 "OB" 作为 OceanBase 相关类型的简写
      enum:
        - OB
        - OB_CLOUD_CLUSTER
        - OB_CLOUD_OLAP
        - OB_CLOUD_TENANT
        - OB_CLOUD_KV
        - HUAWEI_RDS
        - HUAWEI_SELF_MANAGED
        - HUAWEI_SAAS
        - AWS_RDS
        - AWS_AURORA
        - AWS_SELF_MANAGED
        - AWS_MSK
        - TENCENT_DB
        - TENCENT_SELF_MANAGED
        - TENCENT_CKAFKA
        - GCP_CLOUD_SQL
        - GCP_SELF_MANAGED
        - GCP_SAAS
        - ALIYUN_RDS
        - ALIYUN_POLARDB
        - ALIYUN_SELF_MANAGED
        - ALIYUN_APSARAMQ
        - ALIYUN_LOCALIZATION_OB_CLUSTER
        - AZURE_DB
        - AZURE_SELF_MANAGED
    JSONArray:
      type: object
      description: JSONArray
    LocalArchiveBackupStrategyV2:
      type: object
      properties:
        backupScheduleMode:
          type: string
          description: 备份调度模式，例如按周或按月执行
          example: WEEK
        timeList:
          type: array
          items:
            type: integer
            format: int32
            description: 备份或调度时间列表。
          description: 备份或调度时间列表。
        backupTimesInMonth:
          type: string
          description: 每月备份次数
          example: 2026-02-25T15:40:43Z
        dataMaintainDays:
          type: integer
          format: int32
          description: 数据备份保留天数。
          example: 30
      description: LocalArchive备份StrategyV
    McCreateOutlineRequestOpenAPI:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        sqlText:
          type: string
          description: SQL语句文本
          example: SELECT * FROM users WHERE id = 1
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        tableName:
          type: string
          description: Table name参数
          example: orders
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        outlineData:
          type: string
          description: Outline 数据。
          example: /*+ INDEX(users idx_users_id) */
        indexName:
          type: string
          description: 索引名称。
          example: test-name
        maxConcurrent:
          type: integer
          format: int32
          description: 最大并发数。
          example: 1
        isConcurrentLimit:
          type: boolean
          description: Is concurrent limit参数
          example: true
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        dynamicSql:
          type: boolean
          description: Dynamic sql参数
          example: false
        statementId:
          type: string
          description: SQL Outline 语句标识。
          example: resource-123456
        bySqlId:
          type: boolean
          description: 是否按 SQL ID 创建 Outline。
          example: true
      description: 管控创建执行计划请求参数OpenAPI
    McDeleteSecurityIpGroupRequestOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
      description: 管控删除安全IPGroup请求参数OpenAPI
    McDeleteTenantSecurityIpGroupRequest:
      type: object
      properties:
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
      description: 管控删除租户安全IPGroup请求参数
    McDeleteTenantSecurityIpGroupResponse:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
      description: 管控删除租户安全IPGroup响应结果
    McDescribeParametersHistoryRequestOpenAPI:
      type: object
      description: 管控查询ParametersHistory请求参数OpenAPI
      properties:
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        page:
          type: integer
          format: int32
          description: 页码。
          example: 1
        size:
          type: integer
          format: int32
          description: 分页大小。
          example: 200
    McDescribeParametersHistoryResponseOpenAPI:
      type: object
      description: 管控查询ParametersHistory响应结果OpenAPI
      properties:
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        totalCount:
          type: integer
          format: int32
          description: 总记录数。
          example: 100
        parameters:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McOcpParameterHistoryDo"
            description: 参数列表。
          description: 参数列表。
          example:
            - id: resource-123456
    McDescribeProcessListCompositionDTOOpenAPI:
      type: object
      description: 管控查询Process列表CompositionDTOOpenAPI
      properties:
        obVersion:
          type: string
          description: OceanBase 版本。
          example: 4.2.1.0
        totalSessionCount:
          type: integer
          format: int64
          description: 会话总数。
          example: 3
        idleSessionCount:
          type: integer
          format: int64
          description: 空闲会话数量。
          example: 3
        activeSessionCount:
          type: integer
          format: int32
          description: 活跃会话数量。
          example: 3
        sessionList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McProcessListDOOpenAPI"
            description: 会话 ID 列表。
          description: 会话 ID 列表。
        statisticsResponse:
          allOf:
            - $ref: "#/components/schemas/McDescribeSessionStatisticsResponseOpenAPI"
          description: 会话列表的统计汇总信息
    McDescribeSessionAnalysisResponseOpenAPI:
      type: object
      description: 管控查询会话Analysis响应结果OpenAPI
      properties:
        sqlTypeAnalysis:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionAnalysisAggDo"
            description: 按 SQL 类型聚合的会话分析结果。
          description: 按 SQL 类型聚合的会话分析结果。
          example:
            - id: resource-123456
        userAnalysis:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionAnalysisAggDo"
            description: 按用户维度聚合的会话分析结果。
          description: 按用户维度聚合的会话分析结果。
          example:
            - id: resource-123456
        sourceAnalysis:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionAnalysisAggDo"
            description: 按来源维度聚合的会话分析结果。
          description: 按来源维度聚合的会话分析结果。
          example:
            - id: resource-123456
        dataBaseAnalysis:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionAnalysisAggDo"
            description: 按数据库维度聚合的会话分析结果。
          description: 按数据库维度聚合的会话分析结果。
          example:
            - databaseName: test_db
    McDescribeSessionStatisticsResponseOpenAPI:
      type: object
      description: 管控查询会话Statistics响应结果OpenAPI
      properties:
        userStatistics:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionStatisticsCommonDoOpenAPI"
            description: 按用户维度聚合的会话统计结果。
          description: 按用户维度聚合的会话统计结果。
          example:
            - id: resource-123456
        sourceStatistics:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionStatisticsCommonDoOpenAPI"
            description: 按来源维度聚合的会话统计结果。
          description: 按来源维度聚合的会话统计结果。
          example:
            - id: resource-123456
        dataBaseStatistics:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSessionStatisticsCommonDoOpenAPI"
            description: 按数据库维度聚合的会话统计结果。
          description: 按数据库维度聚合的会话统计结果。
          example:
            - databaseName: test_db
        totalSessionCount:
          type: integer
          format: int64
          description: 会话总数。
          example: 3
        activeSessionCount:
          type: integer
          format: int64
          description: 活跃会话数量。
          example: 3
        idleSessionCount:
          type: integer
          format: int64
          description: 空闲会话数量。
          example: 3
    McDescribeSqlAuditQueryResponseOpenAPI:
      type: object
      description: 管控查询SQLAuditQuery响应结果OpenAPI
      properties:
        userName:
          type: array
          items:
            type: string
            description: 用户名称
            example: |-
              ---
              - "root"
          description: 用户名称
          example:
            - root
        dataBaseName:
          type: array
          items:
            type: string
            description: 数据库名称
            example: |-
              ---
              - "test_db"
          description: 数据库名称
          example:
            - test_db
    McDescribeSqlAuditsResponseOpenAPI:
      type: object
      description: 管控查询SQLAudits响应结果OpenAPI
      properties:
        sqlAuditDTOList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/McSqlAuditDTO"
            description: SQL 审计记录列表。
          description: SQL 审计记录列表。
          example:
            - id: resource-123456
        totalCount:
          type: integer
          format: int64
          description: 总记录数。
          example: 100
    McDescribeSqlCollectorRetentionResponseOpenAPI:
      type: object
      description: 管控查询SQLCollectorRetention响应结果OpenAPI
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        retentionTime:
          type: integer
          format: int32
          description: 数据保留时长。
          example: 30
        hotDays:
          type: integer
          format: int32
          description: 热数据保留天数。
          example: 7
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        hotStorageSize:
          type: integer
          format: int64
          description: 热数据存储容量。
          example: 200
        coldStorageSize:
          type: integer
          format: int64
          description: 冷数据存储容量。
          example: 200
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        filterRule:
          allOf:
            - $ref: "#/components/schemas/SqlAuditFilterRuleConfig"
          description: filter Rule
        supported:
          type: boolean
          description: 是否支持租户敏感字段保护规则能力
          example: true
        disabledReason:
          type: string
          description: disabled Reason
          example: example-value
    McKillAllProcessResponseOpenAPI:
      type: object
      description: 管控KillAllProcess响应结果OpenAPI
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
    McModifySecurityIpGroupRequestOpenAPI:
      type: object
      description: 管控修改安全IPGroup请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        securityIps:
          type: string
          description: 安全 IP 白名单列表。
          example: "127.0.0.1,10.0.0.0/8"
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
    McModifySqlCollectorRetentionResponseOpenAPI:
      type: object
      description: 管控修改SQLCollectorRetention响应结果OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        retentionTime:
          type: integer
          format: int32
          description: 数据保留时长。
          example: 30
    McModifyTenantSecurityIpGroupRequest:
      type: object
      properties:
        securityIps:
          type: string
          description: 安全 IP 白名单列表。
          example: "127.0.0.1,10.0.0.0/8"
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
      description: 管控修改租户安全IPGroup请求参数
    McModifyTenantSecurityIpGroupResponse:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        securityIps:
          type: string
          description: 安全 IP 白名单列表。
          example: "127.0.0.1,10.0.0.0/8"
        securityIpGroupName:
          type: string
          description: 安全 IP 白名单分组名称。
          example: default
      description: 管控修改租户安全IPGroup响应结果
    McOcpParameterHistoryDo:
      type: object
      properties:
        name:
          type: string
          description: 名称。
          example: 数据源名称
        oldValue:
          type: string
          description: 原参数值。
          example: prod
        newValue:
          type: string
          description: 新参数值。
          example: prod
        dimensionValue:
          type: string
          description: 维度取值。
          example: prod
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        updateTime:
          type: string
          description: 更新时间。
          example: 2026-02-25T15:40:43Z
      description: 管控Ocp参数History数据对象
    McProcessListDOOpenAPI:
      type: object
      description: 管控Process列表DOOpenAPI
      properties:
        sqlText:
          type: string
          description: SQL语句文本
          example: SELECT * FROM users WHERE id = 1
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        database:
          type: string
          description: 数据库名称。
          example: test_db
        user:
          type: string
          description: 用户名。
          example: admin
        executeTime:
          type: integer
          format: int64
          description: SQL 执行耗时。
          example: 120
        serverIp:
          type: string
          description: Server ip参数
          example: 10.0.0.10
        clientIp:
          type: string
          description: Client ip参数
          example: successful
        sessionId:
          type: string
          description: 会话标识。
          example: resource-123456
        proxySessId:
          type: string
          description: ODP 代理会话 ID。
          example: proxy-123456
        command:
          type: string
          description: 会话正在执行的命令。
          example: START
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        cpuTime:
          type: integer
          format: int64
          description: SQL 或会话消耗的 CPU 时间。
          example: 1
        traceId:
          type: string
          description: 请求追踪标识。
          example: resource-123456
        planId:
          type: integer
          format: int64
          description: SQL 执行计划 ID。
          example: 1
        dynamicSql:
          type: boolean
          description: Dynamic sql参数
          example: false
        topInfo:
          type: string
          description: Top SQL 信息。
          example: TOP_SQL
    McSessionAnalysisAggDo:
      type: object
      description: 管控会话AnalysisAgg数据对象
      properties:
        percent:
          type: number
          format: double
          description: 占比。
          example: 1.0
        metricValue:
          type: string
          description: 监控指标值。
          example: prod
        sqlCount:
          type: integer
          format: int64
          description: SQL 数量。
          example: 3
        type:
          type: string
          description: 类型。
          example: NORMAL
    McSessionStatisticsCommonDoOpenAPI:
      type: object
      description: 管控会话StatisticsCommon数据对象OpenAPI
      properties:
        metricValue:
          type: string
          description: 监控指标值。
          example: prod
        activeCount:
          type: integer
          format: int64
          description: 活跃会话或连接数量。
          example: 3
        totalCount:
          type: integer
          format: int64
          description: 总记录数。
          example: 100
        type:
          type: string
          description: 类型。
          example: NORMAL
    McSqlAuditDTO:
      type: object
      description: 管控SQLAuditDTO
      properties:
        key:
          type: integer
          format: int32
          description: 键名。
          example: 1
        querySQL:
          type: string
          description: 查询SQL
          example: SELECT * FROM users WHERE id = 1
        sqlID:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        userName:
          type: string
          description: 用户名称
          example: root
        clientIp:
          type: string
          description: Client ip参数
          example: successful
        userClientIp:
          type: string
          description: 用户客户端IP
          example: admin
        operatorType:
          type: string
          description: 操作类型。
          example: NORMAL
        elapsedTime:
          type: number
          format: double
          description: SQL 执行耗时。
          example: 12.5
        scanRows:
          type: integer
          format: int64
          description: SQL 扫描行数。
          example: 1
        affectedRows:
          type: integer
          format: int64
          description: SQL 影响行数。
          example: 1
        requestTime:
          type: string
          description: 请求时间
          example: 2026-02-25T15:40:43Z
        requestTimestamp:
          type: integer
          format: int64
          description: 请求时间戳
          example: 1
        isSuccess:
          type: integer
          format: int64
          description: 操作是否成功。
          example: 1
        retCode:
          type: integer
          format: int64
          description: 返回码。
          example: 0
    MemoryDoV2:
      type: object
      description: 内存数据对象V
      properties:
        totalMemory:
          type: number
          format: double
          description: 内存总量。
          example: 16.0
        usedMemory:
          type: number
          format: double
          description: 已使用内存。
          example: 16.0
        originalTotalMemory:
          type: number
          format: double
          description: 变更前内存总量。
          example: 16.0
        unitMemory:
          type: number
          format: double
          description: 单元内存大小（GB）
          example: 8.0
        hostActualMemory:
          type: number
          format: double
          description: 宿主机实际内存大小，单位 GiB
          example: 16.0
        systemMemory:
          type: number
          format: double
          description: 旗舰版宿主机系统占用内存，单位 GiB。= hostActualMemory - totalMemory
          example: 16.0
    MemoryDoV2OpenAPI:
      type: object
      description: 内存数据对象VOpenAPI
      properties:
        totalMemory:
          type: number
          format: double
          description: 内存总量。
          example: 16.0
        usedMemory:
          type: number
          format: double
          description: 已使用内存。
          example: 16.0
        originalTotalMemory:
          type: number
          format: double
          description: 变更前内存总量。
          example: 16.0
        unitMemory:
          type: number
          format: double
          description: 单元内存大小（GB）
          example: 8.0
        hostActualMemory:
          type: number
          format: double
          description: "宿主机实际内存大小，单位 GiB（与 {@link com.oceanbase.cloud.instance.multicloud.dto.resource.MemoryDoV2}\
            \ 一致）"
          example: 16.0
        systemMemory:
          type: number
          format: double
          description: 旗舰版宿主机系统占用内存，单位 GiB
          example: 16.0
    MergeInstanceRequestOpenAPI:
      type: object
      description: Merge集群实例请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    MigrateResourceUnitRequestOpenAPI:
      type: object
      description: Migrate资源资源单元请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        unitId:
          type: string
          description: Unit id参数
          example: resource-123456
        sourceNodeId:
          type: string
          description: 源节点 ID。
          example: resource-123456
        targetNodeId:
          type: string
          description: 目标节点 ID。
          example: resource-123456
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyBackupStrategyRequestV2OpenAPI:
      type: object
      properties:
        backupScheduleMode:
          description: 备份调度模式，例如按周或按月执行
          example: WEEK
          allOf:
            - $ref: "#/components/schemas/BackupModel"
        scheduleTime:
          type: string
          description: 调度时间。
          example: 2026-02-25T15:40:43Z
        timeList:
          type: array
          items:
            type: integer
            format: int32
            description: 备份或调度时间列表。
          description: 备份或调度时间列表。
        lastDayOfMonth:
          type: boolean
          description: 是否为每月最后一天。
          example: true
        dataMaintainDays:
          type: integer
          format: int32
          description: 数据备份保留天数。
          example: 30
        crossRegionFlag:
          type: boolean
          description: 是否开启跨地域备份。
          example: true
        sparseBackupFlag:
          type: boolean
          description: 是否启用稀疏备份。
          example: true
        isCrossBorder:
          type: boolean
          description: 是否跨境。
          example: true
        retainMode:
          type: string
          description: 保留策略模式。
          example: DAYS
        remoteBackupRegion:
          type: string
          description: 异地备份地域。
          example: cn-hangzhou
        remoteBackupStrategy:
          allOf:
            - $ref: "#/components/schemas/RemoteBackupStrategyV2"
          description: 异地备份策略配置
        sparseBackupStrategies:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SparseBackupStrategyV2"
            description: 稀疏备份策略列表。
          description: 稀疏备份策略列表。
          example:
            - id: resource-123456
        backupStorageConfig:
          type: string
          description: 备份存储配置。
          example: "200"
        archiveFlag:
          type: boolean
          description: 是否启用归档备份。
          example: true
        archiveBackupStrategy:
          allOf:
            - $ref: "#/components/schemas/LocalArchiveBackupStrategyV2"
          description: 本地归档备份策略配置
        archiveBackupCleanMode:
          type: string
          description: 归档备份清理模式 多云默认值delete
          example: AUTO
        tenantIds:
          type: string
          description: 租户 ID 列表。
          example: t4louaeei****
      description: 修改备份Strategy请求参数VOpenAPI
    ModifyDatabaseUserRolesParamDoOpenAPI:
      type: object
      description: 修改数据库用户Roles参数数据对象OpenAPI
      properties:
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        users:
          type: string
          description: Users参数
          example: admin
    ModifyInstanceDataMergeTimeRequestOpenAPI:
      type: object
      description: 修改集群实例数据MergeTime请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        dataMergeTime:
          type: string
          description: 数据合并时间
          example: 02:00
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyInstanceNameRequestV2:
      type: object
      description: 修改集群实例Name请求参数V
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceName:
          type: string
          description: 集群名称
          example: test-cluster
    ModifyInstanceNameResponseV2:
      type: object
      description: 修改集群实例Name响应结果V
      properties:
        instanceName:
          type: string
          description: 集群名称
          example: test-cluster
    ModifyInstanceResponseV2OpenApi:
      type: object
      properties:
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
        dryRunResult:
          type: boolean
          description: 预检查的结果
          example: true
      description: 修改集群实例响应结果VOpenApi
    ModifyInstanceSSLRequestOpenAPI:
      type: object
      description: 修改集群实例SSL请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        enableSSL:
          type: string
          description: 是否启用 SSL。
          example: "true"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyInstanceSSLResponseOpenAPI:
      type: object
      description: 修改集群实例SSL响应结果OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        enableSSL:
          type: string
          description: 是否启用 SSL。
          example: "true"
    ModifyOdpClusterSpecRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        mode:
          type: string
          description: ODP 代理集群规格调整模式。
          example: NORMAL
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        odpClusterNodeType:
          type: string
          description: ODP 代理节点类型。
          example: NORMAL
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
        proxySetting:
          allOf:
            - $ref: "#/components/schemas/ProxySetting"
          description: ODP 代理集群规格配置
      description: Modify Odp Cluster Spec Request
    ModifyOdpClusterSpecRequestOpenAPI:
      type: object
      description: 修改OdpCluster规格请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        mode:
          type: string
          description: ODP 代理集群规格调整模式。
          example: NORMAL
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        odpClusterNodeType:
          type: string
          description: ODP 代理节点类型。
          example: NORMAL
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
        proxySetting:
          allOf:
            - $ref: "#/components/schemas/ProxySetting"
          description: ODP 代理集群规格配置
    ModifySqlCollectorRetentionRequest:
      type: object
      description: 修改SQLCollectorRetention请求参数
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        retentionTime:
          type: integer
          format: int32
          description: 数据保留时长。
          example: 30
        hotDays:
          type: integer
          format: int32
          description: 热数据保留天数。
          example: 7
        collectType:
          type: string
          description: SQL 审计采集类型。
          example: NORMAL
        collectInfo:
          type: string
          description: SQL 审计采集配置信息。
          example: SQL_AUDIT
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifySqlCollectorRetentionRequestOpenAPI:
      type: object
      description: 修改SQLCollectorRetention请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        retentionTime:
          type: integer
          format: int32
          description: 数据保留时长。
          example: 30
        hotDays:
          type: integer
          format: int32
          description: 热数据保留天数。
          example: 7
        collectType:
          type: string
          description: SQL 审计采集类型。
          example: NORMAL
        collectInfo:
          type: string
          description: SQL 审计采集配置信息。
          example: SQL_AUDIT
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyTenantAddressDomainPrefixRequestOpenAPI:
      type: object
      properties:
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        domainPrefix:
          type: string
          description: 新地址域名前缀
          example: pay-core.oceanbase.example.com
      description: 修改租户地址DomainPrefix请求参数OpenAPI
    ModifyTenantAddressDomainPrefixResponseOpenAPI:
      type: object
      description: 修改租户地址DomainPrefix响应结果OpenAPI
    ModifyTenantAddressPortRequestOpenAPI:
      type: object
      properties:
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        port:
          type: integer
          format: int32
          description: 新端口
          example: 2881
      description: 修改租户地址Port请求参数OpenAPI
    ModifyTenantAddressPortResponseOpenAPI:
      type: object
      description: 修改租户地址Port响应结果OpenAPI
    ModifyTenantEncryptionRequestOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        encryptionType:
          type: string
          description: Encryption type参数
          example: NORMAL
        encryptionKeyId:
          type: string
          description: 加密密钥 ID。
          example: resource-123456
      description: 修改租户加密请求参数OpenAPI
    ModifyTenantEncryptionResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        encryptionType:
          type: string
          description: Encryption type参数
          example: NORMAL
        encryptionKeyId:
          type: string
          description: 加密密钥 ID。
          example: resource-123456
      description: 修改租户加密响应结果OpenAPI
    ModifyTenantNameRequestV2:
      type: object
      description: 修改租户Name请求参数V
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        patternCheck:
          type: boolean
          description: 是否通过命名规则检查。
          example: true
    ModifyTenantNameResponseV2:
      type: object
      description: 修改租户Name响应结果V
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
    ModifyTenantPrimaryZoneRequestOpenAPI:
      type: object
      description: 修改租户Primary可用区请求参数OpenAPI
      properties:
        primaryZone:
          type: string
          description: 目标主可用区
          example: cn-hangzhou-i
        proxyAddressMasterZone:
          type: string
          description: 目标代理地址主可用区
          example: cn-hangzhou-i
    ModifyTenantPrimaryZoneResponseOpenAPI:
      type: object
      description: 修改租户Primary可用区响应结果OpenAPI
    ModifyTenantReadonlyReplicaRequestOpenAPI:
      type: object
      description: 修改租户Readonly副本请求参数OpenAPI
      properties:
        readonlyZone:
          type: string
          description: 只读可用区
          example: cn-hangzhou-i
        readOnlyReplicaType:
          type: string
          description: "只读副本类型，可选值：ROW_STORE, COLUMN_STORE"
          example: FULL
        operation:
          type: string
          description: "操作类型，可选值：CREATE, DELETE, UPDATE"
          example: ADD
        customUnitConfig:
          allOf:
            - $ref: "#/components/schemas/CustomUnitConfig"
          description: 自定义 Unit 规格配置。
    ModifyTenantReadonlyReplicaResponseOpenAPI:
      type: object
      description: 修改租户Readonly副本响应结果OpenAPI
      properties:
        instanceId:
          type: string
          description: 实例ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        readonlyZone:
          type: string
          description: 只读可用区
          example: cn-hangzhou-i
        operation:
          type: string
          description: 操作类型
          example: ADD
        success:
          type: boolean
          description: 是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    ModifyTenantUserDescriptionParamDoOpenAPI:
      type: object
      description: 修改租户用户Description参数数据对象OpenAPI
      properties:
        description:
          type: string
          description: Description
          example: 用于业务交易的租户
        host:
          type: string
          description: 数据库主机地址
          example: your-host
    ModifyTenantUserPasswordValidateRuleRequestOpenAPI:
      type: object
      description: 修改租户用户PasswordValidateRule请求参数OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        passwordValidateRuleList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/PasswordValidateRule"
            description: 用户密码校验规则列表。
          description: 用户密码校验规则列表。
        connectionControl:
          type: boolean
          description: "密码锁定策略： true: 开启密码锁定策略 false: 关闭密码锁定策略"
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyUserPasswordParamDo:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        userName:
          type: string
          description: 用户名称
          example: root
        userPassword:
          type: string
          description: 用户密码。
          example: your-password
        encryptionType:
          type: string
          description: Encryption type参数
          example: NORMAL
        clusterGroupName:
          type: string
          description: 集群组名称。
          example: test-cluster
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
        host:
          type: string
          description: 数据库主机地址
          example: your-host
      description: 修改用户Password参数数据对象
    ModifyUserRolesParamDoOpenAPI:
      type: object
      description: 修改用户Roles参数数据对象OpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        userName:
          type: string
          description: 用户名称
          example: root
        userRole:
          type: string
          description: 用户角色。
          example: admin
        modifyType:
          type: string
          description: 用户角色修改类型。
          example: NORMAL
        clusterGroupName:
          type: string
          description: 集群组名称。
          example: test-cluster
        userType:
          type: string
          description: 用户类型。
          example: NORMAL
        GlobalPermissions:
          type: string
          description: 全局权限列表。
          example: READONLY
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ModifyUserStatusParamDoOpenAPI:
      type: object
      description: 修改用户状态参数数据对象OpenAPI
      properties:
        userStatus:
          type: string
          description: 用户状态。
          example: ONLINE
    MultiCloudCreateInstanceRequest:
      type: object
      properties:
        chargeType:
          type: string
          description: 付费方式 POSTPAY/PREPAY
          example: POSTPAID
        instanceName:
          type: string
          description: 实例名称
          example: test-cluster
        cloudProvider:
          type: string
          description: 资源或数据源所在云厂商
          example: "[ALIYUN]"
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        obVersion:
          type: string
          description: OceanBase 版本。
          example: 4.2.1.0
        zones:
          type: string
          description: 可用区列表，逗号分隔
          example: "cn-hangzhou-h,cn-hangzhou-i"
        instanceClass:
          type: string
          description: 集群规格信息
          example: 4C16G
        replicaMode:
          type: string
          description: 副本数
          example: "3"
        diskType:
          type: string
          description: "磁盘类型, 非阿里云默认值为cloud_essd, 阿里云默认值为cloud_essd_pl1, 在代码中会设置默认\
            值"
          example: cloud_essd
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
        saleChannel:
          type: string
          description: 下单渠道
          example: domestic
        instanceType:
          type: string
          description: "实例类型,CLUSTER/KV_CLUSTER/ANALYTICAL_CLUSTER"
          example: DEDICATED
        storageArchitecture:
          type: string
          description: "存储架构,shareStorage/standardStorage 共享存储/标准存储"
          example: standardStorage
        storageDiskType:
          type: string
          description: 存储类型; 目前仅tp模式支持选择存储类型且仅支持OBPL1
          example: OBPL1
      required:
        - cloudProvider
        - region
        - obVersion
        - zones
        - instanceClass
      description: MultiCloud创建集群实例请求参数
    MultiCloudCreateReadOnlyInstanceRequest:
      type: object
      description: MultiCloud创建ReadOnly集群实例请求参数
      properties:
        readOnlyReplicaType:
          type: string
          description: 只读副本类型 ROW_STORE：只读行存副 COLUMN_STORE：只读列存副本
          example: FULL
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        instanceClass:
          type: string
          description: 只读副本规格
          example: 4C16G
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        nodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      required:
        - zone
        - instanceClass
    MultiCloudDeleteReadOnlyInstanceRequest:
      type: object
      description: MultiCloud删除ReadOnly集群实例请求参数
      properties:
        readonlyInstanceId:
          type: string
          description: 只读实例id
          example: obcluster-*****-ro
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
    MultiCloudModifyInstanceNodeNumRequest:
      type: object
      description: MultiCloud修改集群实例节点Num请求参数
      properties:
        nodeNum:
          type: integer
          format: int32
          description: 目标节点个数，取值范围为3～60，为3的倍数。
          example: 3
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      required:
        - nodeNum
    MultiCloudModifyInstanceSpecRequest:
      type: object
      properties:
        instanceClass:
          type: string
          description: 集群规格
          example: 4C16G
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      description: MultiCloud修改集群实例规格请求参数
    MultiCloudModifyReadOnlyInstanceDiskSizeRequest:
      type: object
      description: MultiCloud修改ReadOnly集群实例磁盘Size请求参数
      properties:
        readonlyInstanceId:
          type: string
          description: 只读实例id
          example: obcluster-*****-ro
        targetDiskSize:
          type: integer
          format: int32
          description: 目标磁盘大小
          example: 200
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      required:
        - targetDiskSize
    MultiCloudModifyReadOnlyInstanceNodeNumRequest:
      type: object
      description: MultiCloud修改ReadOnly集群实例节点Num请求参数
      properties:
        readonlyInstanceId:
          type: string
          description: 只读实例id
          example: obcluster-*****-ro
        targetNodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
      required:
        - targetNodeNum
    MultiCloudModifyReadOnlyInstanceSpecRequest:
      type: object
      description: MultiCloud修改ReadOnly集群实例规格请求参数
      properties:
        readonlyInstanceId:
          type: string
          description: 只读实例id
          example: obcluster-*****-ro
        targetInstanceClass:
          type: string
          description: 目标实例规格
          example: 8C32G
        dryRun:
          type: boolean
          description: 是否预检查
          example: false
    NetworkAccessType:
      type: string
      description: 网络访问类型
      enum:
        - INNER
        - PRIVATE_LINK
        - PUBLIC_NETWORK
        - ALIYUN_LOCALIZATION_OCEANBASE
    OBCloudPagingData:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            description: 数据集
            allOf:
              - $ref: "#/components/schemas/T"
          example:
            - id: resource-123456
        total:
          type: integer
          format: int64
          description: 数据总量
          example: 42
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudResultObcloudInstanceDo:
      type: object
      description: http api 响应结构体
      properties:
        success:
          type: boolean
          description: 是否成功
          example: true
        errorCode:
          type: string
          description: 错误码
          example: INVALID_PARAMETER
        errorMessage:
          type: string
          description: 错误信息
          example: Invalid parameter
        data:
          allOf:
            - $ref: "#/components/schemas/ObcloudInstanceDo"
          description: 业务数据(object)
        cost:
          type: number
          format: int64
          description: 耗时
          example: 1.0
        server:
          type: string
          description: 服务器地址，通常为 OBServer 节点 IP
          example: 10.0.0.10
        requestId:
          type: string
          description: 请求id
          example: dc302d76-66b5-48d8-ab53-a035********
        totalCount:
          type: number
          format: int64
          description: 总记录数。
          example: 100.0
        extra:
          type: object
          description: 附加信息(object)
          example: {}
    ObParameterValueOpenAPI:
      type: object
      description: Ob参数ValueOpenAPI
      properties:
        name:
          type: string
          description: 名称。
          example: 数据源名称
        value:
          type: string
          description: 参数值。
          example: prod
    ObStorageVolumeUnit:
      type: object
      description: 存储卷单位
    ObcloudInstanceDo:
      type: object
      description: 集群实例
      properties:
        gmtCreate:
          type: string
          format: date-time
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          format: date-time
          description: 修改时间
          example: 2026-02-26T10:40:43Z
        endTime:
          type: string
          format: date-time
          description: 到期时间
          example: 2026-02-26T10:40:43Z
        stopTime:
          type: string
          format: date-time
          description: 停止时间。
          example: 2026-02-26T10:40:43Z
        releaseTime:
          type: string
          format: date-time
          description: 释放时间
          example: 2026-02-25T15:40:43Z
        instanceId:
          type: string
          description: 实例ID
          example: obcluster-*****
        instanceArn:
          type: string
          description: 实例ARN
          example: acs:oceanbase:cn-hangzhou:200006001999:instance/obcluster-*****
        instanceType:
          type: string
          description: "实例类型, 如cluster/otenant/mtenant/backup"
          example: DEDICATED
        instanceName:
          type: string
          description: 实例名称
          example: test-cluster
        uid:
          type: string
          description: 购买者账号uid
          example: "200006001999"
        bid:
          type: string
          description: 站点ID
          example: resource-123456
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        chargeType:
          type: string
          description: 计费类型，prepay/postpay
          example: POSTPAID
        commodityCode:
          type: string
          description: 商品码
          example: oceanbase_prepaid_public_cn
        commoditySpec:
          type: string
          description: 商品规格
          example: 4C16G
        marketType:
          type: string
          description: "市场类型，如aliyun,xushang"
          example: NORMAL
        commodityComponent:
          type: string
          description: 实例商品属性
          example: "cpu:4C,memory:16G"
        region:
          type: string
          description: 地域。
          example: ap-guangzhou
        env:
          type: string
          description: 环境标识。
          example: prod
        commodityComponentMap:
          type: object
          additionalProperties:
            type: string
          description: 商品组件映射。
          example:
            id: resource-123456
        subCustomer:
          type: string
          description: 子客户信息
          example: customer-123456
        subscribeStatus:
          type: string
          description: mp 订阅状态： SUBSCRIBE：订阅。非MP渠道，默认为订阅状态 UNSUBSCRIBE：取消订阅
          example: ONLINE
        stopStatus:
          type: string
          description: 集群实例停机状态： online：未停机 stopped：停机
          example: ONLINE
        clientSideOverride:
          type: string
          description: 客户侧数据覆写
          example: "{}"
        flowType:
          type: string
          description: 流程类型。
          example: NORMAL
        resourceAccount:
          type: string
          description: 资源账号
          example: "3"
    ObcloudProxyResource:
      type: object
      description: ObcloudProxy资源
      properties:
        dimension:
          type: string
          description: 递归深度限制
          example: TENANT
        capacity:
          type: number
          format: double
          description: 递归深度限制
          example: 200.0
        assigned:
          type: number
          format: double
          description: 递归深度限制
          example: 1.0
    ObcloudRagClusterDto:
      type: object
      description: RAG集群数据传输对象
      properties:
        gmtCreate:
          type: string
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          description: 修改时间
          example: 2026-02-26T10:40:43Z
        ragClusterId:
          type: string
          description: RAG集群ID
          example: obcluster-*****
        ragClusterArn:
          type: string
          description: RAG集群ARN
          example: acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        version:
          type: string
          description: |-
            "2.2.52" <br/>
            OB 版本
          example: 2.2.52
        cloudProvider:
          type: string
          description: 资源或数据源所在云厂商
          example: "[ALIYUN]"
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        resourceAccount:
          type: string
          description: 资源账号
          example: "3"
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
    Object:
      type: object
      description: Object
    OcpDbUserDoV2OpenApi:
      type: object
      description: OcpDb用户数据对象VOpenApi
      properties:
        userName:
          type: string
          description: 用户名称
          example: root
        userType:
          type: string
          description: 用户类型。
          example: NORMAL
        userStatus:
          type: string
          description: 用户状态。
          example: ONLINE
        description:
          type: string
          description: Description
          example: 用于业务交易的租户
        databases:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/OcpUserPrivilegeV2OpenApi"
            description: 数据库列表。
          description: 数据库列表。
        password:
          type: string
          description: 用户密码。
          example: your-password
        globalPermissions:
          type: string
          description: 全局权限列表。
          example: READONLY
    OcpTenantZoneDoExtV2:
      type: object
      description: Ocp租户可用区数据对象ExtV
      properties:
        zoneReplicaType:
          type: string
          description: 租户在该可用区的副本类型，例如 FULL、READONLY 或 COLUMNSTORE。
          example: FULL
        zoneNodes:
          type: integer
          format: int32
          description: 该副本覆盖的节点数量。
          example: 1
        logicZoneName:
          type: string
          description: 租户副本所在的逻辑可用区名称。
          example: cn-hangzhou-i
        copyId:
          type: integer
          format: int32
          description: 副本在租户拓扑中的排序编号，用于区分同一租户下的不同副本。
          example: 1
        fullCopyId:
          type: integer
          format: int32
          description: 全功能副本展示编号，对应页面中的全功能副本 1、全功能副本 2。
          example: 1
        readOnlyCopyId:
          type: integer
          format: int32
          description: 只读副本展示编号，对应页面中的只读副本 1、只读副本 2。
          example: 1
        tenantZoneRole:
          type: string
          description: 租户副本承担的角色，例如读写副本、备副本或只读副本。
          example: cn-hangzhou-i
        readOnlyReplicaType:
          description: 只读副本类型，可选值包括 ROW_STORE 和 COLUMN_STORE；非只读副本为 NOT_READONLY_REPLICA。
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
        unitInfoList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/UnitInfoV2"
            description: 该副本关联的 Unit 资源明细。
          description: 该副本关联的 Unit 资源明细。
          example:
            - id: resource-123456
    OcpUserPrivilegeV2OpenApi:
      type: object
      description: Ocp用户PrivilegeVOpenApi
      properties:
        userName:
          type: string
          description: 用户名称
          example: root
        database:
          type: string
          description: 数据库名称。
          example: test_db
        table:
          type: string
          description: 表名。
          example: orders
        userType:
          type: string
          description: 用户类型。
          example: NORMAL
        role:
          type: string
          description: "连接类型, 读写/仅读. READWRITE/READONLY 有时候主地址也需要区分读写类型，备库的主地址是只读的"
          example: READWRITE
        privileges:
          type: string
          description: 权限列表。
          example: "SELECT,INSERT"
        isSuccess:
          type: boolean
          description: 操作是否成功。
          example: true
        withGrant:
          type: integer
          format: int64
          description: 是否允许授权给其他用户。
          example: 0
        privilegeType:
          allOf:
            - $ref: "#/components/schemas/DataBasePrivilegeTypeEnum"
          description: 数据库权限类型
    OmsApiReturnResultModifyRecordId:
      type: object
      description: 接口统一返回值，data 为创建的修改记录ID（long）
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          type: integer
          format: int64
          description: 创建的修改记录ID
          example: 1
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    OmsApiReturnResultModifyRecordList:
      type: object
      description: 接口统一返回值，data 为修改记录列表
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          type: array
          description: 修改记录列表
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeModifyRecordResponse"
            description: 修改记录列表
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    OmsApiReturnResultProjectDetail:
      type: object
      description: 接口统一返回值，data 为项目详情
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          allOf:
            - $ref: "#/components/schemas/ProjectDetailResponse"
          description: 业务数据(object)
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    OmsApiReturnResultProjectStepList:
      type: object
      description: 接口统一返回值，data 为项目步骤列表
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          type: array
          description: 项目步骤列表
          items:
            allOf:
              - $ref: "#/components/schemas/ProjectStepVO"
            description: 项目步骤列表
          example:
            - id: resource-123456
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    OmsApiReturnResultString:
      type: object
      description: 接口统一返回值，data 为创建成功的项目ID
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          type: string
          description: 创建成功的项目ID
          example: "{id=resource-123456}"
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    OmsApiReturnResultVoid:
      type: object
      description: 接口统一返回值，无业务 data（如启动、暂停等）
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 描述
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: dc302d76-66b5-48d8-ab53-a035********
        cost:
          type: string
          description: 耗时
          example: 12ms
        data:
          type: object
          description: 无数据时为 null
          nullable: true
          example:
            id: resource-123456
        errorDetail:
          type: object
          description: 错误详情
          example: {}
    OperateBinlogCommodityInstanceRequestForOpenApi:
      type: object
      description: OperateBinlog商品集群实例请求参数ForOpenApi
      properties:
        token:
          type: string
          description: 操作令牌。
          example: token-xxxxxxxx
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        command:
          type: string
          description: 会话正在执行的命令。
          example: START
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: 因为OCP对instanceId字段（集群id）有额外处理，所以这里对instanceId字段（商业化实例id）做额外转换
          example: obcluster-*****
    OperateBinlogCommodityInstanceResponseForOpenApi:
      type: object
      description: OperateBinlog商品集群实例响应结果ForOpenApi
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    Operation:
      type: object
      description: Operation
      properties:
        permitted:
          type: boolean
          description: Permitted
          example: true
        reason:
          allOf:
            - $ref: "#/components/schemas/OperationReasonEnum"
          description: 操作不可执行时的原因码
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    OperationEventStatusEnum:
      type: string
      description: 操作事件状态枚举
    OperationEventTypeEnum:
      type: string
      description: 操作事件类型枚举
    OperationReasonEnum:
      type: string
      description: OperationReasonEnum
    OperationResourceTypeEnum:
      type: string
      description: 操作资源类型枚举
    OrderVerifyRequestForOpenApi:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        chargeType:
          type: string
          description: 计费类型，例如按量付费或包年包月。
          example: POSTPAID
        orderType:
          type: string
          description: 订单类型。
          example: CREATE
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/InstanceCommodityComponent"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        orderParams:
          type: object
          additionalProperties:
            type: string
          description: 订单参数
          example:
            cpu: "4"
            diskSize: "200"
            memory: "16"
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
        multiCloudComponentMap:
          type: object
          description: 内部使用参数
          additionalProperties:
            type: array
            items:
              $ref: "#/components/schemas/InstanceCommodityComponent"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: 订单Verify请求参数ForOpenApi
    PaginatedResponseDataSource:
      type: object
      description: 分页响应（对应 PaginatedResponse&lt;DataSource&gt;）
      properties:
        success:
          type: boolean
          description: 是否成功
          example: true
        httpStatus:
          type: integer
          description: HTTP 状态码
          example: 200
        data:
          type: array
          description: 数据源列表
          items:
            allOf:
              - $ref: "#/components/schemas/DataSource"
            description: 数据源列表
        totalElements:
          type: integer
          format: int64
          description: 总条数
          example: 3
        totalPages:
          type: integer
          description: 总页数
          example: 3
        size:
          type: integer
          description: 分页大小。
          example: 200
        number:
          type: integer
          description: 当前页码（0-based）
          example: 3
    PasswordValidateRule:
      type: object
      description: PasswordValidateRule
    PayOrderCallBackRequestForOpenApi:
      type: object
      properties:
        token:
          type: string
          description: 操作令牌。
          example: token-xxxxxxxx
        instanceName:
          type: string
          description: 集群名称
          example: test-cluster
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        chargeType:
          type: string
          description: 计费类型，例如按量付费或包年包月。
          example: POSTPAID
        orderType:
          type: string
          description: 订单类型。
          example: CREATE
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/InstanceCommodityComponent"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        orderParams:
          type: object
          additionalProperties:
            type: string
          description: 订单参数
          example:
            cpu: "4"
            diskSize: "200"
            memory: "16"
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
        multiCloudComponentMap:
          type: object
          description: 内部使用参数
          additionalProperties:
            type: array
            items:
              $ref: "#/components/schemas/InstanceCommodityComponent"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Pay订单CallBack请求参数ForOpenApi
    PreCheckBinlogCommodityInstanceRequestForOpenApi:
      type: object
      description: PreCheckBinlog商品集群实例请求参数ForOpenApi
      properties:
        chargeType:
          type: string
          description: 计费类型，例如按量付费或包年包月。
          example: POSTPAID
        orderType:
          type: string
          description: 订单类型。
          example: CREATE
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BinlogComponent"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        currentComponents:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BinlogComponent"
            description: 当前商品组件配置。
          description: 当前商品组件配置。
          example:
            - id: resource-123456
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: 因为OCP对instanceId字段（集群id）有额外处理，所以这里对instanceId字段（商业化实例id）做额外转换
          example: obcluster-*****
    PreCheckBinlogCommodityInstanceResponseForOpenApi:
      type: object
      description: PreCheckBinlog商品集群实例响应结果ForOpenApi
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    PreCheckCreateDataBackupTaskResponseV2OpenAPI:
      type: object
      description: PreCheck创建数据备份任务响应结果VOpenAPI
      properties:
        logBackupCheck:
          type: boolean
          description: 是否通过日志备份检查。
          example: true
        mergeCheck:
          type: boolean
          description: 是否通过合并检查。
          example: true
        noNeedMerge:
          type: boolean
          description: 是否无需合并。
          example: true
        runningBackupCheck:
          type: boolean
          description: 是否通过运行中备份任务检查。
          example: true
        sameDataVersionBackupSetCheck:
          type: boolean
          description: 是否存在相同数据版本的备份集。
          example: true
        hasTenantCheck:
          type: boolean
          description: 是否通过租户检查。
          example: true
    ProcessMessageRequestForOpenApi:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        token:
          type: string
          description: 操作令牌。
          example: token-xxxxxxxx
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        command:
          type: string
          description: 会话正在执行的命令。
          example: START
        commandEffectPart:
          type: string
          description: 命令生效范围。
          example: BINLOG
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
      description: ProcessMessage请求参数ForOpenApi
    ProduceBinlogCommodityInstanceRequestForOpenApi:
      type: object
      description: ProduceBinlog商品集群实例请求参数ForOpenApi
      properties:
        token:
          type: string
          description: 操作令牌。
          example: token-xxxxxxxx
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        chargeType:
          type: string
          description: 计费类型，例如按量付费或包年包月。
          example: POSTPAID
        orderType:
          type: string
          description: 订单类型。
          example: CREATE
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
        components:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BinlogComponent"
            description: 商品或服务包含的组件列表。
          description: 商品或服务包含的组件列表。
          example:
            - componentCode: cpu
              componentValue: 4C
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: 因为OCP对instanceId字段（集群id）有额外处理，所以这里对instanceId字段（商业化实例id）做额外转换
          example: obcluster-*****
    ProduceBinlogCommodityInstanceResponseForOpenApi:
      type: object
      description: ProduceBinlog商品集群实例响应结果ForOpenApi
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    ProjectDetailResponse:
      type: object
      description: 项目详情，对应 ProjectDetailResponse
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        type:
          type: string
          description: 类型 MIGRATION/SYNC
          example: NORMAL
        name:
          type: string
          description: 项目名称
          example: 数据源名称
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        owner:
          type: string
          description: 项目 owner
          example: "200006001999"
        labels:
          type: array
          description: 标签列表
          items:
            type: object
            description: 标签列表
        gmtCreate:
          type: string
          description: 创建时间 UTC
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          description: 更新时间 UTC
          example: 2026-02-26T10:40:43Z
        sourceDatasourceId:
          type: string
          description: 源端数据源ID
          example: resource-123456
        sinkDatasourceId:
          type: string
          description: 目标端数据源ID
          example: resource-123456
        isMerging:
          type: boolean
          description: 是否处于合并中
          example: true
        isModifying:
          type: boolean
          description: 是否处于修改中
          example: true
        extraInfo:
          type: object
          description: 补充信息
          example:
            id: resource-123456
    ProjectStepVO:
      type: object
      description: 项目步骤，对应 ProjectStepVO
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        name:
          type: string
          description: 步骤名
          example: 数据源名称
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        progress:
          type: integer
          description: 任务进度。
          example: 1
        startTime:
          type: string
          description: 开始时间 UTC
          example: 2026-02-25T15:40:43Z
        finishTime:
          type: string
          description: 结束时间 UTC
          example: 2026-02-25T15:40:43Z
        extraInfo:
          type: object
          description: 补充信息
          example:
            id: resource-123456
        stepInfo:
          type: object
          description: 步骤详情（全量传输/增量传输/正向切换等）
          example:
            id: resource-123456
    ProxyClusterInfoDTO:
      type: object
      description: 代理集群信息
      properties:
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        proxyMode:
          type: string
          description: ODP 代理模式。
          example: DEDICATED
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        unitSpec:
          type: string
          description: Unit 规格。
          example: 2C4G
        unitNum:
          type: number
          format: float
          description: Unit 数量。
          example: 1.0
        sharedUnitNumLimit:
          type: integer
          format: int32
          description: K8S 共享模式代理服务的单元数量上限
          example: 3
        exclusiveUnitNumLimit:
          type: integer
          format: int32
          description: K8S 独占模式代理服务的单元数量上限
          example: 3
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        proxyServiceVersion:
          type: string
          description: 架构版本
          example: 4.2.1.0
        proxyVersion:
          type: string
          description: 代理版本
          example: 4.2.1.0
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        expireTime:
          type: string
          description: |-
            "2020-12-23T04:14:48Z" <br/>
            到期时间
          example: 2020-12-23T04:14:48Z
        deployMode:
          type: string
          description: 数据副本模式(n/n-n/n-n-n)
          example: 1-1-1
        maxUnitNum:
          type: number
          format: float
          description: Serverless ODP 弹性上限（来自 K8s ODPClusterSpec.maxUnitNum）
          example: 3.0
        slaveZone:
          type: string
          description: 备节点可用区（ODP 商业化新增，仅在双/三可用区主备部署时返回）
          example: cn-hangzhou-i
        nodeDistribution:
          type: string
          description: 节点分布（ODP 商业化新增，替代 deployMode）
          example: "cn-hangzhou-i:1,cn-hangzhou-j:1"
        nodeCpu:
          type: number
          format: float
          description: 节点规格（ODP 商业化新增，替代 unitSpec * unitNum）
          example: 4.0
        nodeNum:
          type: integer
          format: int32
          description: 节点数（ODP 商业化新增）
          example: 3
        deploymentArchitecture:
          type: string
          description: |-
            部署方案（ODP 商业化新增），参考 {@link com.oceanbase.cloud.infra.common.enums.ProxyDeploymentArchitecture} 未商业化的存量 odp 集群会展示为
            SINGLE_AZ_DEPLOYMENT/DUAL_AZ_DEPLOYMENT/MULTI_AZ_DEPLOYMENT
          example: SINGLE_ZONE
        proxyServerIds:
          type: array
          items:
            type: string
            description: ODP 代理节点 ID 列表。
            example: |-
              ---
              - "resource-123456"
          description: ODP 代理节点 ID 列表。
          example:
            - resource-123456
    QueryOrderInfoRequestForOpenApi:
      type: object
      properties:
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        orderId:
          type: string
          description: Order id参数
          example: order_123456789
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        productType:
          type: string
          description: Product type参数
          example: OB_CLUSTER
      description: Query订单信息请求参数ForOpenApi
    ReadOnlyInstanceOperationV2OpenAPI:
      type: object
      description: ReadOnly集群实例OperationVOpenAPI
      properties:
        permitted:
          type: boolean
          description: 是否允许操作
          example: true
        reason:
          description: 操作原因枚举
          example: example-value
          allOf:
            - $ref: "#/components/schemas/ReadOnlyInstanceOperationReasonEnum"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    ReadOnlyReplicaOperation:
      type: object
      description: ReadOnly副本Operation
    ReadOnlyReplicaOperationVisible:
      type: object
      description: ReadOnly副本OperationVisible
    ReadOnlyZoneOperation:
      type: object
      description: ReadOnly可用区Operation
    ReadonlyInstanceDoV2OpenAPI:
      type: object
      properties:
        clusterArn:
          type: string
          description: 集群 ARN。
          example: acs:oceanbase:cn-hangzhou:200006001999:instance/obcluster-*****
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        zoneArn:
          type: string
          description: 可用区 ARN。
          example: cn-hangzhou-i
        nodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        logDiskSize:
          type: integer
          format: int64
          description: 日志磁盘大小
          example: 200
        readOnlyReplicaType:
          type: string
          description: 只读副本类型
          example: FULL
        readonlyInstanceId:
          type: string
          description: 只读实例ID
          example: obcluster-*****-ro
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        mem:
          type: integer
          format: int64
          description: 内存大小。
          example: 16
        diskSize:
          type: integer
          format: int64
          description: 磁盘大小
          example: 200
        instanceClass:
          type: string
          description: 集群规格
          example: 4C16G
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
      description: Readonly集群实例数据对象VOpenAPI
    ReadonlyZoneCpuMemConstraintOpenAPI:
      type: object
      description: 只读副本 CPU 和内存约束（OpenAPI）
      properties:
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        minMem:
          type: integer
          format: int32
          description: 最小内存规格（GB）
          example: 16
        maxMem:
          type: integer
          format: int32
          description: 最大内存规格（GB）
          example: 16
        safeMem:
          type: integer
          format: int32
          description: 安全内存规格（GB，可选）
          example: 16
    ReleaseProjectRequest:
      type: object
      description: 释放项目请求体，对应 CommonIdRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
      required:
        - id
    RemoteArchiveBackupStrategyV2:
      type: object
      properties:
        backupScheduleMode:
          type: string
          description: 备份调度模式，例如按周或按月执行
          example: WEEK
        timeList:
          type: array
          items:
            type: integer
            format: int32
            description: 备份或调度时间列表。
          description: 备份或调度时间列表。
        backupTimesInMonth:
          type: string
          description: 每月备份次数
          example: 2026-02-25T15:40:43Z
        dataMaintainDays:
          type: integer
          format: int32
          description: 数据备份保留天数。
          example: 30
      description: RemoteArchive备份StrategyV
    RemoteBackupStrategyV2:
      type: object
      properties:
        backupScheduleMode:
          type: string
          description: 备份调度模式，例如按周或按月执行
          example: WEEK
        timeList:
          type: array
          items:
            type: string
            description: 备份或调度时间列表。
            example: |-
              ---
              - "2026-02-25T15:40:43Z"
              - "2026-02-25T15:41:43Z"
          description: 备份或调度时间列表。
          example:
            - 2026-02-25T15:40:43Z
            - 2026-02-25T15:41:43Z
        backupTimesInMonth:
          type: string
          description: 每月备份次数
          example: 2026-02-25T15:40:43Z
        dataMaintainDays:
          type: integer
          format: int32
          description: 数据备份保留天数。
          example: 30
      description: Remote备份StrategyV
    RemoveStandbyInstanceRequest:
      type: object
      description: 解耦容灾实例请求体
      properties:
        instanceId:
          type: string
          description: 当前发起操作的实例ID
          example: obcluster-*****
        targetInstanceId:
          type: string
          description: 待解耦的实例ID
          example: obcluster-target
        forced:
          type: boolean
          description: 是否强制切换
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    ResourceDoV2:
      type: object
      description: 资源数据对象V
      properties:
        cpu:
          allOf:
            - $ref: "#/components/schemas/CpuDoV2"
          description: 处理器核数或规格信息。
        memory:
          allOf:
            - $ref: "#/components/schemas/MemoryDoV2"
          description: 资源规格中的内存信息
        diskSize:
          allOf:
            - $ref: "#/components/schemas/DiskDoV2"
          description: 磁盘大小
    ResourceDoV2OpenAPI:
      type: object
      description: 资源数据对象VOpenAPI
      properties:
        cpu:
          allOf:
            - $ref: "#/components/schemas/CpuDoV2OpenAPI"
          description: 处理器核数或规格信息。
        memory:
          allOf:
            - $ref: "#/components/schemas/MemoryDoV2OpenAPI"
          description: 资源规格中的内存信息
        diskSize:
          allOf:
            - $ref: "#/components/schemas/DiskDoV2OpenAPI"
          description: 磁盘大小
    ResourceTagRequestV2OpenApi:
      type: object
      description: 资源Tag请求参数VOpenApi
      properties:
        tagList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 标签列表
          description: 标签列表
          example:
            - tagKey: env
              tagValue: prod
    RestoreObject:
      type: object
      description: 恢复Object
      properties:
        sourceDatabase:
          type: string
          description: 源数据库名称。
          example: test_db
        sourceTable:
          type: string
          description: 源表名称。
          example: orders
        targetDatabase:
          type: string
          description: 目标数据库名称。
          example: test_db_restore
        targetTable:
          type: string
          description: 目标表名称。
          example: orders_restore
    RestoreTenantResource:
      type: object
      description: 恢复租户资源
      properties:
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        memory:
          type: integer
          format: int32
          description: 资源规格中的内存信息
          example: 16
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        logDisk:
          type: integer
          format: int32
          description: 日志盘大小（GB）
          example: 200
    ResumeProjectRequest:
      type: object
      description: 恢复项目请求体，对应 CommonIdRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7alpaosb02w0
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
      required:
        - id
    SecurityConfigInfoOpenAPI:
      type: object
      properties:
        configGroup:
          type: string
          description: 配置项所属分组。
          example: security
        configName:
          type: string
          description: 配置项名称。
          example: test-name
        configDescription:
          type: string
          description: 配置项说明。
          example: successful
        risk:
          type: boolean
          description: 风险级别。
          example: true
        riskDescription:
          type: string
          description: 风险说明。
          example: successful
      description: 安全配置信息OpenAPI
    SelectReplicaParamDTO:
      type: object
      properties:
        value:
          type: string
          description: 参数值。
          example: prod
        weight:
          type: integer
          format: int32
          description: 权重。
          example: 1
        readOnlyReplicaType:
          type: string
          description: 只读副本类型
          example: FULL
      description: Select副本参数DTO
    SimpleTenantResponse:
      type: object
      description: 租户简洁响应结构
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        jobKey:
          type: string
          description: 异步任务键。
          example: env
    SparseBackupStrategyV2:
      type: object
      properties:
        backupMaintainMatchRule:
          allOf:
            - $ref: "#/components/schemas/BackupMaintainMatchRuleV2"
          description: 稀疏备份保留策略匹配规则
        backupMaintainStrategy:
          allOf:
            - $ref: "#/components/schemas/BackupMaintainStrategyV2"
          description: 稀疏备份保留策略配置
      description: Sparse备份StrategyV
    StandardCapacityScaleOperation:
      type: object
      description: Standard容量ScaleOperation
    StartProjectRequest:
      type: object
      description: 启动项目请求体
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        startupMode:
          type: string
          description: 启动模式，IMMEDIATE 立即启动，AFTER_BUY 购买后启动
          example: AFTER_BUY
          enum:
            - IMMEDIATE
            - AFTER_BUY
      required:
        - id
    StopProjectRequest:
      type: object
      description: 暂停项目请求体，对应 CommonIdRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
        startupMode:
          type: string
          description: 启动模式（可选）
          enum:
            - IMMEDIATE
            - AFTER_BUY
          example: AFTER_BUY
      required:
        - id
    SuccessResponseDataSource:
      type: object
      description: 成功响应（对应 SuccessResponse&lt;DataSource&gt;）
      properties:
        success:
          type: boolean
          description: 是否成功
          example: true
        httpStatus:
          type: integer
          description: HTTP 状态码
          example: 200
        data:
          allOf:
            - $ref: "#/components/schemas/DataSource"
          description: 业务数据(object)
    SwitchoverInstanceRequest:
      type: object
      description: 主备切换请求体
      properties:
        instanceId:
          type: string
          description: 当前发起操作的实例ID
          example: obcluster-*****
        targetInstanceId:
          type: string
          description: 目标实例ID，要切换为主集群的实例ID
          example: obcluster-target
        forced:
          type: boolean
          description: 是否强制切换
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    SwitchoverInstanceResponse:
      type: object
      description: 主备切换响应体
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
    TagKey:
      type: object
      description: 标签 Key 对象
      properties:
        id:
          type: integer
          format: int64
          description: 标签 key ID
          example: 217
        tagKey:
          type: string
          description: 标签 key 值
          example: env
        tagValueList:
          type: array
          description: 标签 value 列表
          items:
            allOf:
              - $ref: "#/components/schemas/TagValue"
            description: 标签 value 列表
          example:
            - tagKey: env
              tagValue: prod
    TagKeyValueDo:
      type: object
      properties:
        tagKey:
          type: string
          description: 标签键
          example: env
        tagValue:
          type: string
          description: 标签值
          example: prod
      description: TagKeyValue数据对象
    TagValue:
      type: object
      description: 标签 Value 对象
      properties:
        id:
          type: integer
          format: int64
          description: 标签 value ID（内层 ID）
          example: 244
        tagKey:
          type: string
          description: 标签 key 值
          example: env
        tagValue:
          type: string
          description: 标签 value 值
          example: prod
    TagValueInput:
      type: object
      description: 标签 value 输入对象
      properties:
        tagKey:
          type: string
          description: 标签 key 值
          example: env
        tagValue:
          type: string
          description: 标签 value 值
          example: prod
      required:
        - tagKey
        - tagValue
    TemporaryCapacityScaleOperation:
      type: object
      description: Temporary容量ScaleOperation
    TenantAddressReadStrategyConfigDTO:
      type: object
      properties:
        odpVersion:
          type: string
          description: ODP 版本。
          example: 4.2.1
        trafficStrategy:
          type: string
          description: 流量策略
          example: ZONE_FIRST
        replicaParams:
          type: array
          description: 选择副本
          items:
            allOf:
              - $ref: "#/components/schemas/SelectReplicaParamDTO"
            description: 选择副本
        disasterRecoveryReplicaParams:
          type: array
          description: 容灾副本
          items:
            allOf:
              - $ref: "#/components/schemas/SelectReplicaParamDTO"
            description: 容灾副本
        balancedStrategy:
          type: string
          description: 均衡策略
          example: BALANCED
        disasterRecoveryStrategy:
          type: string
          description: "容灾策略, 副本不可用时自动查主副本"
          example: PRIMARY_FIRST
      description: 租户地址ReadStrategy配置DTO
    TenantConnectionDTO:
      type: object
      description: 租户连接信息
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        userVpcOwnerId:
          type: string
          description: 用户 VPC 所属账号标识。
          example: "200006001999"
        vSwitchId:
          type: string
          description: 交换机标识。
          example: vsw-xxxxx
        connectionZones:
          type: array
          description: 连接的zone
          items:
            type: string
            description: 连接的zone
            example: |-
              ---
              - "cn-hangzhou-i"
          example:
            - cn-hangzhou-i
        connectionLogicalZones:
          type: array
          items:
            type: string
            description: 连接地址关联的逻辑可用区列表。
            example: |-
              ---
              - "cn-hangzhou-i"
          description: 连接地址关联的逻辑可用区列表。
          example:
            - cn-hangzhou-i
        connectionReplicaType:
          type: string
          description: 连接地址访问的副本类型。
          example: FULL
        tenantEndpointId:
          type: string
          description: 多云v5 补充 tenantEndpoint Id
          example: te-xxxxxx
        addressId:
          type: string
          description: 多云里即vip service group name
          example: rs-private-internet-*****
        addressStatus:
          type: string
          description: 连接状态
          example: ONLINE
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        addressType:
          type: string
          description: 地址类型：MASTER，READONLY
          example: MASTER
        networkType:
          type: string
          description: 网络类型
          example: INTRANET
        role:
          type: string
          description: "连接类型, 读写/仅读. READWRITE/READONLY 有时候主地址也需要区分读写类型，备库的主地址是只读的"
          example: READWRITE
        userNameFormat:
          type: string
          description: 使用该地址时用户名格式：一段式、两段式、三段式
          example: TWO_PART
        useSSL:
          type: boolean
          description: 是否打开ssl
          example: false
        proxyClusterInfo:
          allOf:
            - $ref: "#/components/schemas/ProxyClusterInfoDTO"
          description: 租户连接关联的 ODP 代理集群信息
        odpVersion:
          type: string
          description: ODP 版本。
          example: 4.2.1
        readStrategyConfigResponse:
          allOf:
            - $ref: "#/components/schemas/TenantAddressReadStrategyConfigDTO"
          description: 租户连接地址的读流量策略配置
        addressMasterZoneId:
          type: string
          description: 地址主可用区
          example: cn-hangzhou-i
        loadBalanceType:
          type: string
          description: 负载均衡类型，只有阿里云需要设置，区分NLB和CLB
          example: NLB
        internetAddress:
          type: string
          description: 公网地址
          example: 8.8.8.8
        internetPort:
          type: integer
          format: int32
          description: 公网端口
          example: 2881
        internetDomain:
          type: string
          description: 公网地址
          example: pay-core-public.oceanbase.example.com
        internetAddressStatus:
          type: string
          description: 公网地址状态
          example: ONLINE
        internetMaxConnectionNum:
          type: integer
          format: int32
          description: 公网最大连接数
          example: 10000
        internetMaxConnectionNumLimit:
          type: integer
          format: int32
          description: 公网最大连接数 limit 限制
          example: 20000
        internetRpcPort:
          type: integer
          format: int32
          description: 公网 RPC 端口
          example: 2882
        internetProxyClusterId:
          type: string
          description: 公网proxy cluster id
          example: proxy-123456
        internetLoadBalanceType:
          type: string
          description: 公网地址负载均衡类型
          example: NLB
        intranetAddress:
          type: string
          description: 私网地址
          example: 10.0.0.10
        intranetPort:
          type: integer
          format: int32
          description: 内网端口
          example: 2881
        intranetDomain:
          type: string
          description: 内网地址
          example: pay-core-private.oceanbase.example.com
        intranetAddressStatus:
          type: string
          description: 内网地址状态
          example: ONLINE
        maxConnectionNum:
          type: integer
          format: int32
          description: 私网最大连接数
          example: 10000
        maxConnectionNumLimit:
          type: integer
          format: int32
          description: 私网最大连接数修改 Limit 限制
          example: 20000
        intranetRpcPort:
          type: integer
          format: int32
          description: 私网 RPC 端口
          example: 2882
        enableRPc:
          type: boolean
          description: 是否开启 rpc ，旁路导入
          example: true
        disableRpcReason:
          type: string
          description: 禁止开启 rpc 的原因
          example: ODP proxy is not ready
        intranetAddressMasterZoneId:
          type: string
          description: 主zone id
          example: cn-hangzhou-i
        intranetAddressSlaveZoneId:
          type: string
          description: 备zone id
          example: cn-hangzhou-j
        deleteSingleTunnelAddress:
          type: boolean
          description: 是否可以删除阿里云私网主地址
          example: true
        intranetProxyClusterId:
          type: string
          description: 私网的proxy cluster id
          example: proxy-123456
        forceMigratedObproxyIntranetDeleteInternet:
          type: boolean
          description: 迁入的主地址私网在公网存在的情况下，删除私网的同时删除公网
          example: true
        intranetLoadBalanceType:
          type: string
          description: 私网地址负载均衡类型
          example: NLB
        privateLinkList:
          type: array
          description: private link列表信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantPrivateLinkDTO"
            description: private link列表信息
          example:
            - endpointId: ep-xxxxxx
              status: CONNECTED
        intranetPeeringAddress:
          type: string
          description: peering地址
          example: 10.1.0.10
        intranetPeeringPort:
          type: integer
          format: int32
          description: peering地址端口
          example: 2881
        intranetPeeringDomain:
          type: string
          description: peering地址域名
          example: pay-core-peering.oceanbase.example.com
        intranetPeeringAddressStatus:
          type: string
          description: peering地址状态
          example: ONLINE
        intranetPeeringMaxConnectionNum:
          type: integer
          format: int32
          description: peering地址最大连接数
          example: 10000
        peeringDstVpcId:
          type: string
          description: peering地址对端vpc id
          example: vpc-peer-xxxxx
        peeringDstCidrList:
          type: string
          description: peering地址对端cidr
          example: 10.1.0.0/16
        peeringId:
          type: string
          description: 对等连接 ID。
          example: pcx-xxxxxx
        intranetPeeringProxyClusterId:
          type: string
          description: peering私网地址proxy cluster id
          example: proxy-123456
        intranetRagPort:
          type: integer
          format: int32
          description: 私网 Rag 端口
          example: 8080
        internetRagPort:
          type: integer
          format: int32
          description: 公网 Rag 端口
          example: 8080
        internetRagAddress:
          type: string
          description: 公网 Rag 地址
          example: pay-core-rag-public.oceanbase.example.com
        enableRagHttp:
          type: boolean
          description: 是否开启 RAG Http 端口
          example: false
        isVirtualServerGroup:
          type: boolean
          description: 虚拟服务器组/主备服务器组（一方迁入）
          example: false
        isMigrated:
          type: integer
          format: int32
          description: 是否一方迁移的集群地址
          example: 0
        userFormatConnStatus:
          type: string
          description: 一段式连接开启状态
          example: ONLINE
        userFormatConnUnsupportedReason:
          type: string
          description: 不支持开启一段式访问的原因
          example: "2881"
    TenantCpuDTO:
      type: object
      description: 租户CPU数据传输对象
    TenantCreateConstraints:
      type: object
      description: 租户创建约束
      properties:
        tenantModeList:
          type: array
          description: 租户模式可选类型
          items:
            type: string
            description: 租户模式可选类型
        charsetList:
          type: array
          description: 字符集可选类型
          items:
            type: string
            description: 字符集可选类型
        timeZoneList:
          type: array
          description: 时区可选类型
          items:
            allOf:
              - $ref: "#/components/schemas/TenantTimeZoneDto"
            description: 时区可选类型
        defaultTimeZone:
          type: string
          description: 默认时区
          example: 2026-02-25T15:40:43Z
        zoneList:
          type: array
          description: zone列表
          items:
            allOf:
              - $ref: "#/components/schemas/TenantZoneDTO"
            description: zone列表
    TenantDTO:
      type: object
      description: 租户信息
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        ocpTenantId:
          type: integer
          format: int64
          description: OCP 内部租户标识。
          example: 10001
        tenantName:
          type: string
          description: 租户名
          example: pay_core
        managementMode:
          type: string
          description: 管理模式，dbaas or maas
          example: DBAAS
        gmtCreate:
          type: string
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        primaryRegion:
          type: string
          description: 主地域
          example: cn-hangzhou
        primaryZone:
          type: string
          description: 主zone
          example: cn-hangzhou-i
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        mem:
          type: integer
          format: int32
          description: 总内存GB
          example: 16
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        unitCpu:
          type: integer
          format: int32
          description: Unit 处理器规格。
          example: 2
        unitMem:
          type: integer
          format: int32
          description: Unit 内存规格。
          example: 8
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        unitDiskSize:
          type: integer
          format: int32
          description: 单元磁盘大小
          example: 200
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        deployType:
          type: string
          description: 部署类型
          example: multiple
        description:
          type: string
          description: 描述
          example: 用于业务交易的租户
        tenantConnections:
          type: array
          description: 租户连接信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantConnectionDTO"
            description: 租户连接信息
          example:
            - addressStatus: ONLINE
              addressType: MASTER
              intranetAddress: 10.0.0.10
              intranetPort: 2881
              serviceType: PRIVATE
        tenantZones:
          type: array
          description: zone信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantZoneDTO"
            description: zone信息
          example:
            - replicaType: FULL
              status: ONLINE
              zone: cn-hangzhou-i
        tenantResource:
          allOf:
            - $ref: "#/components/schemas/TenantResourceDTO"
          description: 租户资源规格信息
        enableBinlogService:
          type: boolean
          description: 是否允许开通binlog服务
          example: true
        readonlyConnectionAddable:
          type: string
          description: "只读地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        readwriteConnectionAddable:
          type: string
          description: "读写分离地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        timeZone:
          type: string
          description: 租户设置的时区
          example: +08:00
        charset:
          type: string
          description: 租户设置的字符集
          example: utf8mb4
        collation:
          type: string
          description: 租户设置的字符序
          example: utf8mb4_general_ci
        lowerCaseTableNamesParam:
          type: integer
          format: int32
          description: 租户设置的表名大小写敏感
          example: 1
        parameterTemplate:
          type: string
          description: 参数模板
          example: oltp
        tagList:
          type: array
          description: 租户标签
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 租户标签
          example:
            - tagKey: env
              tagValue: prod
        tenantCompatibilityMode:
          type: string
          description: 租户兼容模式： TP集群，返回MySQL/Oracle KV集群，返回HBase/Table
          example: MYSQL
        dataMergeTime:
          type: string
          description: 租户合并时间(4.x集群才有)
          example: 02:00
        enableProxyPublicLink:
          type: boolean
          description: 是否开启公网
          example: false
        enableProxyPeeringLink:
          type: boolean
          description: 是否开启peering地址
          example: false
        odpDefaultVersion:
          type: string
          description: 设置租户创建地址是默认的设置的 odpVersion
          example: 4.2.1
        enableProxyService:
          type: boolean
          description: 是否启用代理服务
          example: true
        globalAddressAddable:
          type: string
          description: "全局地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        enableStandbyReadWriteSplit:
          type: string
          description: 主备库读写分离开关状态
          example: ENABLED
        instanceZoneReplicas:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyReplicaDoV2"
            description: 实例可用区副本列表
          description: 实例可用区副本列表
          example:
            - copyId: 1
              logicZoneName: cn-hangzhou-i
              replicaType: FULL
              zone: cn-hangzhou-i
        zones:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyZoneDoV2"
            description: 可用区列表，逗号分隔
          description: 可用区列表，逗号分隔
        tenantMaxConnections:
          type: integer
          format: int32
          description: 租户最大连接数
          example: 10000
        ragCluster:
          allOf:
            - $ref: "#/components/schemas/ObcloudRagClusterDto"
          description: RAG 集群信息。
        enableRag:
          type: boolean
          description: 是否启用RAG
          example: false
        iops:
          type: integer
          format: int32
          description: 存储每秒读写次数指标。
          example: 1000
        aiFunctionStatus:
          type: string
          description: AI功能状态
          example: ENABLED
        privateLinkExisted:
          type: boolean
          description: 私有链接是否存在
          example: true
        tenantCompatibilityControl:
          type: string
          description: 租户兼容性控制配置。
          example: MYSQL
        unitLogDisk:
          type: integer
          format: int32
          description: Unit 日志盘规格。
          example: 100
        directConnectionAddable:
          type: string
          description: "直连地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        directConnectionAddableReasonType:
          type: string
          description: 直连地址不可创建的原因类型 INSTANCE_LEVEL 实例层级原因 TENANT_LEVEL 租户层级原因 ，null
            可创建时为空
          example: INSTANCE_LEVEL
        instanceType:
          type: string
          description: 实例类型
          example: DEDICATED
        tenantType:
          type: string
          description: 租户类型：TP/KV/AP 旗舰版按租户维度区分类型，非旗舰版按实例类型区分
          example: TP
        odpAddressStatus:
          type: string
          description: |-
            该租户的 ODP 连接就绪状态(仅租户级)。取值: ONLINE / PENDING_CREATE。
            <p>
            语义: 表达「该租户当前是否已经具备至少一个可用主地址」,用于前端渲染主地址/私网连接/对等连接/公网连接卡片是否还在「预置中」, 避免在租户已 online 但首批主地址还在创建中时被用户重复点击创建。
            <p>
            判定规则:
            <ul>
            <li>该租户名下主地址 server group(覆盖私网+公网+阿里云 OBPROXY 五种主地址类型)跳过 DELETED 后集合为空(阿里云 CLB 不创建 ODP / 刚建空租户)→ ONLINE 兜底;</li>
            <li>集合中至少有一个 ONLINE → ONLINE: 后续新增公网/对等地址处于 PENDING_CREATE 不影响汇总; ODP 代理集群事后进入运维态也不影响汇总;</li>
            <li>全部主地址都非 ONLINE(典型场景: 租户刚 online、首批主地址还在创建)→ PENDING_CREATE。</li>
            </ul>
            <p>
            与白名单可下发口径(集群级 {@code ModifyClusterSecurityIpGroup} / 租户级 {@code ModifyTenantSecurityIpGroup})不同: 白名单走 L1+L2 严格判定(全部主地址 server group
            ONLINE + 关联 ODP 代理集群全部 ONLINE,任何运维态都拦截),本字段不考虑代理集群运维态、也不要求全部主地址 ONLINE。
          example: ONLINE
    TenantDiskDTO:
      type: object
      description: 租户磁盘数据传输对象
    TenantEncryptionDtoOpenAPI:
      type: object
      description: 租户加密DtoOpenAPI
    TenantMemoryDTO:
      type: object
      description: 租户内存数据传输对象
    TenantModifyResourceConstraints:
      type: object
      description: 租户修改资源规格约束
      properties:
        maxCpu:
          type: integer
          format: int32
          description: 最大cpu规格
          example: 4
        minCpu:
          type: integer
          format: int32
          description: 最小cpu
          example: 4
        maxMem:
          type: integer
          format: int32
          description: 最大内存规格
          example: 16
        minMem:
          type: integer
          format: int32
          description: 最小内存
          example: 16
    TenantPrivateLinkDTO:
      type: object
      description: 租户PrivateLinkDTO
      properties:
        privateLinkStatus:
          type: string
          description: private link开通状态
          example: ONLINE
        privateLinkServiceId:
          type: string
          description: private link service端ID
          example: resource-123456
        privateLinkEndpointId:
          type: string
          description: private link endpoint端ID
          example: resource-123456
        privateLinkEndpointVpcId:
          type: string
          description: PrivateLink Endpoint 所属 VPC ID。
          example: vpc-xxxxx
        privateLinkEndpointSubnetId:
          type: string
          description: private link endpoint端 子网 ID
          example: resource-123456
        privateLinkServiceAccount:
          type: string
          description: private link service主账号
          example: "3"
        privateLinkUserAccount:
          type: string
          description: private link 白名单用户账号
          example: "3"
        privateLinkDomain:
          type: string
          description: 私有域名
          example: pay-core.oceanbase.example.com
        intranetAddress:
          type: string
          description: 私网地址
          example: 10.0.0.10
        intranetDomain:
          type: string
          description: 内网地址
          example: pay-core-private.oceanbase.example.com
        deletePrivateLink:
          type: boolean
          description: 是否可以删除私网主地址（关联了全局地址不能删）
          example: true
    TenantResourceDTO:
      type: object
      description: 租户资源
      properties:
        cpu:
          allOf:
            - $ref: "#/components/schemas/TenantCpuDTO"
          description: 处理器核数或规格信息。
        memory:
          allOf:
            - $ref: "#/components/schemas/TenantMemoryDTO"
          description: 资源规格中的内存信息
        disk:
          allOf:
            - $ref: "#/components/schemas/TenantDiskDTO"
          description: 资源规格中的数据盘信息
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
    TenantRoZoneInfoDoV2OpenAPI:
      type: object
      description: 租户Ro可用区信息数据对象VOpenAPI
      properties:
        availableZoneId:
          type: string
          description: 可用于创建只读副本的可用区 ID。
          example: resource-123456
        serverCount:
          type: integer
          format: int32
          description: Server 数量。
          example: 3
        realZoneId:
          type: string
          description: 可用区对应的物理可用区 ID。
          example: resource-123456
        zoneReplicaType:
          type: string
          description: 可用区当前承载的副本类型。
          example: FULL
        zoneCopyId:
          type: integer
          format: int32
          description: 可用区副本编号，用于区分可选副本位置。
          example: 1
        cpu:
          type: number
          format: double
          description: 处理器核数或规格信息。
          example: 4.0
        memory:
          type: number
          format: double
          description: 资源规格中的内存信息
          example: 16.0
        unitCpu:
          type: integer
          format: int32
          description: Unit 处理器规格。
          example: 2
        unitMem:
          type: integer
          format: int32
          description: Unit 内存规格。
          example: 8
        unitNum:
          type: integer
          format: int32
          description: 租户unitNum
          example: 1
        cpuUsed:
          type: number
          format: double
          description: 已使用 CPU 核数。
          example: 4.0
        memoryUsed:
          type: number
          format: double
          description: 已使用内存大小（GB）
          example: 16.0
        enableCreate:
          type: boolean
          description: 是否允许创建。
          example: true
        roCreated:
          type: boolean
          description: 是否已创建只读副本。
          example: true
        permission:
          allOf:
            - $ref: "#/components/schemas/ReadOnlyInstanceOperationV2OpenAPI"
          description: 只读副本创建或变更操作的准入结果。
        replicaAliasName:
          type: string
          description: 副本展示别名。
          example: pay_core
        readOnlyReplicaType:
          description: 只读副本类型，可选值包括 ROW_STORE 和 COLUMN_STORE。
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
    TenantSecurityConfigOpenAPI:
      type: object
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        riskCount:
          type: integer
          format: int32
          description: 风险项数量。
          example: 3
        securityConfigs:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SecurityConfigInfoOpenAPI"
            description: 安全配置列表。
          description: 安全配置列表。
          example:
            - id: resource-123456
      description: 租户安全配置OpenAPI
    TenantTimeZoneDto:
      type: object
      description: 租户Time可用区Dto
      properties:
        timeZone:
          type: string
          description: 时区
          example: +08:00
        description:
          type: string
          description: 时区描述
          example: 用于业务交易的租户
    TenantZoneDTO:
      type: object
      description: ocp tenant zone 信息
      properties:
        name:
          type: string
          description: "zone名称, zoneId"
          example: 数据源名称
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        region:
          type: string
          description: 地域。
          example: ap-guangzhou
        role:
          type: string
          description: "承担角色, 读写/只读"
          example: READWRITE
        tenantZoneReplicas:
          type: array
          description: zone副本信息
          items:
            allOf:
              - $ref: "#/components/schemas/OcpTenantZoneDoExtV2"
            description: zone副本信息
    TimeInterval:
      type: object
      description: 时间间隔
    TopologyDoV2OpenAPI:
      type: object
      description: Topology数据对象VOpenAPI
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenants:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyTenantDoV2OpenAPI"
            description: 租户列表。
          description: 租户列表。
          example:
            - tenantName: pay_core
              tenantId: t4louaeei****
        zones:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyZoneDoV2OpenAPI"
            description: 可用区列表，逗号分隔
          description: 可用区列表，逗号分隔
        replicaList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyReplicaDoV2OpenAPI"
            description: 副本列表。
          description: 副本列表。
          example:
            - id: resource-123456
    TopologyNodeDoV2:
      type: object
      properties:
        nodeId:
          type: string
          description: 节点标识。
          example: node-1
        serverIp:
          type: string
          description: Server ip参数
          example: 10.0.0.10
        nodeCopyId:
          type: integer
          format: int32
          description: 节点副本在拓扑中的排序编号。
          example: 1
        nodeStatus:
          type: string
          description: 节点当前运行状态。
          example: ONLINE
        replicaType:
          type: string
          description: 节点承载的副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        fullCopyId:
          type: integer
          format: int32
          description: 全功能副本展示编号。
          example: 1
        readOnlyCopyId:
          type: integer
          format: int32
          description: 只读副本展示编号。
          example: 1
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        readOnlyReplicaType:
          description: 只读副本类型
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
        nodeResource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2"
          description: 节点资源规格信息
      description: Topology Node  数据对象  V2
    TopologyNodeDoV2OpenAPI:
      type: object
      description: Topology节点数据对象VOpenAPI
      properties:
        nodeId:
          type: string
          description: 节点标识。
          example: node-1
        serverIp:
          type: string
          description: Server ip参数
          example: 10.0.0.10
        nodeCopyId:
          type: integer
          format: int32
          description: 节点副本在拓扑中的排序编号。
          example: 1
        nodeStatus:
          type: string
          description: 节点当前运行状态。
          example: ONLINE
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        nodeResource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2OpenAPI"
          description: 节点资源规格信息
    TopologyReplicaDoV2:
      type: object
      description: 拓扑副本数据对象V2
      properties:
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        zoneRegionName:
          type: string
          description: 副本所在地域名称。
          example: test-name
        zoneLogicalId:
          type: integer
          format: int32
          description: 副本所在逻辑可用区 ID。
          example: 1
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        nodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        readonlyInstanceId:
          type: string
          description: 只读实例ID
          example: obcluster-*****-ro
        replicaResource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2"
          description: 副本资源规格信息
        readOnlyReplicaType:
          description: 只读副本类型
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
    TopologyReplicaDoV2OpenAPI:
      type: object
      description: Topology副本数据对象VOpenAPI
      properties:
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        zoneRegionName:
          type: string
          description: 可用区所属地域名称。
          example: test-name
        zoneLogicalId:
          type: integer
          format: int32
          description: 逻辑可用区 ID。
          example: 1
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        nodeNum:
          type: integer
          format: int32
          description: 节点数量
          example: 3
        readonlyInstanceId:
          type: string
          description: 只读实例ID
          example: obcluster-*****-ro
        replicaResource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2OpenAPI"
          description: 副本资源规格信息
        readOnlyReplicaType:
          description: 只读副本类型
          example: FULL
          allOf:
            - $ref: "#/components/schemas/ReadOnlyReplicaType"
    TopologyTenantDoV2OpenAPI:
      type: object
      description: Topology租户数据对象VOpenAPI
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        tenantStatus:
          type: string
          description: 租户状态。
          example: ONLINE
        tenantDeployType:
          type: string
          description: 租户部署类型。
          example: MYSQL
        tenantCpu:
          type: number
          format: double
          description: 租户 CPU 规格。
          example: 4.0
        tenantMemory:
          type: number
          format: double
          description: 租户内存规格。
          example: 16.0
        tenantUnitNum:
          type: integer
          format: int32
          description: 租户 Unit 数量。
          example: 3
        tenantZones:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyTenantZoneDoV2OpenAPI"
            description: zone信息
          description: zone信息
          example:
            - replicaType: FULL
              status: ONLINE
              zone: cn-hangzhou-i
        tenantCompatibilityMode:
          type: string
          description: KV 集群为 HBASE/Table 其他场景为TenantMode
          example: MySQL
        parameterTemplate:
          type: string
          description: 创建时传入的参数模板
          example: oltp
    TopologyTenantZoneDoV2OpenAPI:
      type: object
      description: Topology租户可用区数据对象VOpenAPI
      properties:
        tenantZoneId:
          type: string
          description: 租户可用区标识。
          example: t4louaeei****
        tenantZoneRole:
          type: string
          description: 租户副本承担的角色。
          example: cn-hangzhou-i
        isPrimaryTenantZone:
          type: boolean
          description: 是否为租户 Primary Zone。
          example: true
        unitInfoList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/UnitInfoV2OpenAPI"
            description: Unit info list
          description: Unit info list
          example:
            - id: resource-123456
    TopologyZoneDoV2:
      type: object
      properties:
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        zoneDisk:
          type: string
          description: 该可用区的数据盘容量展示值。
          example: "200"
        logicZoneId:
          type: string
          description: 逻辑可用区 ID。
          example: resource-123456
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        nodes:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyNodeDoV2"
            description: 该逻辑可用区下的节点列表。
          description: 该逻辑可用区下的节点列表。
          example:
            - id: resource-123456
      description: Topology Zone  数据对象  V2
    TopologyZoneDoV2OpenAPI:
      type: object
      description: Topology可用区数据对象VOpenAPI
      properties:
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        region:
          type: string
          description: 部分对象存储厂商，需要填写；比如S3
          example: ap-guangzhou
        zoneDisk:
          type: string
          description: 可用区数据盘容量展示值。
          example: "200"
        logicZoneId:
          type: string
          description: 逻辑可用区 ID。
          example: resource-123456
        nodes:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyNodeDoV2OpenAPI"
            description: 节点列表。
          description: 节点列表。
          example:
            - id: resource-123456
    UnitCpuMemConstraint:
      type: object
      description: cpu和mem在unit下的创建约束
      properties:
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        maxMem:
          type: integer
          format: int32
          description: 最大mem规格
          example: 16
        minMem:
          type: integer
          format: int32
          description: 最小mem规格
          example: 16
        safeMem:
          type: integer
          format: int32
          description: 安全mem规格
          example: 16
    UnitInfoV2:
      type: object
      properties:
        unitId:
          type: string
          description: Unit id参数
          example: resource-123456
        serverIp:
          type: string
          description: Server ip参数
          example: 10.0.0.10
        serverPort:
          type: integer
          format: int32
          description: Server 端口。
          example: 2881
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        sn:
          type: string
          description: Sn
          example: example-value
        isPrimary:
          type: boolean
          description: 是否为 Primary Zone 或主副本。
          example: true
        cpu:
          type: number
          format: double
          description: 处理器核数或规格信息。
          example: 4.0
        memory:
          type: number
          format: double
          description: 资源规格中的内存信息
          example: 16.0
        dataSize:
          type: number
          format: double
          description: Data size
          example: 200.0
        logDiskSize:
          type: number
          format: double
          description: 日志磁盘大小
          example: 200.0
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        tenantObId:
          type: integer
          format: int64
          description: OceanBase 租户 ID。
          example: 1
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        resourcePoolId:
          type: integer
          format: int64
          description: 资源池标识。
          example: 1
        migrateFromServerIp:
          type: string
          description: Unit 迁移源 Server 的 IP 地址。
          example: 10.0.0.11
        migrateFromServerPort:
          type: integer
          format: int32
          description: Unit 迁移源 Server 的端口。
          example: 2881
        migrateFromServerSn:
          type: string
          description: Unit 迁移源 Server 的序列号。
          example: server-sn-001
        manualMigrate:
          type: integer
          format: int32
          description: 是否为手动 Unit 迁移。
          example: 0
        enableMigrateUnit:
          type: boolean
          description: 是否允许发起 Unit 迁移。
          example: true
        enableCancelMigrateUnit:
          type: boolean
          description: 是否允许取消 Unit 迁移。
          example: true
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
      description: 资源单元信息V
    UnitInfoV2OpenAPI:
      type: object
      description: 资源单元信息VOpenAPI
      properties:
        unitId:
          type: string
          description: Unit id参数
          example: resource-123456
        serverIp:
          type: string
          description: Server ip参数
          example: 10.0.0.10
        serverPort:
          type: integer
          format: int32
          description: Server 端口。
          example: 2881
        replicaType:
          type: string
          description: 副本类型，例如 FULL、READONLY 或 LOGONLY。
          example: FULL
        sn:
          type: string
          description: Sn
          example: example-value
        isPrimary:
          type: boolean
          description: 是否为 Primary Zone 或主副本。
          example: true
        cpu:
          type: number
          format: double
          description: 处理器核数或规格信息。
          example: 4.0
        memory:
          type: number
          format: double
          description: 资源规格中的内存信息
          example: 16.0
        dataSize:
          type: number
          format: double
          description: Data size
          example: 200.0
        logDiskSize:
          type: number
          format: double
          description: 日志磁盘大小
          example: 200.0
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        tenantObId:
          type: integer
          format: int64
          description: OceanBase 租户 ID。
          example: 1
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        resourcePoolId:
          type: integer
          format: int64
          description: 资源池标识。
          example: 1
        migrateFromServerIp:
          type: string
          description: Unit 迁移源 Server 的 IP 地址。
          example: 10.0.0.11
        migrateFromServerPort:
          type: integer
          format: int32
          description: Unit 迁移源 Server 的端口。
          example: 2881
        migrateFromServerSn:
          type: string
          description: Unit 迁移源 Server 的序列号。
          example: server-sn-001
        manualMigrate:
          type: integer
          format: int32
          description: 是否为手动 Unit 迁移。
          example: 0
        enableMigrateUnit:
          type: boolean
          description: 是否允许发起 Unit 迁移。
          example: true
        enableCancelMigrateUnit:
          type: boolean
          description: 是否允许取消 Unit 迁移。
          example: true
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
    UpdateProjectConfigRequest:
      type: object
      description: 更新项目配置请求体，全量替换式更新
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7cab0q8tfaao
        uid:
          type: string
          description: 用户ID（可选）
          example: "200006001999"
        commonTransferConfig:
          type: object
          description: 共同传输配置（sinkStoreFormat、sourceStoreFormat 等）
          example:
            throttle: 100
            timezone: +08:00
        fullTransferConfig:
          type: object
          description: 全量传输配置
          properties:
            readWorkerNum:
              type: integer
              description: 读取并发数
              example: 8
            writeWorkerNum:
              type: integer
              description: 写入并发数
              example: 8
            throttleRps:
              type: integer
              description: 全量传输限速 RPS，-1 表示不限速
              example: 1000
            throttleIOPS:
              type: integer
              description: 全量传输限速 IOPS 或流量阈值，-1 表示不限速
              example: 104857600
          example:
            enable: true
        incrTransferConfig:
          type: object
          description: 增量传输配置
          example:
            enable: true
        reverseIncrTransferConfig:
          type: object
          description: 反向增量传输配置
          example:
            enabled: true
      required:
        - id
    UpdateTagRequest:
      type: object
      description: 更新标签请求参数
      properties:
        orgId:
          type: string
          description: 组织ID
          example: ukp31txz9tmk6yqckhox****
        id:
          type: integer
          format: int64
          description: 标签 value ID（内层 ID）
          example: 244
        tagKey:
          type: string
          description: 标签 key 值
          example: env
        tagValue:
          type: string
          description: 标签 value 值
          example: prod
      required:
        - orgId
        - id
        - tagKey
        - tagValue
    UpdateTagResponse:
      type: object
      description: 更新标签响应结果
      properties:
        Code:
          type: integer
          format: int32
          description: 响应状态码
          example: 200
        Deletable:
          type: boolean
          description: 是否可删除
          example: false
        Message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        RequestId:
          type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        Success:
          type: boolean
          description: 是否成功
          example: true
    UpdateTenantRequest:
      type: object
      description: 更新租户请求
      properties:
        instanceId:
          type: string
          description: 集群id
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        description:
          type: string
          description: 描述
          example: 用于业务交易的租户
        tenantName:
          type: string
          description: 租户名
          example: pay_core
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        memory:
          type: integer
          format: int32
          description: 资源规格中的内存信息
          example: 16
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        diskSize:
          type: integer
          format: int32
          description: 共享存储缓存盘大小，单位GB
          example: 200
        iops:
          type: integer
          format: int32
          description: 存储每秒读写次数指标。
          example: 1000
        logDisk:
          type: integer
          format: int32
          description: 日志盘大小 (GiB)，单 unit。仅在满足日志盘扩容条件时生效。
          example: 200
    UserPasswordValidateRule:
      type: object
      description: 用户PasswordValidateRule
    UserRoleOpenAPI:
      type: object
      description: 用户RoleOpenAPI
    McDescribeTableSchemaRequest:
      type: object
      properties:
        startTime:
          type: string
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        sqlType:
          type: string
          description: SQL类型
          example: NORMAL
        sqlId:
          type: string
          description: SQL语句唯一标识
          example: sql_123456789
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        dbName:
          type: string
          description: 数据库名称
          example: test_db
        tableNames:
          type: array
          items:
            type: string
            description: 表名称
            example: |-
              ---
              - "orders"
          description: 表名称
          example:
            - orders
      description: Mc Describe Table Schema
    ResourceTagRequest:
      type: object
      properties:
        tagList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 标签列表
          description: 标签列表
          example:
            - tagKey: env
              tagValue: prod
      description: Resource Tag
    MaasCreateApiKeyData:
      type: object
      description: 创建 API Key 返回数据。apiKey 明文仅在创建时返回一次。
      properties:
        uuid:
          type: string
          description: API Key 的唯一标识。
          example: ak-xxxxxxxxxxxxxxxx
        name:
          type: string
          description: 名称。
          example: my-api-key
        apiKey:
          type: string
          description: api Key
          example: sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        createdAt:
          type: string
          format: date-time
          description: 创建时间。
          example: 2025-01-01T00:00:00Z
    MaasCreateApiKeyRequest:
      type: object
      description: 创建 API Key 请求体。
      properties:
        name:
          type: string
          description: 名称。
          example: my-api-key
        action:
          type: string
          description: 动作标识，与响应 action 字段 echo。
          example: MaasCreateApiKey
      required:
        - name
    MaasListApiKeysResponse:
      type: object
      description: 查询 API Key 列表响应。success 为 false 时返回 errorCode 和 errorMessage。
      properties:
        success:
          type: boolean
          description: 是否成功。
          example: true
        requestId:
          type: string
          description: 与请求 echo 的请求 ID。
          example: req-abc123
        action:
          type: string
          description: 与请求 Action 参数 echo 的动作标识。
          example: MaasListApiKeys
        data:
          description: 查询成功时返回的分页数据。
          allOf:
            - $ref: "#/components/schemas/MaasListApiKeysData"
        errorCode:
          type: string
          description: 错误码，仅 success 为 false 时返回。
          example: INVALID_PARAMETER
          enum:
            - INVALID_PARAMETER
            - FORBIDDEN
            - INTERNAL_ERROR
        errorMessage:
          type: string
          description: 错误信息，仅 success 为 false 时返回。
          example: X-OB-Org-Id is required in header
        meta:
          type: object
          description: 扩展字段。
          nullable: true
          example:
            id: resource-123456
      required:
        - success
    MaasListApiKeysData:
      type: object
      description: API Key 分页查询数据。
      properties:
        dataList:
          type: array
          description: API Key 列表。
          items:
            allOf:
              - $ref: "#/components/schemas/MaasApiKeyItem"
            description: API Key 列表。
          example:
            - id: resource-123456
        page:
          type: integer
          description: 页码。
          example: 1
        total:
          type: integer
          description: 总条数。
          example: 42
        totalPage:
          type: integer
          description: 总页数。
          example: 5
    OmsApiReturnResultTransferMapping:
      type: object
      description: 接口统一返回值，data 为传输对象映射配置
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        cost:
          type: string
          description: 耗时
          example: "1.0"
        data:
          type: object
          description: 传输对象映射配置
          example:
            id: resource-123456
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    MaasDeleteApiKeyResponse:
      type: object
      description: 删除 API Key 响应。success 为 false 时返回 errorCode 和 errorMessage。
      properties:
        success:
          type: boolean
          description: 是否成功。
          example: true
        requestId:
          type: string
          description: 与请求 echo 的请求 ID。
          example: req-abc123
        action:
          type: string
          description: 与请求 Action 参数 echo 的动作标识。
          example: MaasDeleteApiKey
        data:
          type: object
          description: 删除成功时返回空对象。
          example: {}
        errorCode:
          type: string
          description: 错误码，仅 success 为 false 时返回。
          example: NOT_FOUND
          enum:
            - INVALID_PARAMETER
            - FORBIDDEN
            - NOT_FOUND
            - INTERNAL_ERROR
        errorMessage:
          type: string
          description: 错误信息，仅 success 为 false 时返回。
          example: api key not found
        meta:
          type: object
          description: 扩展字段。
          nullable: true
          example:
            id: resource-123456
      required:
        - success
    DeleteProjectRequest:
      type: object
      description: 删除项目请求体，对应 CommonProjectController.deleteProject 入参 CommonIdRequest
      properties:
        id:
          type: string
          description: 资源唯一标识。
          example: np_7befdmp08juo
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
      required:
        - id
    MaasApiKeyItem:
      type: object
      description: API Key 列表项。
      properties:
        uuid:
          type: string
          description: API Key 唯一标识。
          example: ak-xxxxxxxxxxxxxxxx
        name:
          type: string
          description: 名称。
          example: my-api-key
        apiKey:
          type: string
          description: api Key
          example: sk-xxxx...xxxx
        createdAt:
          type: string
          format: date-time
          description: 创建时间。
          example: 2025-01-01T00:00:00Z
        lastUsedAt:
          type: string
          format: date-time
          description: 最近使用时间，未使用过则为空。
          example: 2025-06-01T12:00:00Z
          nullable: true
    MaasCreateApiKeyResponse:
      type: object
      description: 创建 API Key 响应。success 为 false 时返回 errorCode 和 errorMessage。
      properties:
        success:
          type: boolean
          description: 是否成功。
          example: true
        requestId:
          type: string
          description: 与请求 echo 的请求 ID。
          example: req-abc123
        action:
          type: string
          description: 与请求 Action 参数 echo 的动作标识。
          example: MaasCreateApiKey
        data:
          description: 创建成功时返回的 API Key 信息。
          allOf:
            - $ref: "#/components/schemas/MaasCreateApiKeyData"
        errorCode:
          type: string
          description: 错误码，仅 success 为 false 时返回。
          example: INVALID_PARAMETER
          enum:
            - INVALID_PARAMETER
            - FORBIDDEN
            - DUPLICATE_NAME
            - PROJECT_SUSPENDED
            - IAM_REGISTER_FAILED
            - INTERNAL_ERROR
        errorMessage:
          type: string
          description: 错误信息，仅 success 为 false 时返回。
          example: X-OB-Project-Id is required in header
        meta:
          type: object
          description: 扩展字段。
          nullable: true
          example:
            id: resource-123456
      required:
        - success
    OmsApiReturnResultModifyRecordDetail:
      type: object
      description: 接口统一返回值，data 为修改记录详情
      properties:
        success:
          type: boolean
          description: 是否调用成功
          example: true
        code:
          type: string
          description: 错误码
          example: "200"
        message:
          type: string
          description: 返回消息或错误提示信息。
          example: successful
        requestId:
          type: string
          description: 请求ID
          example: d04eabba-acef-4f4b-96f1-c657876ca6f1
        cost:
          type: string
          description: 耗时
          example: "1.0"
        data:
          allOf:
            - $ref: "#/components/schemas/DescribeModifyRecordResponse"
          description: 业务数据(object)
        errorDetail:
          type: object
          description: 错误详情
          example:
            id: resource-123456
    BackupTenantScopeInfo:
      type: object
      description: 备份策略中的租户范围信息，包含租户ID、名称和兼容模式
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
    HybridStorageInfo:
      type: object
      description: 混合存储配置，用于跨OSS账号的备份复制
      properties:
        accessKeyId:
          type: string
          description: 用户自有OSS的AccessKey ID
          example: ak-xxxxxxxxxxxxxxxx
        accessKeySecret:
          type: string
          description: 用户自有OSS的AccessKey Secret
          example: sk-xxxxxxxxxxxxxxxx
        bucketName:
          type: string
          description: 用户自有OSS的bucket名称
          example: oceanbase-backup
        region:
          type: string
          description: bucket所在region
          example: ap-guangzhou
    BackupModel:
      type: string
      description: Backup
    BackupObjectType:
      type: string
      description: Backup Object Type
    BackupStrategyStatus:
      type: string
      description: Backup Strategy Status
    BackupValidity:
      type: string
      description: Backup Validity
    BooleanResponseV2OpenAPI:
      type: object
      description: Boolean
      properties:
        success:
          type: boolean
          description: 操作是否成功
          example: true
        tip:
          type: string
          description: 提示信息
          example: successful
    CheckTenantSensitiveRuleSupportedResponseOpenAPI:
      type: object
      properties:
        supported:
          type: boolean
          description: 是否支持租户敏感字段保护规则能力
          example: true
      description: Check Tenant Sensitive Rule Supported
    CreateTenantSensitiveRuleRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        protectionPolicy:
          type: string
          description: 保护策略 ENCRYPTION、MASKING
          example: MASK
        encryptionAlgorithm:
          type: string
          description: 敏感字段使用的加密或脱敏算法
          example: AES_256
        sensitiveFields:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveField"
            description: 敏感字段列表，按数据库、表和列指定规则作用范围
          description: 敏感字段列表，按数据库、表和列指定规则作用范围
          example:
            - columnNames:
                - phone
              databaseName: test_db
              tableName: users
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Create Tenant Sensitive Rule
    CreateTenantSensitiveRuleResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        protectionPolicy:
          type: string
          description: 保护策略 ENCRYPTION、MASKING
          example: MASK
        encryptionAlgorithm:
          type: string
          description: 敏感字段使用的加密或脱敏算法
          example: AES_256
        sensitiveFields:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveFieldOpenAPI"
            description: 敏感字段列表，按数据库、表和列指定规则作用范围
          description: 敏感字段列表，按数据库、表和列指定规则作用范围
          example:
            - columnNames:
                - phone
              databaseName: test_db
              tableName: users
      description: Create Tenant Sensitive Rule
    DataBackupTaskStatus:
      type: string
      description: Data Backup Task Status
    DatabaseSchema:
      type: object
      description: Database Schema
    DeletePrometheusIntegrationParamOpenAPI:
      type: object
      properties:
        integrationId:
          type: string
          description: Prometheus 集成配置 ID
          example: resource-123456
      required:
        - integrationId
      description: Delete Prometheus Integration
    DeleteRecycleBinObjectRequestOpenAPI:
      type: object
      description: Delete Recycle Bin Object
      properties:
        ids:
          type: array
          description: 回收站对象记录id
          items:
            type: integer
            format: int64
            description: 回收站对象记录id
        clearRecycleBin:
          type: boolean
          description: 是否清空回收站
          example: true
    DeleteTenantSensitiveRuleRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Delete Tenant Sensitive Rule
    DeleteTenantSensitiveRuleResponseOpenAPI:
      type: object
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
      description: Delete Tenant Sensitive Rule
    DescribeInstancesResponseV2OpenAPI:
      type: object
      description: for multicloud rest api
      properties:
        region:
          type: string
          description: 地域。
          example: ap-guangzhou
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        instanceName:
          type: string
          description: 集群名称
          example: test-cluster
        instanceClass:
          type: string
          description: 集群规格
          example: 4C16G
        series:
          type: string
          description: 实例系列。
          example: NORMAL
        gmtCreate:
          type: string
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        obRpmVersion:
          type: string
          description: |-
            "4.2.1.0-100020042023102310" <br/>
            OB RPM版本
          example: 4.2.1.0-100020042023102310
        version:
          type: string
          description: |-
            "2.2.52" <br/>
            OB 版本
          example: 2.2.52
        maxCpu:
          type: integer
          format: int32
          description: 最大cpu规格
          example: 4
        maxMem:
          type: integer
          format: int64
          description: 最大内存规格（GB）
          example: 16
        usedDiskSize:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        state:
          type: string
          description: 状态。历史遗留
          example: ONLINE
        resource:
          allOf:
            - $ref: "#/components/schemas/ResourceDoV2"
          description: 资源规格信息，包括 CPU、内存、磁盘和节点资源等
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        deployMode:
          type: string
          description: 数据副本模式(n/n-n/n-n-n)
          example: 1-1-1
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        payType:
          type: string
          description: 付费类型。
          example: POSTPAID
        availableZones:
          type: array
          items:
            type: string
            description: |-
              ["h", "i", "j"] <br/>
              可用区域
            example: |-
              ---
              - "h"
          description: |-
            ["h", "i", "j"] <br/>
            可用区域
          example:
            - h
        deployType:
          type: string
          description: |-
            'single' | 'multiple' | 'dual' <br/>
            部署类型: 单机房｜多机房｜双机房
          example: single
        gmtEnd:
          type: string
          description: 结束时间
          example: 2026-02-25T15:40:43Z
        cloudProvider:
          type: string
          description: 资源或数据源所在云厂商
          example: ALIYUN
        managementMode:
          type: string
          description: 管理模式
          example: DBAAS
        instanceType:
          type: string
          description: 实例类型
          example: DEDICATED
        diskType:
          type: string
          description: |-
            "cloud_essd_pl1" | "ephemeral_ssd" <br/>
            存储类型: ESSD云盘 | 本地SSD盘
          example: cloud_essd
        diskSize:
          type: integer
          format: int64
          description: 磁盘大小
          example: 200
        instanceRole:
          type: string
          description: 实例角色，例如主实例或备实例。
          example: PRIMARY
        primaryInstanceId:
          type: string
          description: 2022-05-10 主库ID，仅当instanceRole=PHYSICAL_STANDBY时有效
          example: obcluster-primary
        standbyInstanceIds:
          type: array
          description: 2022-05-10 备库ID，仅当instanceRole=PRIMARY时有效
          items:
            type: string
            description: 2022-05-10 备库ID，仅当instanceRole=PRIMARY时有效
            example: |-
              ---
              - "obcluster-standby"
          example:
            - obcluster-standby
        stopTime:
          type: string
          description: 停止时间。
          example: 2026-02-26T10:40:43Z
        saleChannel:
          type: string
          description: |-
            售卖渠道: overseas: 海外自营渠道 domestic: 国内自营渠道 aliyun_domestic: 阿里云国内站 huawei_mp_domestic: 华为云国内站 aws_mp_domestic: AWS国内站 aws-mp: AWS海外站
            aliyun_overseas: 阿里云海外站 gcp_mp: GCP Marketplace
          example: domestic
        tagList:
          type: array
          description: 标签列表
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 标签列表
          example:
            - tagKey: env
              tagValue: prod
        cpuArchitecture:
          type: string
          description: CPU 架构。
          example: "4"
        storageArchitecture:
          type: string
          description: "存储架构,shareStorage/standardStorage 共享存储/标准存储"
          example: standardStorage
        storageDiskType:
          type: string
          description: 存储类型; 目前仅tp模式支持选择存储类型且仅支持OBPL1
          example: OBPL1
    DescribeOperationEventsResponseV2OpenAPI:
      type: object
      properties:
        resourceType:
          type: string
          description: 操作事件关联的资源类型
          example: TENANT
        resourceId:
          type: string
          description: 资源 ID。
          example: resource-123456
        resourceName:
          type: string
          description: 资源名称。
          example: test-name
        eventType:
          type: string
          description: 操作事件类型
          example: CREATE_TENANT
        eventDescription:
          type: string
          description: 通常是openapi的名称（action），PayOrderCallback时为特例
          example: successful
        eventSource:
          type: string
          description: 事件来源
          example: OPENAPI
        eventStatus:
          type: string
          description: 操作事件状态
          example: SUCCESS
        resultCode:
          type: integer
          format: int32
          description: 结果码
          example: 1
        resultMessage:
          type: string
          description: 结果信息
          example: successful
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        params:
          type: string
          description: 请求参数
          example: "{\"instanceId\":\"obcluster-*****\"}"
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
        productName:
          type: string
          description: 产生操作事件的产品名称
          example: OceanBase
        gmtCreate:
          type: string
          format: date-time
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          format: date-time
          description: 修改时间
          example: 2026-02-26T10:40:43Z
      description: Describe Operation Events
    DescribeRecycleBinRequestOpenAPI:
      type: object
      description: Describe Recycle Bin
      properties:
        instanceId:
          type: string
          description: 实例ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        objectType:
          type: string
          description: "对象类型: DATABASE/TABLE"
          example: NORMAL
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        searchKey:
          type: string
          description: 搜索关键字
          example: env
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        sortField:
          type: string
          description: 排序字段
          example: createTime
        sortOrder:
          type: string
          description: "排序顺序: ASCEND/DESCEND"
          example: DESC
        databases:
          type: string
          description: 数据库列表。
          example: test_db
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
    DescribeRecycleBinResponseV2OpenAPI:
      type: object
      description: Describe Recycle Bin
      properties:
        recycleBinObjects:
          type: array
          description: 回收站对象列表
          items:
            allOf:
              - $ref: "#/components/schemas/RecycleBinObjectVoV2OpenAPI"
            description: 回收站对象列表
        totalCount:
          type: integer
          format: int32
          description: 总记录数。
          example: 100
        recycleBinStatus:
          type: string
          description: "回收站状态: ON/OFF"
          example: ONLINE
        expireTime:
          type: integer
          format: int32
          description: 过期时间
          example: 1
        expireTimeUnit:
          type: string
          description: "过期时间单位: d(天), h(小时), m(分钟)"
          example: DAY
        operationMaxSize:
          type: integer
          format: int32
          description: 操作最大数量
          example: 200
        usedDiskSize:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        tenantIds:
          type: array
          description: 租户 ID 列表。
          items:
            type: string
            description: 租户 ID 列表。
            example: |-
              ---
              - "t4louaeei****"
          example:
            - t4louaeei****
        tenantMods:
          type: array
          description: 租户模式列表
          items:
            type: string
            description: 租户模式列表
        databases:
          type: array
          description: 数据库列表。
          items:
            type: string
            description: 数据库列表。
            example: |-
              ---
              - "test_db"
          example:
            - test_db
    DescribeRecycleBinSummaryResponseV2OpenAPI:
      type: object
      description: Describe Recycle Bin Summary
      properties:
        recycleBinStatus:
          type: string
          description: "回收站状态: ON/OFF"
          example: ONLINE
        tableCount:
          type: integer
          format: int32
          description: 表数量
          example: 3
        databaseCount:
          type: integer
          format: int32
          description: 库数量
          example: 3
        count:
          type: integer
          format: int32
          description: 总对象数量
          example: 3
        tableUsedDiskSize:
          type: integer
          format: int64
          description: 表使用磁盘大小
          example: 200
        databaseUsedDiskSize:
          type: integer
          format: int64
          description: 库使用磁盘大小
          example: 200
        usedDiskSize:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        expireTime:
          type: integer
          format: int32
          description: 过期时间
          example: 1
        expireTimeUnit:
          type: string
          description: "过期时间单位: d(天), h(小时), m(分钟)"
          example: DAY
        dataMergeTime:
          type: string
          description: 数据合并时间
          example: 02:00
    DescribeRestorableTenantsResponseV2OpenAPI:
      type: object
      description: Describe Restorable Tenants
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        checkpoint:
          type: string
          format: date-time
          description: 备份集或恢复任务的检查点。
          example: 2026-02-25T15:40:43Z
        timeIntervalList:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TimeInterval"
            description: 时间区间列表。
          description: 时间区间列表。
          example:
            - id: resource-123456
        clusterId:
          type: string
          description: 集群ID
          example: obcluster-*****
        clusterName:
          type: string
          description: 集群备份目录，可以为空
          example: test-cluster
        obRpmVersion:
          type: string
          description: |-
            "4.2.1.0-100020042023102310" <br/>
            OB RPM版本
          example: 4.2.1.0-100020042023102310
        obVersion:
          type: string
          description: OceanBase 版本。
          example: 4.2.1.0
        sourceRegion:
          type: string
          description: 源地域
          example: cn-hangzhou
        tenantAlias:
          type: string
          description: 租户别名
          example: pay_core
        cpuNum:
          type: integer
          format: int32
          description: CPU 数量。
          example: 4
        memoryNum:
          type: integer
          format: int32
          description: 内存数量。
          example: 16
        usedDisk:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        method:
          type: string
          description: 操作方式。
          example: RESTORE
        backupSetRestoreSummaries:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/BackupSetRestoreSummary"
            description: 可恢复备份集摘要列表。
          description: 可恢复备份集摘要列表。
          example:
            - id: resource-123456
        tenantDataBackupRemainDays:
          type: integer
          format: int32
          description: 租户数据备份剩余保留天数。
          example: 1
        obTenantId:
          type: string
          description: OceanBase 租户 ID。
          example: t4louaeei****
    DescribeRestoreTaskResponseV2OpenAPI:
      type: object
      description: Describe Restore Task
      properties:
        taskId:
          type: integer
          format: int64
          description: 任务 ID
          example: 1
        sourceInstanceId:
          type: string
          description: 源实例 ID。
          example: obcluster-source
        sourceInstanceName:
          type: string
          description: 源实例名称
          example: source-cluster
        sourceTenantId:
          type: string
          description: 源租户 ID。
          example: t4source****
        sourceTenantName:
          type: string
          description: 源租户名称
          example: source_tenant
        targetInstanceId:
          type: string
          description: 目标实例 ID。
          example: obcluster-target
        targetInstanceName:
          type: string
          description: 目标实例名称
          example: target-cluster
        targetTenantId:
          type: string
          description: 目标租户 ID。
          example: t4target****
        targetTenantName:
          type: string
          description: 目标租户名称。
          example: pay_core_restore
        restoreTime:
          type: string
          format: date-time
          description: 恢复时间点。
          example: 2026-02-25T15:40:43Z
        startTime:
          type: string
          format: date-time
          description: 起始时间(UTC)
          example: 2026-02-25T15:40:43Z
        endTime:
          type: string
          format: date-time
          description: 结束时间(UTC)
          example: 2026-02-26T10:40:43Z
        status:
          allOf:
            - $ref: "#/components/schemas/RestoreTaskStatus"
          description: 任务或资源当前状态
        progress:
          type: string
          description: 任务进度。
          example: 100%
        logRestoreProgress:
          type: string
          description: 日志恢复进度
          example: 100%
        logRestoreTime:
          type: string
          format: date-time
          description: 日志恢复到的时间点
          example: 2026-02-25T15:40:43Z
        restoreObjectType:
          type: string
          description: 恢复对象类型，例如租户、数据库或表。
          example: tenant
        restoreMode:
          type: string
          description: 恢复模式。
          example: from_time_point
        restoreObjects:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/RestoreObject"
            description: 恢复对象列表。
          description: 恢复对象列表。
          example:
            - id: resource-123456
    DescribeTenantPlainAccessUsersResponseOpenAPI:
      type: object
      properties:
        users:
          type: array
          items:
            type: string
            description: 用户列表。
            example: |-
              ---
              - "[{id=resource-123456}]"
          description: 用户列表。
          example:
            - "[{id=resource-123456}]"
      description: Describe Tenant Plain Access Users
    DescribeTenantSensitiveRuleEncryptionAlgorithmsResponseOpenAPI:
      type: object
      properties:
        algorithms:
          type: array
          items:
            type: string
            description: 敏感字段保护支持的加密或脱敏算法列表
            example: |-
              ---
              - "AES_256"
          description: 敏感字段保护支持的加密或脱敏算法列表
          example:
            - AES_256
      description: Describe Tenant Sensitive Rule Encryption Algorithms
    DescribeTenantSensitiveRulesResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        sensitiveRules:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveRuleOpenAPI"
            description: 租户敏感字段保护规则列表
          description: 租户敏感字段保护规则列表
          example:
            - id: resource-123456
        totalCount:
          type: integer
          format: int32
          description: 总记录数。
          example: 100
      description: Describe Tenant Sensitive Rules
    DescribeTenantUserTableSchemaResponseOpenAPI:
      type: object
      properties:
        authorized:
          type: boolean
          description: 是否已授权访问租户用户表结构信息
          example: true
        databases:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/DatabaseSchema"
            description: 数据库列表。
          description: 数据库列表。
      description: Describe Tenant User Table Schema
    ErrorResponse:
      type: object
      description: 标准错误响应
      properties:
        success:
          type: boolean
          description: 是否成功
          example: true
        errorCode:
          type: string
          description: 错误码
          example: INVALID_PARAMETER
        errorMessage:
          type: string
          description: 错误信息
          example: Invalid parameter
        requestId:
          type: string
          description: 请求 ID
          example: dc302d76-66b5-48d8-ab53-a035********
    FlashBackRecycleBinObjectsRequestOpenAPI:
      type: object
      description: Flash Back Recycle Bin Objects
      properties:
        recycleBinObjects:
          type: array
          description: 回收站对象列表
          items:
            allOf:
              - $ref: "#/components/schemas/RecycleBinObjectOpenAPI"
            description: 回收站对象列表
    LogBackupStatus:
      type: string
      description: Log Backup Status
    ModifyInstanceRecycleBinRequestOpenAPI:
      type: object
      description: Modify Instance Recycle Bin
      properties:
        recycleBinStatus:
          type: string
          description: "回收站状态: ON/OFF"
          example: ONLINE
    ModifyRecycleBinExpireTimeRequestOpenAPI:
      type: object
      description: Modify Recycle Bin Expire Time
      properties:
        expireTime:
          type: integer
          format: int32
          description: 过期时间
          example: 1
        expireTimeUnit:
          type: string
          description: "过期时间单位: d(天), h(小时), m(分钟)"
          example: DAY
    ModifyRecycleBinExpireTimeResponseV2OpenAPI:
      type: object
      description: Modify Recycle Bin Expire Time
      properties:
        expireTime:
          type: integer
          format: int32
          description: 过期时间
          example: 1
        expireTimeUnit:
          type: string
          description: "过期时间单位: d(天), h(小时), m(分钟)"
          example: DAY
    ModifyRecycleBinStatusResponseV2OpenAPI:
      type: object
      description: Modify Recycle Bin Status
      properties:
        recycleBinStatus:
          allOf:
            - $ref: "#/components/schemas/RecycleBinStatus"
          description: "回收站状态: ON/OFF"
    ModifyTenantRecycleBinRequestOpenAPI:
      type: object
      description: Modify Tenant Recycle Bin
      properties:
        recycleBinStatus:
          type: string
          description: "回收站状态: ON/OFF"
          example: ONLINE
    ModifyTenantSensitiveRuleRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        encryptionAlgorithm:
          type: string
          description: 敏感字段使用的加密或脱敏算法
          example: AES_256
        sensitiveFields:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveField"
            description: 敏感字段列表，按数据库、表和列指定规则作用范围
          description: 敏感字段列表，按数据库、表和列指定规则作用范围
          example:
            - columnNames:
                - phone
              databaseName: test_db
              tableName: users
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Modify Tenant Sensitive Rule
    ModifyTenantSensitiveRuleResponseOpenAPI:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        alterType:
          type: string
          description: 敏感字段保护规则的变更类型
          example: NORMAL
        encryptionAlgorithm:
          type: string
          description: 敏感字段使用的加密或脱敏算法
          example: AES_256
        sensitiveFields:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveFieldOpenAPI"
            description: 敏感字段列表，按数据库、表和列指定规则作用范围
          description: 敏感字段列表，按数据库、表和列指定规则作用范围
          example:
            - columnNames:
                - phone
              databaseName: test_db
              tableName: users
      description: Modify Tenant Sensitive Rule
    MultiCustomMonitorConfigDtoOpenAPI:
      type: object
      properties:
        metricKey:
          type: string
          description: 监控指标键。
          example: env
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
        metricClass:
          type: string
          description: 监控指标类别。
          example: TENANT
        customGroup:
          type: string
          description: 自定义监控分组。
          example: default
        unit:
          type: string
          description: 监控指标单位。
          example: '%'
      description: Multi Custom Monitor Config Dto
    NodeOptionDTO:
      type: object
      description: 监控的节点选项
      properties:
        nodeId:
          type: string
          description: 节点标识。
          example: node-1
        zoneId:
          type: string
          description: 可用区 ID。
          example: cn-hangzhou-i
        ip:
          type: string
          description: 网络地址。
          example: 10.0.0.10
    OBCloudPagingDataDescribeDataBackupSetResponseV2OpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeDataBackupSetResponseV2OpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataDescribeInstancesResponseV2OpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeInstancesResponseV2OpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataDescribeOperationEventsResponseV2OpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeOperationEventsResponseV2OpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataDescribeRestoreTaskResponseV2OpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/DescribeRestoreTaskResponseV2OpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataOperationEventDoV2OpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/OperationEventDoV2OpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataTenantDTO:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/TenantDTO"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    OBCloudPagingDataTenantDTOOpenAPI:
      type: object
      description: 分页数据
      properties:
        dataList:
          type: array
          description: 数据集
          items:
            allOf:
              - $ref: "#/components/schemas/TenantDTOOpenAPI"
            description: 数据集
          example:
            - id: resource-123456
        total:
          type: number
          format: int64
          description: 数据总量
          example: 100.0
        hasMore:
          type: boolean
          description: 是否还有数据
          example: true
    ObCloudMultiCustomMonitorConfigDtoOpenAPI:
      type: object
      description: Ob Cloud Multi Custom Monitor Config Dto
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: This field was generated by MyBatis Generator. This field corresponds
            to the database column obcloud_metric_class.name_en
          example: t4louaeei****
        configName:
          type: string
          description: 配置项名称。
          example: test-name
        customMonitorConfig:
          type: array
          description: 自定义监控配置内容。
          items:
            allOf:
              - $ref: "#/components/schemas/MultiCustomMonitorConfigDtoOpenAPI"
            description: 自定义监控配置内容。
          example:
            - interval: 60
              enabled: true
        customMonitorDimension:
          type: string
          description: 自定义监控维度。
          example: TENANT
        deleted:
          type: integer
          format: int32
          description: 是否已删除。
          example: 0
    ObCloudMutiMetricClassVoOpenAPI:
      type: object
      description: Ob Cloud Muti Metric Class Vo
      properties:
        metricClass:
          type: string
          description: 监控指标类别。
          example: TENANT
        name:
          type: string
          description: 名称。
          example: 数据源名称
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
        scope:
          type: string
          description: 适用范围
          example: TENANT
        metricGroups:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ObCloudMutiMetricGroupVoOpenAPI"
            description: 监控指标分组列表。
          description: 监控指标分组列表。
          example:
            - id: resource-123456
    ObCloudMutiMetricGroupVoOpenAPI:
      type: object
      description: Ob Cloud Muti Metric Group Vo
      properties:
        metricGroup:
          type: string
          description: 监控指标分组。
          example: cpu
        metricClass:
          type: string
          description: 监控指标类别。
          example: TENANT
        name:
          type: string
          description: 名称。
          example: 数据源名称
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
        metricMetas:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/ObCloudMutiMetricMetaVoOpenAPI"
            description: 监控指标元信息列表。
          description: 监控指标元信息列表。
          example:
            - id: resource-123456
        defaultTab:
          type: string
          description: 默认展示的指标页签。
          example: overview
        tab:
          type: string
          description: 指标页签。
          example: overview
    ObCloudMutiMetricMetaVoOpenAPI:
      type: object
      description: Ob Cloud Muti Metric Meta Vo
      properties:
        metricKey:
          type: string
          description: 监控指标键。
          example: env
        metricGroup:
          type: string
          description: 监控指标分组。
          example: cpu
        metricClass:
          type: string
          description: 监控指标类别。
          example: TENANT
        name:
          type: string
          description: 名称。
          example: 数据源名称
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
        unit:
          type: string
          description: 监控指标单位。
          example: '%'
        labels:
          type: string
          description: 标签
          example: "tenantId,serverIp"
        tab:
          type: string
          description: 指标页签。
          example: overview
        alarmEnabled:
          type: boolean
          description: 是否启用告警。
          example: true
    ObcloudRagClusterDo:
      type: object
      description: Obcloud Rag Cluster
      properties:
        gmtCreate:
          type: string
          format: date-time
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          format: date-time
          description: 修改时间
          example: 2026-02-26T10:40:43Z
        ragClusterId:
          type: string
          description: RAG集群ID
          example: obcluster-*****
        ragClusterArn:
          type: string
          description: RAG集群ARN
          example: acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        region:
          type: string
          description: 地域。
          example: ap-guangzhou
        zone:
          type: string
          description: 可用区。
          example: cn-hangzhou-i
        version:
          type: string
          description: |-
            "2.2.52" <br/>
            OB 版本
          example: 2.2.52
        cloudProvider:
          type: string
          description: 资源或数据源所在云厂商
          example: ALIYUN
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        resourceAccount:
          type: string
          description: 资源账号
          example: "3"
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        servicePort:
          type: string
          description: 服务端口。
          example: "2881"
        backendServicePort:
          type: string
          description: 后端服务端口
          example: "2881"
        serviceDomain:
          type: string
          description: 服务访问域名
          example: pay-core.oceanbase.example.com
        serviceAddress:
          type: string
          description: 服务访问地址
          example: 10.0.0.10
        loadBalanceId:
          type: string
          description: 负载均衡实例 ID
          example: lb-xxxxxx
        lbVpcId:
          type: string
          description: 负载均衡所在 VPC ID
          example: vpc-xxxxx
        lbVswId:
          type: string
          description: 负载均衡所在交换机 ID
          example: vsw-xxxxx
        lbMasterZone:
          type: string
          description: 负载均衡主可用区
          example: cn-hangzhou-i
        lbSlaveZone:
          type: string
          description: 负载均衡备可用区
          example: cn-hangzhou-i
    OcpParameterDTOOpenAPI:
      type: object
      description: Ocp Parameter
      properties:
        name:
          type: string
          description: 名称。
          example: 数据源名称
        currentValue:
          type: string
          description: 当前参数值。
          example: prod
        needReboot:
          type: boolean
          description: 修改参数后是否需要重启。
          example: true
        defaultValue:
          type: string
          description: 默认参数值。
          example: prod
        valueType:
          type: string
          description: 参数值类型。
          example: NORMAL
        acceptableValue:
          type: array
          items:
            type: string
            description: 参数允许设置的取值列表。
            example: |-
              ---
              - "orders"
          description: 参数允许设置的取值列表。
          example:
            - orders
        rejectedValue:
          type: array
          items:
            type: string
            description: 参数不允许设置的取值列表。
          description: 参数不允许设置的取值列表。
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
    OperationEventDoV2OpenAPI:
      type: object
      description: Operation Event
      properties:
        resourceType:
          allOf:
            - $ref: "#/components/schemas/OperationResourceTypeEnum"
          description: 操作事件关联的资源类型
        currentLanguageResourceType:
          type: string
          description: 当前语言对应的resourceType
          example: NORMAL
        resourceId:
          type: string
          description: 资源 ID。
          example: resource-123456
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        clusterRole:
          type: string
          description: 集群角色
          example: PRIMARY
        isExist:
          type: boolean
          description: 是否存在
          example: true
        resourceName:
          type: string
          description: 资源名称。
          example: test-name
        eventType:
          allOf:
            - $ref: "#/components/schemas/OperationEventTypeEnum"
          description: 操作事件类型
        currentLanguageEventType:
          type: string
          description: 当前语言对应的事件类型
          example: NORMAL
        eventDescription:
          type: string
          description: |-
            通常是openapi的名称（action），PayOrderCallback时为特例
            <ul>
            <li>deleteObProxy 删除OBProxy</li>
            <li>deleteObCluster 删除OB集群</li>
            <li>deleteObServer 删除OB主机</li>
            <li>stopEcs 停止服务器</li>
            <li>deleteEcs 释放服务器</li>
            <li>deleteEip 释放弹性IP</li>
            <li>deleteSg 删除安全组</li>
            </ul>
          example: successful
        currentLanguageEventDescription:
          type: string
          description: 当前语言对应的事件描述
          example: successful
        eventSource:
          type: string
          description: 事件来源
          example: OPENAPI
        eventStatus:
          allOf:
            - $ref: "#/components/schemas/OperationEventStatusEnum"
          description: 操作事件状态
        resultCode:
          type: integer
          format: int32
          description: 结果码
          example: 1
        resultMessage:
          type: string
          description: 结果信息
          example: successful
        uid:
          type: string
          description: 用户 ID。
          example: "200006001999"
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        phoneNumber:
          type: string
          description: 操作者手机号
          example: "3"
        projectMemberName:
          type: string
          description: 组织成员名称
          example: "16"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        params:
          type: string
          description: 请求参数
          example: "{\"instanceId\":\"obcluster-*****\"}"
        gmtCreate:
          type: string
          format: date-time
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        gmtModified:
          type: string
          format: date-time
          description: 修改时间
          example: 2026-02-26T10:40:43Z
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        finishedTime:
          type: string
          description: 结束时间
          example: 2026-02-25T15:40:43Z
        projectId:
          type: string
          description: 项目ID
          example: hxq3ztx3377nby3v87ry****
    PrometheusIntegrationDtoOpenAPI:
      type: object
      properties:
        integrationId:
          type: string
          description: Prometheus 集成配置 ID
          example: resource-123456
        prometheusConfig:
          type: string
          description: Prometheus 集成配置内容，用于接入外部 Prometheus 监控
          example: http://prometheus.example.com:9090
        createdAt:
          type: string
          description: Prometheus 集成配置创建时间
          example: 2026-02-25T15:40:43Z
      description: Prometheus Integration Dto
    PrometheusIntegrationListDtoOpenAPI:
      type: object
      properties:
        integrationId:
          type: string
          description: 集成配置 ID。
          example: resource-123456
        integrationName:
          type: string
          description: integration Name名称
          example: test-name
        createdAt:
          type: string
          description: 创建时间。
          example: 2026-02-25T15:40:43Z
      description: Prometheus Integration List Dto
    ProxySetting:
      type: object
      properties:
        mode:
          type: string
          description: ODP 代理集群规格调整模式。
          example: NORMAL
        deploymentArchitecture:
          type: string
          description: "代理集群部署方案，参考 {@link com.oceanbase.cloud.infra.common.enums.ProxyDeploymentArchitecture}"
          example: SINGLE_ZONE
        zone:
          type: array
          description: 可用区。
          items:
            type: string
            description: 可用区。
            example: |-
              ---
              - "cn-hangzhou-i"
          example:
            - cn-hangzhou-i
        slaveZone:
          type: array
          description: 备节点可用区，仅选择双/三可用区主备部署方案时设置
          items:
            type: string
            description: 备节点可用区，仅选择双/三可用区主备部署方案时设置
            example: |-
              ---
              - "cn-hangzhou-i"
              - "cn-hangzhou-j"
          example:
            - cn-hangzhou-i
            - cn-hangzhou-j
        nodeCpu:
          type: number
          format: float
          description: 节点规格
          example: 4.0
      description: Proxy Setting
    ReadOnlyInstanceOperationReasonEnum:
      type: string
      description: Read Only Instance Operation Reason Enum
    ReadOnlyReplicaType:
      type: string
      description: Read Only Replica Type
    ReadonlyZoneCpuConstraintOpenAPI:
      type: object
      description: 只读副本 CPU 约束（OpenAPI）
      properties:
        logicalZone:
          type: string
          description: 逻辑可用区
          example: ap-beijing-3-ro-z0
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        minCpu:
          type: integer
          format: int32
          description: 最小 CPU 规格（核）
          example: 4
        maxCpu:
          type: integer
          format: int32
          description: 最大 CPU 规格（核）
          example: 4
    RecycleBinObjectOpenAPI:
      type: object
      description: Recycle Bin Object
      properties:
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        objectName:
          type: string
          description: 对象名称
          example: test-name
        objectType:
          type: string
          description: "对象类型: DATABASE/TABLE"
          example: NORMAL
        tableName:
          type: string
          description: 表名。
          example: orders
        newTableName:
          type: string
          description: 新表名称(用于闪回时重命名)
          example: orders
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        newDatabaseName:
          type: string
          description: 新数据库名称(用于闪回时重命名)
          example: test_db
        id:
          type: integer
          format: int64
          description: 资源唯一标识。
          example: 244
    RecycleBinObjectVoV2OpenAPI:
      type: object
      description: Recycle Bin Object Vo
      properties:
        obServerTenantId:
          type: integer
          format: int64
          description: OB Server租户ID
          example: 1
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        tenantName:
          type: string
          description: 租户名称
          example: pay_core
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        objectName:
          type: string
          description: 对象名称
          example: test-name
        objectType:
          type: string
          description: "对象类型: DATABASE/TABLE"
          example: NORMAL
        gmtCreate:
          type: string
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        purgeTime:
          type: string
          description: 清理时间
          example: 2026-02-25T15:40:43Z
        databaseId:
          type: integer
          format: int64
          description: 数据库ID
          example: 1
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        tableId:
          type: integer
          format: int64
          description: 表ID
          example: 1
        tableName:
          type: string
          description: 表名。
          example: orders
        usedDiskSize:
          type: integer
          format: int64
          description: 已使用磁盘容量。
          example: 200
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        id:
          type: integer
          format: int64
          description: 资源唯一标识。
          example: 244
        gmtCreateDate:
          type: string
          format: date-time
          description: 创建时间Date
          example: 2026-02-25T15:40:43Z
        purgeTimeDate:
          type: string
          format: date-time
          description: 清理时间Date
          example: 2026-02-25T15:40:43Z
        objectKey:
          type: string
          description: 对象唯一键
          example: env
    RecycleBinStatus:
      type: string
      description: Recycle Bin Status
    RestoreTaskStatus:
      type: string
      description: Restore Task Status
    SensitiveField:
      type: object
      description: Sensitive Field
    SensitiveFieldOpenAPI:
      type: object
      properties:
        databaseName:
          type: string
          description: 数据库名称
          example: test_db
        tableName:
          type: string
          description: 表名。
          example: orders
        columnNames:
          type: array
          items:
            type: string
            description: 敏感字段所在列名列表
            example: |-
              ---
              - "card_no"
          description: 敏感字段所在列名列表
          example:
            - card_no
      description: Sensitive Field
    SensitiveRuleOpenAPI:
      type: object
      properties:
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: test-name
        sensitiveFields:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SensitiveFieldOpenAPI"
            description: 敏感字段列表，按数据库、表和列指定规则作用范围
          description: 敏感字段列表，按数据库、表和列指定规则作用范围
          example:
            - columnNames:
                - phone
              databaseName: test_db
              tableName: users
        protectionPolicy:
          type: string
          description: 保护策略 ENCRYPTION、MASKING
          example: MASK
        encryptionAlgorithm:
          type: string
          description: 敏感字段使用的加密或脱敏算法
          example: AES_256
        enabled:
          type: boolean
          description: 规则是否启用（true=启用，false=禁用）
          example: true
      description: Sensitive Rule
    SqlAuditFilterRuleConfig:
      type: object
      description: Sql Audit Filter Rule Config
      properties:
        allUsers:
          type: boolean
          description: all Users
          example: true
        users:
          type: array
          items:
            type: string
            description: 用户列表。
            example: |-
              ---
              - "admin"
          description: 用户列表。
          example:
            - admin
        auditResult:
          type: string
          description: audit Result
          example: example-value
        sqlTypes:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/SqlTypeRuleConfig"
            description: sql Types
          description: sql Types
          example:
            - id: resource-123456
    SqlTypeRuleConfig:
      type: object
      description: Sql Type Rule Config
    T:
      type: object
      description: T
    TenantCompatibilityModeEnum:
      type: string
      description: Tenant Compatibility Mode Enum
    TenantConnectionDTOOpenAPI:
      type: object
      description: Tenant Connection
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        userVpcOwnerId:
          type: string
          description: 用户 VPC 所属账号标识。
          example: "200006001999"
        vSwitchId:
          type: string
          description: 交换机标识。
          example: vsw-xxxxx
        connectionZones:
          type: array
          description: 连接的zone
          items:
            type: string
            description: 连接的zone
            example: |-
              ---
              - "cn-hangzhou-i"
          example:
            - cn-hangzhou-i
        tenantEndpointId:
          type: string
          description: 多云v5 补充 tenantEndpoint Id
          example: te-xxxxxx
        addressId:
          type: string
          description: 连接地址或服务地址标识。
          example: rs-private-internet-*****
        addressStatus:
          type: string
          description: 连接状态
          example: ONLINE
        serviceType:
          type: string
          description: 地址类型
          example: PRIVATE
        addressType:
          type: string
          description: 地址类型：MASTER，READONLY
          example: MASTER
        networkType:
          type: string
          description: 网络类型
          example: INTRANET
        role:
          type: string
          description: "连接类型, 读写/仅读. READWRITE/READONLY 有时候主地址也需要区分读写类型，备库的主地址是只读的"
          example: READWRITE
        userNameFormat:
          type: string
          description: 使用该地址时用户名格式：一段式、两段式
          example: TWO_PART
        useSSL:
          type: boolean
          description: 是否打开ssl
          example: false
        proxyClusterId:
          type: string
          description: ODP 代理集群 ID。
          example: proxy-123456
        proxyClusterInfo:
          allOf:
            - $ref: "#/components/schemas/ProxyClusterInfoDTO"
          description: 租户连接关联的 ODP 代理集群信息
        odpVersion:
          type: string
          description: ODP 版本。
          example: 4.2.1
        readStrategyConfigResponse:
          allOf:
            - $ref: "#/components/schemas/TenantAddressReadStrategyConfigDTO"
          description: 租户连接地址的读流量策略配置
        internetAddress:
          type: string
          description: 公网地址
          example: 8.8.8.8
        internetPort:
          type: integer
          format: int32
          description: 公网端口
          example: 2881
        internetDomain:
          type: string
          description: 公网地址
          example: pay-core-public.oceanbase.example.com
        internetAddressStatus:
          type: string
          description: 公网地址状态
          example: ONLINE
        internetMaxConnectionNum:
          type: integer
          format: int32
          description: 公网最大连接数
          example: 10000
        internetMaxConnectionNumLimit:
          type: integer
          format: int32
          description: 公网最大连接数 limit 限制
          example: 20000
        internetRpcPort:
          type: integer
          format: int32
          description: 公网 RPC 端口
          example: 2882
        internetProxyClusterId:
          type: string
          description: 公网proxy cluster id
          example: proxy-123456
        intranetAddress:
          type: string
          description: 私网地址
          example: 10.0.0.10
        intranetPort:
          type: integer
          format: int32
          description: 内网端口
          example: 2881
        intranetDomain:
          type: string
          description: 内网地址
          example: pay-core-private.oceanbase.example.com
        intranetAddressStatus:
          type: string
          description: 内网地址状态
          example: ONLINE
        maxConnectionNum:
          type: integer
          format: int32
          description: 私网最大连接数
          example: 10000
        maxConnectionNumLimit:
          type: integer
          format: int32
          description: 私网最大连接数修改 Limit 限制
          example: 20000
        intranetRpcPort:
          type: integer
          format: int32
          description: 私网 RPC 端口
          example: 2882
        enableRPc:
          type: boolean
          description: 是否开启 rpc ，旁路导入
          example: true
        intranetAddressMasterZoneId:
          type: string
          description: 主zone id
          example: cn-hangzhou-i
        intranetAddressSlaveZoneId:
          type: string
          description: 备zone id
          example: cn-hangzhou-j
        intranetProxyClusterId:
          type: string
          description: 私网的proxy cluster id
          example: proxy-123456
        privateLinkList:
          type: array
          description: private link列表信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantPrivateLinkDTO"
            description: private link列表信息
          example:
            - endpointId: ep-xxxxxx
              status: CONNECTED
    TenantDTOOpenAPI:
      type: object
      properties:
        tenantId:
          type: string
          description: 租户id
          example: t4louaeei****
        ocpTenantId:
          type: integer
          format: int64
          description: OCP 内部租户标识。
          example: 10001
        tenantName:
          type: string
          description: 租户名
          example: pay_core
        managementMode:
          type: string
          description: 管理模式，dbaas or maas
          example: DBAAS
        gmtCreate:
          type: string
          description: 创建时间
          example: 2026-02-25T15:40:43Z
        createTime:
          type: string
          description: 创建时间(UTC)
          example: 2026-02-25T15:40:43Z
        tenantMode:
          type: string
          description: 租户模式，例如 MySQL 或 Oracle。
          example: MYSQL
        primaryRegion:
          type: string
          description: 主地域
          example: cn-hangzhou
        primaryZone:
          type: string
          description: 主zone
          example: cn-hangzhou-i
        status:
          type: string
          description: 任务或资源当前状态
          example: ONLINE
        cpu:
          type: integer
          format: int32
          description: 处理器核数或规格信息。
          example: 4
        mem:
          type: integer
          format: int32
          description: 内存大小。
          example: 16
        diskSize:
          type: integer
          format: int32
          description: 磁盘大小
          example: 200
        unitCpu:
          type: integer
          format: int32
          description: Unit 处理器规格。
          example: 2
        unitMem:
          type: integer
          format: int32
          description: Unit 内存规格。
          example: 8
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        unitDiskSize:
          type: integer
          format: int32
          description: 单元磁盘大小
          example: 200
        vpcId:
          type: string
          description: VPC 标识。
          example: vpc-xxxxx
        deployType:
          type: string
          description: 部署类型
          example: multiple
        description:
          type: string
          description: 描述信息。
          example: 用于业务交易的租户
        tenantConnections:
          type: array
          description: 租户连接信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantConnectionDTO"
            description: 租户连接信息
          example:
            - addressStatus: ONLINE
              addressType: MASTER
              intranetAddress: 10.0.0.10
              intranetPort: 2881
              serviceType: PRIVATE
        tenantZones:
          type: array
          description: zone信息
          items:
            allOf:
              - $ref: "#/components/schemas/TenantZoneDTO"
            description: zone信息
          example:
            - replicaType: FULL
              status: ONLINE
              zone: cn-hangzhou-i
        tenantResource:
          allOf:
            - $ref: "#/components/schemas/TenantResourceDTO"
          description: 租户资源规格信息
        enableBinlogService:
          type: boolean
          description: 是否允许开通binlog服务
          example: true
        readonlyConnectionAddable:
          type: string
          description: "只读地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        readwriteConnectionAddable:
          type: string
          description: "读写分离地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        timeZone:
          type: string
          description: 租户设置的时区
          example: +08:00
        charset:
          type: string
          description: 租户设置的字符集
          example: utf8mb4
        collation:
          type: string
          description: 字符序排序规则。
          example: utf8mb4_general_ci
        lowerCaseTableNamesParam:
          type: integer
          format: int32
          description: 租户设置的表名大小写敏感
          example: 1
        parameterTemplate:
          type: string
          description: 参数模板
          example: oltp
        tagList:
          type: array
          description: 租户标签
          items:
            allOf:
              - $ref: "#/components/schemas/TagKeyValueDo"
            description: 租户标签
          example:
            - tagKey: env
              tagValue: prod
        tenantCompatibilityMode:
          type: string
          description: 租户兼容模式： TP集群，返回MySQL/Oracle KV集群，返回HBase/Table
          example: MYSQL
        dataMergeTime:
          type: string
          description: 租户合并时间(4.x集群才有)
          example: 02:00
        enableProxyPublicLink:
          type: boolean
          description: 是否开启公网
          example: false
        odpDefaultVersion:
          type: string
          description: 设置租户创建地址是默认的设置的 odpVersion
          example: 4.2.1
        enableProxyService:
          type: boolean
          description: 是否启用代理服务
          example: true
        globalAddressAddable:
          type: string
          description: "全局地址是否可建 ADDABLE, 可建 DISABLED, 不可新建 INVISIBLE, 不可见"
          example: ADDABLE
        enableStandbyReadWriteSplit:
          type: string
          description: 主备库读写分离开关状态
          example: ENABLED
        instanceZoneReplicas:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyReplicaDoV2"
            description: 实例可用区副本列表
          description: 实例可用区副本列表
          example:
            - copyId: 1
              logicZoneName: cn-hangzhou-i
              replicaType: FULL
              zone: cn-hangzhou-i
        zones:
          type: array
          items:
            allOf:
              - $ref: "#/components/schemas/TopologyZoneDoV2"
            description: 可用区列表，逗号分隔
          description: 可用区列表，逗号分隔
        tenantMaxConnections:
          type: integer
          format: int32
          description: 租户最大连接数
          example: 10000
        ragClusterDo:
          allOf:
            - $ref: "#/components/schemas/ObcloudRagClusterDo"
          description: RAG 集群详情。
        enableRag:
          type: boolean
          description: 是否启用RAG
          example: false
        iops:
          type: integer
          format: int32
          description: 存储每秒读写次数指标。
          example: 1000
      description: Tenant
    UnitCpuConstraint:
      type: object
      description: cpu和mem在unit下的创建约束
      properties:
        unitNum:
          type: integer
          format: int32
          description: Unit 数量。
          example: 1
        maxCpu:
          type: integer
          format: int32
          description: 最大cpu规格
          example: 4
        minCpu:
          type: integer
          format: int32
          description: 最小cpu规格
          example: 4
    UpdateTenantPlainAccessUsersRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        users:
          type: array
          description: 用户列表。
          items:
            type: string
            description: 用户列表。
            example: |-
              ---
              - "[{id=resource-123456}]"
          example:
            - "[{id=resource-123456}]"
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Update Tenant Plain Access Users
    UpdateTenantPlainAccessUsersResponseOpenAPI:
      type: object
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
      description: Update Tenant Plain Access Users
    UpdateTenantSensitiveRuleAuthRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        authorized:
          type: boolean
          description: 是否授权启用敏感字段保护相关能力
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Update Tenant Sensitive Rule Auth
    UpdateTenantSensitiveRuleAuthResponseOpenAPI:
      type: object
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
      description: Update Tenant Sensitive Rule Auth
    UpdateTenantSensitiveRuleEnabledRequest:
      type: object
      properties:
        instanceId:
          type: string
          description: OceanBase集群ID
          example: obcluster-*****
        tenantId:
          type: string
          description: 租户ID
          example: t4louaeei****
        ruleName:
          type: string
          description: 敏感字段保护规则名称
          example: pay_core
        enabled:
          type: boolean
          description: 规则是否启用（true=启用，false=禁用）
          example: true
        UID:
          type: string
          description: 用户 ID。
          example: "200006001999"
        User_ID:
          type: string
          description: 用户ID
          example: "200006001999"
        requestId:
          type: string
          description: 请求ID，用于追踪
          example: dc302d76-66b5-48d8-ab53-a035********
        callerType:
          type: string
          description: 调用者类型
          example: sub
        accessKeyId:
          type: string
          description: 访问密钥ID
          example: ak-xxxxxxxxxxxxxxxx
        securityToken:
          type: string
          description: 安全令牌
          example: sts-token-xxxxxxxx
        callerUid:
          type: string
          description: 调用者ID
          example: "200006001999"
        callerBid:
          type: string
          description: 调用者BID
          example: "26842"
        stsTokenCallerUid:
          type: string
          description: STS令牌调用者UID
          example: "200006001999"
        stsTokenCallerBid:
          type: string
          description: STS令牌调用者BID
          example: "26842"
        acceptLanguage:
          type: string
          description: 请求或响应使用的语言。
          example: zh-CN
        pageNumber:
          type: integer
          format: int32
          description: 分页页码
          example: 1
        pageSize:
          type: integer
          format: int32
          description: 分页大小
          example: 10
        mergedCallerBid:
          type: string
          description: 合并后的调用方业务身份 ID。
          example: "26842"
      description: Update Tenant Sensitive Rule Enabled
    UpdateTenantSensitiveRuleEnabledResponseOpenAPI:
      type: object
      properties:
        success:
          type: boolean
          description: 请求是否成功
          example: true
      description: Update Tenant Sensitive Rule Enabled
    Empty:
      title: Empty Schema
      type: object
      description: Empty
  parameters:
    InstanceId:
      name: instanceId
      in: path
      required: true
      schema:
        type: string
    PageNumber:
      name: pageNumber
      in: query
      required: false
      schema:
        type: integer
        format: int32
    PageSize:
      name: pageSize
      in: query
      required: false
      schema:
        type: integer
        format: int32
    RequestId:
      name: requestId
      in: query
      required: true
      schema:
        type: string
    TenantId:
      name: tenantId
      in: path
      required: true
      schema:
        type: string
  responses:
    BadRequest:
      description: 请求参数错误
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    Forbidden:
      description: 无权限访问该资源
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    InternalServerError:
      description: 服务端内部错误
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    NotFound:
      description: 资源不存在
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    TooManyRequests:
      description: 请求过于频繁
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
    Unauthorized:
      description: 认证失败或缺少认证信息
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ErrorResponse"
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API authentication credential
    api_key:
      type: apiKey
      name: x-api-key
      in: header
tags: []
security:
  - ApiKeyAuth: []