{
  "name": "dbs",
  "display_name": "数据库备份服务",
  "description": "用户可以使用本文档介绍的 API 对数据库备份服务进行相关操作，如创建数据库备份计划、下载备份日志、恢复备份日志到新实例等，请确保在使用这些接口前，已充分了解数据库备份服务的产品功能、特性及收费方式",
  "domain": "other",
  "api_version": "2021-11-08",
  "endpoint": "dbs.tencentcloudapi.com",
  "actions": [
    {
      "name": "ConfigureBackupPlan",
      "description": "本接口（ConfigureBackupPlan）用于配置备份计划。包括配置备份源实例信息、备份对象以及备份策略等。",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPlanId",
          "type": "string",
          "required": true,
          "description": "备份计划 ID。",
          "example": "dbs-xxxxxxxx"
        },
        {
          "name": "BackupPlanName",
          "type": "string",
          "required": false,
          "description": "备份计划名称。支持数字、英文大小写字母、中文以及特殊字符_-./()（）[]+=：:@,且长度不能超过60。",
          "example": "name-xxxxx"
        },
        {
          "name": "UpperParallel",
          "type": "integer",
          "required": false,
          "description": "全量备份并发数上限。",
          "example": "6"
        },
        {
          "name": "SourceEndPoint",
          "type": "object",
          "required": false,
          "description": "备份源实例信息。",
          "example": "无",
          "children": [
            {
              "name": "DatabaseType",
              "type": "string",
              "required": true,
              "description": "数据库类型。目前支持的值[\"mysql\", \"mariadb\", \"percona\"]。注意，该值必须和备份计划的类型一致。",
              "example": "mysql"
            },
            {
              "name": "AccessType",
              "type": "string",
              "required": true,
              "description": "实例接入类型，支持的值包括： \"extranet\" - 外网; \"cvm\" - cvm自建实例; \"dcg\" - 专线接入; \"vpncloud\" - 云vpn接入; \"cdb\" - 腾讯云数据库实例; \"ccn\" - 云联网接入。",
              "example": "cdb"
            },
            {
              "name": "UserName",
              "type": "string",
              "required": true,
              "description": "用户名。",
              "example": "user_test"
            },
            {
              "name": "Password",
              "type": "string",
              "required": true,
              "description": "登录密码。",
              "example": "user_paawd"
            },
            {
              "name": "Region",
              "type": "string",
              "required": true,
              "description": "接入地域。",
              "example": "ap-guangzhou"
            },
            {
              "name": "Supplier",
              "type": "string",
              "required": true,
              "description": "服务提供商，支持的值包括[\"aliyun\", \"aws\", \"others\"]。",
              "example": "others"
            },
            {
              "name": "Ip",
              "type": "string",
              "required": false,
              "description": "实例 Ip。",
              "example": "127.0.0.1"
            },
            {
              "name": "Port",
              "type": "integer",
              "required": false,
              "description": "实例端口号。",
              "example": "3306"
            },
            {
              "name": "InstanceId",
              "type": "string",
              "required": false,
              "description": "云数据库实例ID，格式如：cdb-qcloudtest。",
              "example": "cdb-xxxxxxxx"
            },
            {
              "name": "CvmInstanceId",
              "type": "string",
              "required": false,
              "description": "CVM 实例ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要填写该字段。",
              "example": "ins-xxxxxxxx"
            },
            {
              "name": "UniqDcgId",
              "type": "string",
              "required": false,
              "description": "专线网关ID，格式如：dcg-0rxtqqxb。",
              "example": "dcg-xxxxxxxx"
            },
            {
              "name": "UniqVpnGwId",
              "type": "string",
              "required": false,
              "description": "VPN网关ID，格式如：vpngw-9ghexg7q。",
              "example": "vpngw-xxxxxxx"
            },
            {
              "name": "VpcId",
              "type": "string",
              "required": false,
              "description": "私有网络ID，格式如：vpc-92jblxto。",
              "example": "vpc-xxxxxxxx"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "子网ID，格式如：subnet-3paxmkdz。",
              "example": "subnet-xxxxxxxx"
            },
            {
              "name": "CcnId",
              "type": "string",
              "required": false,
              "description": "云联网ID，如：ccn-afp6kltc。",
              "example": "ccn-xxxxxxxx"
            },
            {
              "name": "EngineVersion",
              "type": "string",
              "required": false,
              "description": "数据库版本，当实例为 RDS 或 AWS 实例时才有效，格式如：5.6或者5.7，默认为5.6。",
              "example": "5.6"
            },
            {
              "name": "DBKernel",
              "type": "string",
              "required": false,
              "description": "mariadb三引擎版本。",
              "example": "mariadb"
            }
          ]
        },
        {
          "name": "BackupObject",
          "type": "object",
          "required": false,
          "description": "备份对象信息。",
          "example": "无",
          "children": [
            {
              "name": "ObjectMode",
              "type": "string",
              "required": true,
              "description": "备份对象类型，可能的取值为: \"all\" - 整实例; \"partial\" - 部分对象。",
              "example": "all"
            },
            {
              "name": "ObjectItems",
              "type": "array",
              "required": false,
              "description": "备份对象详情，当 ObjectMode 为 partial, 即选择部分对象备份时，该字段不能为空。 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "DBName",
                  "type": "string",
                  "required": false,
                  "description": "库名。",
                  "example": "db1"
                },
                {
                  "name": "NewDBName",
                  "type": "string",
                  "required": false,
                  "description": "重命名后的库名。",
                  "example": "new_db1"
                },
                {
                  "name": "SchemaName",
                  "type": "string",
                  "required": false,
                  "description": "schema 名。",
                  "example": "schema1"
                },
                {
                  "name": "NewSchemaName",
                  "type": "string",
                  "required": false,
                  "description": "重命名后的 schema 名。",
                  "example": "new_schema1"
                },
                {
                  "name": "DbMode",
                  "type": "string",
                  "required": false,
                  "description": "库选择模式，可能的取值为： \"all\" - 当前对象下的所有对象; \"partial\" - 当前对象下的部分对象。",
                  "example": "all"
                },
                {
                  "name": "TableMode",
                  "type": "string",
                  "required": false,
                  "description": "表选择模式，可能的取值为: \"all\" - 当前对象下的所有对象; \"partial\" - 当前对象下的部分对象。",
                  "example": "all"
                },
                {
                  "name": "Tables",
                  "type": "array",
                  "required": false,
                  "description": "表对象详情。当 TableMode 为 partial，即选择部分表备份时，此参数需要填写。 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "无",
                  "item_type": "object",
                  "children": [
                    {
                      "name": "TableName",
                      "type": "string",
                      "required": false,
                      "description": "表名。",
                      "example": "t1"
                    },
                    {
                      "name": "NewTableName",
                      "type": "string",
                      "required": false,
                      "description": "重命名后的表名。",
                      "example": "new_t1"
                    },
                    {
                      "name": "Columns",
                      "type": "array",
                      "required": false,
                      "description": "列对象。 注意：此字段可能返回 null，表示取不到有效值。",
                      "example": "无",
                      "item_type": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "name": "BackupStrategy",
          "type": "object",
          "required": false,
          "description": "备份策略。",
          "example": "无",
          "children": [
            {
              "name": "BackupStartTime",
              "type": "string",
              "required": true,
              "description": "全量备份开始时间。周期性的全量备份将在当天该时间开始。",
              "example": "02:00"
            },
            {
              "name": "StorageStrategy",
              "type": "object",
              "required": true,
              "description": "存储策略。",
              "example": "无",
              "children": [
                {
                  "name": "StorageType",
                  "type": "string",
                  "required": false,
                  "description": "存储类型。目前仅支持 \"system\" - DBS 内置存储。默认值为 \"system\"。",
                  "example": "system"
                },
                {
                  "name": "Encryption",
                  "type": "string",
                  "required": false,
                  "description": "加密方式。可能的取值为： \"UnEncrypted\" - 非加密存储; \"SSE-COS\" - 内置加密存储; 当该参数用作入参时，默认值为 \"UnEncrypted\"。",
                  "example": "SSE-COS"
                },
                {
                  "name": "BackupRetentionPeriod",
                  "type": "integer",
                  "required": false,
                  "description": "日志保留时间，单位为天。取值范围为[7, 3650]，默认值为 30。",
                  "example": "30"
                }
              ]
            },
            {
              "name": "BackupPeriod",
              "type": "object",
              "required": true,
              "description": "备份周期。",
              "example": "无",
              "children": [
                {
                  "name": "PeriodType",
                  "type": "string",
                  "required": true,
                  "description": "全量备份频率。目前仅支持\"Weekly\" - 每星期",
                  "example": "Weekly"
                },
                {
                  "name": "Day",
                  "type": "array",
                  "required": true,
                  "description": "全量备份周期。取值范围为：[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\",\"Sunday\"]。",
                  "example": "[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "BackupMethod",
              "type": "string",
              "required": false,
              "description": "备份方法。目前仅支持 \"logical\" - 逻辑备份。",
              "example": "logical"
            },
            {
              "name": "StrategyType",
              "type": "string",
              "required": false,
              "description": "备份周期。支持的值包括： \"period\" - 周期性备份； \"single\" - 单次备份。 默认值为\"period\"。",
              "example": "period"
            },
            {
              "name": "EnableIncrement",
              "type": "boolean",
              "required": false,
              "description": "是否开启增量备份。可能的取值为[\"true\", \"false\"]。默认值为\"true\"。",
              "example": "true"
            }
          ]
        },
        {
          "name": "PlainText",
          "type": "string",
          "required": false,
          "description": "加密信息。当需要使用SSE-KMS需要传入该值，你可以通过 KMS 的 GenerateDataKey 接口生成。",
          "example": "q+EouJ/tGeiZIo9/tIl2baxQOBFxcN0PNn7F6EIEvp"
        }
      ],
      "required": [
        "BackupPlanId"
      ]
    },
    {
      "name": "CreateBackupPlan",
      "description": "该接口用于创建备份计划。",
      "status": "online",
      "parameters": [
        {
          "name": "DatabaseType",
          "type": "string",
          "required": true,
          "description": "源端数据库类型。当前支持值为: [\"mysql\",\"cynosdbmysql\",\"percona\",\"mariadb\",\"tdsqlmysql\"]。",
          "example": "mysql"
        },
        {
          "name": "BackupMethod",
          "type": "string",
          "required": false,
          "description": "备份方式。当前仅支持\"logical\"，即逻辑备份。",
          "example": "logical"
        },
        {
          "name": "InstanceClass",
          "type": "string",
          "required": false,
          "description": "规格。当前支持值为: [\"micro\",\"small\",\"medium\",\"large\",\"xlarge\"]。默认为\"small\"。",
          "example": "large"
        },
        {
          "name": "Period",
          "type": "integer",
          "required": false,
          "description": "购买时长，单位为月，默认值为1。",
          "example": "3"
        },
        {
          "name": "PayType",
          "type": "string",
          "required": false,
          "description": "计费模式。当前仅支持\"prepay\"，即包年包月。",
          "example": "prepay"
        },
        {
          "name": "Count",
          "type": "integer",
          "required": false,
          "description": "购买数量。取值范围为[1, 10]，默认值为1。",
          "example": "1"
        },
        {
          "name": "AutoRenew",
          "type": "integer",
          "required": false,
          "description": "自动续费标识。1 - 开启自动续费；0 - 不开启自动续费。",
          "example": "1"
        },
        {
          "name": "Tags",
          "type": "array",
          "required": false,
          "description": "标签值。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键。",
              "example": "key"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "标签值。",
              "example": "value"
            }
          ]
        }
      ],
      "required": [
        "DatabaseType"
      ]
    },
    {
      "name": "CreateConnectTestJob",
      "description": "该接口用于创建连通性检测任务，请在创建备份计划前，通过该接口来检测你的源端实例是否连通性正常。",
      "status": "online",
      "parameters": [
        {
          "name": "Endpoint",
          "type": "object",
          "required": false,
          "description": "备份源实例信息。",
          "example": "无",
          "children": [
            {
              "name": "DatabaseType",
              "type": "string",
              "required": true,
              "description": "数据库类型。目前支持的值[\"mysql\", \"mariadb\", \"percona\"]。注意，该值必须和备份计划的类型一致。",
              "example": "mysql"
            },
            {
              "name": "AccessType",
              "type": "string",
              "required": true,
              "description": "实例接入类型，支持的值包括： \"extranet\" - 外网; \"cvm\" - cvm自建实例; \"dcg\" - 专线接入; \"vpncloud\" - 云vpn接入; \"cdb\" - 腾讯云数据库实例; \"ccn\" - 云联网接入。",
              "example": "cdb"
            },
            {
              "name": "UserName",
              "type": "string",
              "required": true,
              "description": "用户名。",
              "example": "user_test"
            },
            {
              "name": "Password",
              "type": "string",
              "required": true,
              "description": "登录密码。",
              "example": "user_paawd"
            },
            {
              "name": "Region",
              "type": "string",
              "required": true,
              "description": "接入地域。",
              "example": "ap-guangzhou"
            },
            {
              "name": "Supplier",
              "type": "string",
              "required": true,
              "description": "服务提供商，支持的值包括[\"aliyun\", \"aws\", \"others\"]。",
              "example": "others"
            },
            {
              "name": "Ip",
              "type": "string",
              "required": false,
              "description": "实例 Ip。",
              "example": "127.0.0.1"
            },
            {
              "name": "Port",
              "type": "integer",
              "required": false,
              "description": "实例端口号。",
              "example": "3306"
            },
            {
              "name": "InstanceId",
              "type": "string",
              "required": false,
              "description": "云数据库实例ID，格式如：cdb-qcloudtest。",
              "example": "cdb-xxxxxxxx"
            },
            {
              "name": "CvmInstanceId",
              "type": "string",
              "required": false,
              "description": "CVM 实例ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要填写该字段。",
              "example": "ins-xxxxxxxx"
            },
            {
              "name": "UniqDcgId",
              "type": "string",
              "required": false,
              "description": "专线网关ID，格式如：dcg-0rxtqqxb。",
              "example": "dcg-xxxxxxxx"
            },
            {
              "name": "UniqVpnGwId",
              "type": "string",
              "required": false,
              "description": "VPN网关ID，格式如：vpngw-9ghexg7q。",
              "example": "vpngw-xxxxxxx"
            },
            {
              "name": "VpcId",
              "type": "string",
              "required": false,
              "description": "私有网络ID，格式如：vpc-92jblxto。",
              "example": "vpc-xxxxxxxx"
            },
            {
              "name": "SubnetId",
              "type": "string",
              "required": false,
              "description": "子网ID，格式如：subnet-3paxmkdz。",
              "example": "subnet-xxxxxxxx"
            },
            {
              "name": "CcnId",
              "type": "string",
              "required": false,
              "description": "云联网ID，如：ccn-afp6kltc。",
              "example": "ccn-xxxxxxxx"
            },
            {
              "name": "EngineVersion",
              "type": "string",
              "required": false,
              "description": "数据库版本，当实例为 RDS 或 AWS 实例时才有效，格式如：5.6或者5.7，默认为5.6。",
              "example": "5.6"
            },
            {
              "name": "DBKernel",
              "type": "string",
              "required": false,
              "description": "mariadb三引擎版本。",
              "example": "mariadb"
            }
          ]
        }
      ],
      "required": []
    },
    {
      "name": "DescribeBackupCheckJob",
      "description": "本接口（DescribeBackupCheckJob）用于查询备份计划预校验任务的结果。仅对于预校验通过的任务，才能启动备份计划。",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPlanId",
          "type": "string",
          "required": true,
          "description": "备份计划 ID。",
          "example": "dbs-xxxxxxxx"
        }
      ],
      "required": [
        "BackupPlanId"
      ]
    },
    {
      "name": "DescribeBackupPlans",
      "description": "本接口（DescribeBackupPlans）用于查询备份计划列表。",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPlanId",
          "type": "string",
          "required": false,
          "description": "过滤条件，备份计划 ID。",
          "example": "dbs-xxxxxxxx"
        },
        {
          "name": "Status",
          "type": "array",
          "required": false,
          "description": "过滤条件，备份计划状态。",
          "example": "[\"checkPass\", \"running\"]",
          "item_type": "string"
        },
        {
          "name": "DatabaseType",
          "type": "array",
          "required": false,
          "description": "过滤条件，数据库类型。",
          "example": "[\"mysql\",\"mariadb\"]",
          "item_type": "string"
        },
        {
          "name": "AccessType",
          "type": "array",
          "required": false,
          "description": "过滤条件，接入访问类型。",
          "example": "[\"ccn\",\"cdb\"]",
          "item_type": "string"
        },
        {
          "name": "BackupPlanName",
          "type": "string",
          "required": false,
          "description": "过滤条件，备份计划名称。",
          "example": "name_test"
        },
        {
          "name": "TagFilters",
          "type": "array",
          "required": false,
          "description": "过滤条件，标签键值。",
          "example": "{\"TagKey\":\"key\",\"TagValue\":[\"v1\", \"v2\"]}",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "标签键。",
              "example": "key"
            },
            {
              "name": "TagValue",
              "type": "array",
              "required": true,
              "description": "标签值。",
              "example": "[\"v1\",\"v2\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页参数。取值范围为(0, 100]，默认值为20。",
          "example": "20"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页参数。默认值为0。",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeConnectTestResult",
      "description": "该接口用于查询连通性检测任务的结果",
      "status": "online",
      "parameters": [
        {
          "name": "TaskIds",
          "type": "array",
          "required": false,
          "description": "连通性检测任务 ID。",
          "example": "[123]",
          "item_type": "integer"
        }
      ],
      "required": []
    },
    {
      "name": "StartBackupCheckJob",
      "description": "本接口（StartBackupCheckJob）用于创建备份计划预校验任务。",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPlanId",
          "type": "string",
          "required": true,
          "description": "备份计划 ID。",
          "example": "dbs-xxxxxxxx"
        }
      ],
      "required": [
        "BackupPlanId"
      ]
    },
    {
      "name": "StartBackupPlan",
      "description": "本接口（StartBackupPlan）用于启动备份计划。调用此接口前，请务必先使用 StartBackupCheckJob 创建备份计划预校验任务，并通过 DescribeBackupCheckJob 接口查询到任务状态为校验通过时，才能启动备份计划。",
      "status": "online",
      "parameters": [
        {
          "name": "BackupPlanId",
          "type": "string",
          "required": true,
          "description": "备份计划 ID。",
          "example": "dbs-xxxxxxxx"
        }
      ],
      "required": [
        "BackupPlanId"
      ]
    }
  ]
}