查询自动备份策略
功能介绍
查询自动备份策略。
调试
您可以在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 |
是 |
Integer |
参数解释: 备份文件可以保存的天数。 取值范围: 不涉及。 |
start_time |
否 |
String |
参数解释: 备份时间段。自动备份将在该时间段内触发。 取值范围: 不涉及。 |
period |
否 |
String |
参数解释: 备份周期配置。自动备份将在每星期指定的天进行。 取值范围: 不涉及。 |
enable_incremental_backup |
否 |
Boolean |
参数解释: 是否开启增量备份。 取值范围:
|
请求示例
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : true } }
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : false } }
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy { "backup_policy" : { "keep_days" : 0 } }
响应示例
状态码: 200
Success.
{ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6", "enable_incremental_backup" : true } }
SDK
单击文档数据库服务 DDS SDK,下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
状态码
详情请参见状态码。
错误码
详情请参见错误码。