设置自动备份策略
功能介绍
设置自动备份策略。
调试
您可以在API Explorer中调试该接口。
URI
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
project_id |
是 |
string |
path |
参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
string |
path |
参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
名称 |
是否必选 |
类型 |
IN |
描述 |
|---|---|---|---|---|
|
X-Auth-Token |
是 |
string |
header |
参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
名称 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
backup_policy |
是 |
Object |
参数解释： 备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表4。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
名称 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
keep_days |
否 |
String |
参数解释： 指定已生成的备份文件可以保存的天数。 约束限制： keep_days或enable_incremental_backup至少传其中一个参数。 取值范围： 0～732。取0值，表示关闭备份策略，包括自动备份策略和增量备份策略。 默认取值： 不涉及。 |
|
start_time |
否 |
String |
参数解释： 备份时间段。自动备份将在该时间段内触发。 约束限制： 开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围： 格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。
取值示例： 23:00-00:00 默认取值： 不涉及。 |
|
period |
否 |
String |
参数解释： 备份周期配置。自动备份将在每星期指定的天进行。 约束限制：
取值范围： 格式为半角逗号隔开的数字，数字代表星期。 默认取值： 不涉及。 |
|
enable_incremental_backup |
否 |
Boolean |
参数解释： 增量备份开关。不传这个参数则不对增备状态进行改动。开启增量备份后，系统会自动进行增量备份。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
响应参数
无。
请求示例
- 开启或修改自动备份策略，并开启增量备份策略：
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : true } } - 开启或修改自动备份策略，并关闭增量备份策略
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7", "enable_incremental_backup" : false } } - 仅开启或修改自动备份策略，增量备份策略状态保持不变
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 9, "start_time" : "08:15-09:15", "period" : "1,4,5,6,7" } } - 开启增量备份策略，需要在有自动全备策略情况下才能下发，关闭增量备份策略同理
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "enable_incremental_backup" : true } } - 关闭备份策略，包括自动备份策略和增量备份策略
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 0 } }
响应示例
无。
SDK
单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
