接口功能介绍
调用DescribeBackupPolicy接口查询MongoDB实例的备份策略。
接口约束
无
URI
GET /v1/openApi/describeBackupPolicy
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX信息成功 | |
| returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| sshPort | 是 | String | 机器登录端口 | 8888 | |
| storePassword | 是 | String | 机器登录密码 | 123456 | |
| backupOperation | 是 | Integer | 是否开启自动备份操作 | 1 | |
| nextbackuptime | 是 | String | 下次备份的时间 | 2022-10-10 00:00:00 | |
| backupunittime | 是 | Integer | 每两次备份的时间间隔,以秒为单位 | 1 | |
| userId | 是 | Integer | 用户id | 149 | |
| backupinterval | 是 | Integer | 单个周期内的总备份次数，废弃字段 | 1 | |
| storePath | 是 | String | 备份数据存放目录 | /data/mongodb/test | |
| autoremove | 是 | Integer | 备份文件的删除策略，表示保留最近的多少份文件 | 1 | |
| firstbackuptime | 是 | String | 首次开始备份的时间，废弃字段 | ||
| storeUser | 是 | String | 机器登录用户 | root | |
| storeIp | 是 | String | 备份数据存放的机器 | 172.27.176.109 | |
| prodInstId | 是 | String | 实例id | c46d8f547cc648a78a68270092e70f80 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeBackupPolicy?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例的备份策略成功",
"returnObj": {
"sshPort": "22",
"storePassword": "",
"backupOperation": 0,
"nextbackuptime": 1659061641000,
"backupunittime": 43200,
"userId": 149,
"backupinterval": 0,
"storePath": "/data/apps",
"autoremove": 1,
"firstbackuptime": 1658975284000,
"storeUser": "root",
"storeIp": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
