全部产品
云市场

配置备份计划

更新时间:2019-09-03 15:00:58

描述

配置一个DBS备份计划。

创建备份计划(CreateBackupPlan)接口调用后,DBS实例会开始生产,一般需要等待5s,才能调用配置备份计划(ConfigureBackupPlan)接口。

请求参数

名称 类型 是否必选 描述
Action String 系统规定参数,取值:ConfigureBackupPlan
BackupPlanId String 备份计划ID
SourceEndpointInstanceType String 数据库所在位置,取值:
  • rds
  • ecs
  • express:通过专线/VPN网关/智能网关接入的数据库
  • agent:通过备份网关接入的数据库
  • dds:云MongoDB
  • other:通过IP:Port直连的数据库
SourceEndpointRegion String 数据库地域,SourceEndpoint.InstanceType为RDS、ECS、DDS、Express、Agent时,该参数必传
SourceEndpointInstanceID String 数据库实例ID,SourceEndpoint.InstanceType为RDS、ECS、DDS、Express时,该参数必传
SourceEndpointIP String 数据库连接地址,SourceEndpoint.InstanceType为express、agent、other,该参数必传
SourceEndpointPort Integer 数据库端口,SourceEndpoint.InstanceType为express、agent、other、ECS,该参数必传
SourceEndpointDatabaseName String 数据库名称,数据库类型为PostgreSQL、MongoDB时,该参数必传;数据库所在位置为agent且数据库类型为MSSQL时,该参数必传
SourceEndpointUserName String 数据库账号,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传
SourceEndpointPassword String 密码,数据库类型为Redis,或者数据库所在位置为agent且数据库类型为MSSQL时该参数非必须,其他场景均必传
BackupGatewayId Long 备份网关ID,SourceEndpoint.InstanceType为agent时,该参数必传
OSSBucketName String OSS Bucket名称,默认:系统自动生成新的名称
BackupObjects String 备份对象,详见下面的BackupObjects参数定义,当数据库所在位置为agent时,该参数非必须,其他场景均必传
BackupPeriod String 全量备份周期,取值:
  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
BackupStartTime String 全量备份开始时间,取值:格式:HH:mm,例如:14:22
EnableBackupLog Boolean 是否开启增量日志备份,取值:
  • True:开启
  • False:关闭
BackupRetentionPeriod Integer 备份数据保留时间,取值:0-1825,默认为730
DuplicationInfrequentAccessPeriod Integer 转为低频访问存储时间,默认为180
DuplicationArchivePeriod Integer 转为归档冷备存储时间,默认为365
BackupPlanName String 备份计划名称
SourceEndpointOracleSID String Oracle SID名称,数据库类型为Oracle时,该参数必传

BackupObjects 参数定义

BackupObjects 的定义格式为 JSON 字符串,且对象配置支持一定的正则表达式。

BackupObjects 的定义如下:

  1. [
  2. {
  3. "DBName":"待备份库名",
  4. "SchemaName":"待备份 Schema 名",
  5. "TableIncludes":[{
  6. "TableName":"待备份表表名"
  7. }],
  8. "TableExcludes":[{
  9. "TableName":"待备份库名不需要备份表的表名"
  10. }]
  11. }
  12. ]

其中:SchemaName 和 NewSchemaName 只用于 MSSQL,其他数据库的库名定义使用 DBName 和 NewDBName 这个参数。

当用户只配置了 DBName,不配置其他子对象的规则,那么表示迁移这个数据库下面的所有对象。

当用户配置了 DBName,且配置了部分对象的规则,那么不配置的对象默认不迁移。各种对象名的定义可以支持如下的正则表达式:

  • 点号 . 表示匹配除 ‘\r\n’ 之外的任何单个字符
  • 星号 表示匹配前面子表达式任意次,h.llo 匹配 hllo, heeeello 等字符串
  • 问号 ? 表示匹配前面子表达式零次或1次,h.?llo 匹配 hllo,hello,但不能匹配 haello
  • [characters] 字符集合,表示匹配方括号内任意一个字符,例如 h[aello] 匹配 hallo, hello
  • [^characters] 负值字符集合,表示不匹配方括号内任意一个字符,例如 h[^ae]llo 匹配 hcllo,hdllo,但是不能匹配 hallo,hello
  • [character1-character2] 字符范围,表示 character1-character2 范围内的字符都可以匹配,例如 [0-9],[a-z]

返回参数

名称 类型 描述
BackupPlanId String 备份计划ID

错误码

错误码 错误信息 描述
BackupPlanNotConfigure Backup Plan not Configure. 无法配置备份计划