# 查询自动备份策略 - QueryinganAutomatedBackupPolicy
#### 功能介绍
查询自动备份策略，包含GeminiDB Cassandra库表信息。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ShowBackupPolicy)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                      | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:getBackupPolicy | Read | instance \* | -   | nosql:backup:list | -      |
     
  
 
#### URI
GET /v3.1/{project_id}/instances/{instance_id}/backups/policy
表1路径参数 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| project_id  | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。     |
| instance_id | 是    | String | **参数解释：** 实例ID。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。如果未申请实例，可以调用[创建实例 - CreatinganInstance](https://support.huaweicloud.com/api-nosql/nosql_05_0014.html)接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数   | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|:---|
| type | 否    | String | **参数解释：** 备份策略类型。该参数仅针对GeminiDB Cassandra。 **约束限制：** 不涉及。 **取值范围：** - Instance：表示查询实例级备份。  - DatabaseTable：表示查询库表级备份。   **默认取值：** Instance。 |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：** **200**
表4响应Body参数 
| 参数            | 参数类型                                                          | 描述                                                                  |
|:---|:---|:---|
| backup_policy | [表5] object | **参数解释：** 备份策略对象，包括备份保留的天数和备份开始时间。 |
   
 表5ShowBackupPolicyResult 
| 参数         | 参数类型    | 描述                                                                                                                                                |
|:---|:---|:---|
| keep_days  | Integer | **参数解释：** 备份文件可以保存的天数。 **取值范围：** 不涉及。          |
| start_time | String  | **参数解释：** 备份时间段。自动备份将在该时间段内触发。 **取值范围：** 不涉及。   |
| period     | String  | **参数解释：** 备份周期配置。自动备份将在每星期指定的天进行。 **取值范围：** 不涉及。 |
   
#### 请求示例
URI样例
```
GET https://{Endpoint}/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/764b8a2763d34414ad3f2d5495416cb5in06/backups/policy?type=DatabaseTable
```
#### 响应示例
**状态码： 200**
Success
自动备份策略开启：
```
{
   "backup_policy" : { 
     "keep_days" : 7, 
     "start_time" : "19:00-20:00", 
     "period" : "1,2,4,5,6" 
   }
 }
```
自动备份策略关闭：
```
{
  "backup_policy" : {
    "keep_days" : 0
  }
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。