查询同区域高级备份策略 - ShowTaurusDbAdvancedBackupPolicy
功能介绍
查询实例自动备份策略,包括基础备份策略和稀疏备份策略。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v3/{project_id}/instances/{instance_id}/backups/advanced-policy
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 请求语言类型。 约束限制: 不涉及。 取值范围: 默认取值: en-us。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| begin_time | String | 参数解释: 备份时间段开始时间。 取值范围: 非空,格式必须为hh:mm且有效,当前时间指UTC时间。 |
| end_time | String | 参数解释: 备份时间段结束时间。 取值范围: 非空,格式必须为hh:mm且有效,当前时间指UTC时间。end_time必须大于begin_time。 |
| retention_num_backup_level1 | Integer | 参数解释: 一级备份保留数量。当一级备份开关开启时,返回此参数。 取值范围: 不涉及。 |
| policies | Array of BackupPolicy objects | 参数解释: 备份策略集。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| retention_days | Integer | 参数解释: 指定已生成的备份文件可以保存的天数。 取值范围: 1-732。 您也可以联系客服申请开通最大保留天数为3660。 |
| period | String | 参数解释: 备份周期配置。 取值范围: 格式必须为“日期 月份 星期”形式的Cron表达式,时区为UTC时区。 日期支持填写1~31、特殊字符*(表示任意值)、特殊字符L(表示最后一天)。填写1~31或L时支持填写多个,需以逗号隔开。 月份支持填写1~12、特殊字符*(表示任意值)。 星期支持填写1~7,需以逗号隔开。 |
| policy_type | String | 参数解释: 自动备份策略类型。 取值范围: |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误消息。 |
请求示例
查询实例的自动备份策略。
GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/backups/advanced-policy 响应示例
状态码:200
Success.
{
"begin_time" : "19:00",
"end_time" : "20:00",
"policies" : [ {
"period" : "* * 1,2,3,4,5",
"retention_days" : 7,
"policy_type" : "base"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Success. |
| 400 | Client error. |
| 500 | Server error. |
错误码
请参见错误码。