接口功能介绍
查询RDS实例跨地域备份设置。
接口约束
无
URI
GET /v1/open-api/describe-cross-backup-policy
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 主机实例id | 3 | |
regionId | 是 | String | 区域ID,目前默认只能为false,其他不支持 | false |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
returnObj | 否 | Object | 返回对象 | returnObj | |
message | 否 | String | 结果信息 | success |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
sshPort | 是 | String | Ssh登录的端口 | 1435 | |
storePassword | 是 | String | 机器密码 | ****** | |
backupOperation | 是 | Integer | 是否开启自动备份操作,1代表开启,0不开启 | 0 | |
nextbackuptime | 是 | Date | 下次备份的时间 | 1652716803000 | |
backupunittime | 是 | Date | 备份时间间隔 | 86400 | |
prodType | 是 | Integer | 0: 单实例, 1:一主一从, 2:一主两从, 3:一主三从 | 0 | |
userId | 是 | Long | 用户id | 3200 | |
backupinterval | 是 | Integer | 单个周期内的总备份次数 | 1 | |
storePath | 是 | String | 备份路径 | /data | |
autoremove | 是 | Integer | 表示定期删除多少天前的备份文件 | 7 | |
firstbackuptime | 是 | Date | 首次开始备份的时间 | 1652716803000 | |
storeUser | 是 | String | 备份机用户 | teledb | |
storeIp | 是 | String | 备份机ip | 192.168.11.1 | |
prodInstId | 是 | Integer | 内部实例id | 1 |
请求示例
请求头header参数
无
请求体body参数
无
响应示例
{
"statusCode":0,
"message":"success",
"returnObj":{
"sshPort":"1435",
"storePassword":"******",
"backupOperation":0,
"nextbackuptime":1652716803000,
"backupunittime":86400,
"prodType":1,
"userId":3268,
"backupinterval":1,
"storePath":"/data",
"autoremove":7,
"firstbackuptime":1652716803000,
"storeUser":"teledb",
"storeIp":"10.10.10.123",
"prodInstId":60
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |