修改实例备份策略v2
更新时间 2025-11-05 10:44:04
最近更新时间: 2025-11-05 10:44:04
接口功能介绍
修改文档数据库实例的备份策略
接口约束
用户通过鉴权认证；
URI
POST /DDS2/v2/openApi/modifyBackupPolicy
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394************************* | |
| backupRetentionDays | 是 | String | 备份数据保留天数 | 3 | |
| backupOperation | 是 | String | 是否开启自动全量备份操作 | 0或1 | |
| backupIncrement | 否 | String | 是否开启自动增量备份操作，前提是已开启自动全量备份操作。 | 0或1 | |
| backupCycleDays | 是 | String | 备份周期 | 默认1,2,3,4,5,6,7，表示周一至周日备份 | |
| backupStartTime | 是 | String | 备份开始时间 | 00:00 时间格式为：HH:mm |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围：800为成功，900为失败 | 800 | |
| message | String | 响应信息 | 修改备份策略成功/失败 | |
| returnObj | Object | 返回对象 | ||
| error | String | 错误码。当接口失败时才返回具体错误编码，成功不返回或者为空。 |
枚举参数
无
请求示例
请求url
无
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
{
"prodInstId": "3faab2dd01ec45448329871df550e0cf",
"backupRetentionDays": "3",
"backupOperation": 1,
"backupIncrement": 0,
"backupCycleDays": "1,3,6,7",
"backupStartTime": "00:00"
}
响应示例
{
"statusCode": 800,
"message": "修改MongoDB实例的备份策略成功",
"returnObj": {}
}
状态码
请参考 状态码
错误码
请参考 错误码
