cloudpods/docs/schemas/dbinstance.yaml

DBInstance:
  allOf:
    - $ref: "./common.yaml#/VirtualResourceBaseResponse"
    - $ref: "./common.yaml#/BillingResourceBaseResponse"
    - $ref: "./common.yaml#/ManagedResourceBaseResponse"
    - $ref: "./common.yaml#/CloudregionResourceBaseResponse"
    - $ref: "./common.yaml#/ZoneResourceBaseResponse"
    - $ref: "./common.yaml#/ExternalizedResourceBaseResponse"
    - type: object
      description: RDS实例
      properties:
        disk_size_gb:
          type: integer
          example: 20
          description: RDS实例存储大小
        storage_type:
          type: string
          example: cloud_essd
          description: RDS实例存储类型
        engine:
          type: string
          example: MySQL
          description: RDS实例引擎
          readOnly: true
        engine_version:
          type: string
          example: "5.7"
          description: RDS实例引擎版本
        instance_type:
          type: string
          example: mysql.n1.micro.1
          description: RDS实例规格
        category:
          type: string
          example: basic
          description: RDS实例高可用类型
        port:
          type: integer
          example: 3306
          description: RDS实例连接端口
        vcpu_count:
          type: integer
          example: 1
          description: RDS实例CPU核数
        vmem_size_mb:
          type: integer
          example: 1024
          description: RDS实例内存大小
        vpc_id:
          type: string
          example: 5d0a3589-4ec5-4509-8e53-6505457577b0
          description: RDS实例VPC ID
        vpc:
          type: string
          example: vpc-2zecuo9v4idebme295ofy
          description: RDS实例VPC ID
        disable_delete:
          type: boolean 
          example: true 
          description: 是否锁定(删除保护)
        connection_str:
          type: string 
          example: rm-2zeyj104t2b0c2270mo.mysql.rds.aliyuncs.com 
          description: 外网连接地址
        internal_connection_str:
          type: string 
          example: fsdghello.mysql.rds.aliyuncs.com
          description: 内网连接地址
        secgroup_id:
          type: string 
          example: 318e8b0e-c392-4ac2-8562-40303f79a5c9
          description: 安全组id
        secgroup:
          type: string 
          example: Default 
          description: 安全组名称
        iops:
          type: integer 
          example: 500 
          description: IOPS大小

DBInstanceListResponse:
  type: object
  properties:
    limit: 
      type: integer
      example: 20
    dbinstances:
      type: array
      items:
        $ref: '#/DBInstance'
    total:
      type: integer
      example: 124

DBInstanceResponse:
  type: object
  properties:
    dbinstance:
      type: object
      $ref: '#/DBInstance'


DBInstanceCreate:
  type: object
  properties:
    zone1:
      type: string 
      example: test-zone 
      description: 可用区1名称或ID
    zone2:
      type: string 
      example: test-zone 
      description: 可用区2名称或ID
    zone3:
      type: string 
      example: test-zone 
      description: 可用区3名称或ID
    network:
      type: string
      example: test-network
      required: true
      description: IP子网ID或名称
    address:
      type: string
      example: 10.12.2.12
      description: 内网IP,需要在network网段内
    vcpu_count:
      type: integer 
      example: 1
      description: RDS实例CPU核数 
    vmem_size_mb:
      type: integer 
      example: 2
      description: RDS实例内存大小 
    storage_type:
      type: string 
      required: true
      example: cloud_ssd 
      enum: [local_ssd, cloud_essd, cloud_ssd]
      description: RDS实例存储类型
    disk_size_gb:
      type: integer 
      required: true
      example: 30 
      description: RDS实例存储大小
    port:
      type: integer 
      example: 3306
      description: RDS实例连接端口
    category:
      type: string 
      example: basic 
      enum: [basic, high_availability, always_on, finance, single, replica]
      description: RDS实例类别(单机、高可用、只读)
    engine:
      type: string 
      example: MySQL
      description: RDS实例引擎
    engine_version:
      type: string 
      example: 8.0
      description: RDS实例引擎版本
    instance_type:
      type: string 
      example: mysql.n4.large.1 
      description: RDS实例规格,若不指定CPU及内存，此参数必填
    duration:
      type: string 
      example: 1m
      description: 包年包月时长
    master_instance:
      type: string 
      example: test-master-instance 
      description: 主RDS实例名称或ID,创建只读实例时需要指定
    secgroup:
      type: string 
      example: test-secgroup 
      description: 安全组名称或ID
    password:
      type: string 
      example: bsnt{Hz{Z3p6
      description: 密码信息 
    description: 
      type: string 
      example: test-description 
      description: 描述信息
    disable_delete:
      type: boolean 
      example: true 
      default: true
      description: 是否锁定(删除保护)


DBInstanceChangeConfig:
  type: object
  properties:
    instance_type:
      type: string
      example: mssql.x4.8xlarge.e2
      description: 更换RDS实例规格
    vcpu_count:
      type: integer
      example: 6
      description: 更改CPU大小
    vmem_size_mb:
      type: integer
      example: 1024
      description: 更改内存大小
    storage_type:
      type: string 
      example: local_ssd 
      description: 存储类型 
    disk_size_gb:
      type: integer 
      example: 40
      description: 存储磁盘大小
    category:
      type: string 
      example: high_availability 
      description: 更改实例类型

DBInstancePublicConnection:
  type: object
  properties:
    open:
      type: boolean
      example: true
      default: true
      description: 关闭或打开外网地址

DBInstanceRecovery:
  type: object
  properties:
    databases:
      type: object
      additionalProperties:
        type: string 
        example: 
          source-database1: dest-database1
          source-database2: dest-database2
        description: 源数据库名称->目的数据库名称
      description: 数据库列表,为空代表恢复整个备份内容,databases源数据库内容可以从backup的dbnames中获取,目的数据库不可与目标rds实例数据库重复
    dbinstancebackup:
      type: string 
      example: test-backup
      required: true
      description: 实例备份名称或ID