
# 查询自动备份策略
#### 功能介绍
查询自动备份策略。
![](https://support.huaweicloud.com/api-taurusdb/public_sys-resources/notice_3.0-zh-cn.png)
**当前页面API为历史版本API，未来可能停止维护。建议及时切换到新接口[查询自动备份策略](https://support.huaweicloud.com/api-taurusdb/ShowGaussMySqlBackupPolicy.html)。**
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-taurusdb/taurusdb_03_0000.html)。
#### URI
GET /mysql/v3/{project_id}/instances/{instance_id}/backups/policy
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                     |
|:---|:---|:---|:---|
| project_id  | 是    | String | 租户在某一Region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。 |
| instance_id | 是    | String | 实例ID，严格匹配UUID规则。                                                                                                                                       |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。                                                               |
| X-Language   | 否    | String | 请求语言类型。默认en-us。 取值范围： - en-us  - zh-cn   |
   
#### 响应参数
**状态码： 200**
表3响应Body参数 
| 参数            | 参数类型                                                                 | 描述      |
|:---|:---|:---|
| backup_policy | [BackupPolicy] object | 备份策略信息。 |
   
 表4BackupPolicy 
| 参数                          | 参数类型    | 描述                                                                                                                                                          |
|:---|:---|:---|
| keep_days                   | Integer | 指定已生成的备份文件可以保存的天数。取值范围：1～732，您也可以联系客服将最大保留天数调整为3660。 最小值：**1** 最大值：**732** |
| start_time                  | String  | 备份时间段。自动备份将在该时间段内触发。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。                                                                                                   |
| period                      | String  | 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。                                                                                                             |
| retention_num_backup_level1 | Integer | 一级备份保留数量。当一级备份开关开启时，返回此参数。                                                                                                                                  |
   
**状态码： 400**
表5响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误消息。 |
   
**状态码： 500**
表6响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误消息。 |
   
#### 请求示例
```
GET https://{endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/backups/policy
```
#### 响应示例
**状态码： 200**
Success.
```
{
  "backup_policy" : {
    "start_time" : "19:00-20:00",
    "keep_days" : "7",
    "period" : "1,2",
    "retention_num_backup_level1" : 1
  }
}
```
#### 状态码
| 状态码 | 描述            |
|:---|:---|
| 200 | Success.      |
| 400 | Client error. |
| 500 | Server error. |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-taurusdb/ErrorCode.html)。
