接口功能介绍
调用modifyBackupPolicy修改实例的备份策略。
接口约束
无
URI
POST /v1/openApi/modifyBackupPolicy
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
| nextbackuptime | *必填 | String | 下次备份时间点 | 2022-09-01 00:00:00 |
| backupunittime | *必填 | String | 每两次备份的时间间隔,以秒为单位 | 1 |
| backupinterval | *必填 | String | 单个周期内的总备份次数 | 1 |
| autoremove | *必填 | String | 自动保存份数 | 1 |
| backupOperation | *必填 | String | 是否开启自动备份操作 | 1 |
| env | *必填 | String | 运行环境 | cty |
| host | *必填 | String | 主机地址 | 127.0.0.1 |
| sshPort | *必填 | String | 机器端口 | 8888 |
| sshUser | *必填 | String | 机器用户 | root |
| password | *必填 | String | 加密后的机器登陆密码 | jr1odEulRRc//w== |
| backupDir | *必填 | String | 备份目录 | /data/mongodb |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 修改备份策略成功/失败 |
请求示例
请求头header
无
请求体body
{
"prodInstId":"a649077e15f349cb8b4cde6f7285a568",
"nextbackuptime":"2022-09-01 00:00:00",
"backupunittime":"1",
"backupinterval":"1",
"autoremove":"1",
"backupOperation":"1",
"env":"",
"host":"127.0.0.1",
"sshPort":"8888",
"sshUser":"root",
"password":"jr1odEulRRc//w==",
"backupDir":"/data/mongodb",
"env": "cty"
}
响应示例
{
"statusCode": 800,
"message": "修改MongoDB实例的备份策略成功",
"returnObj": null
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
