设置自动备份策略 - ConfiguringanAutomatedBackupPolicy
功能介绍
设置自动备份策略。
接口约束
- GeminiDB Cassandra
- GeminiDB Influx
- GeminiDB Redis
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:setBackupPolicy
Write
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
nosql:backup:list
-
URI
PUT /v3/{project_id}/instances/{instance_id}/backups/policy
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一region下的project ID。获取方法请参见获取项目ID。 |
instance_id | 是 | String | 实例ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
backup_policy | 是 | object | 备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表4。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
keep_days | 是 | Integer | 指定已生成的备份文件可以保存的天数。 取值范围：0～35。取0值，表示关闭自动备份策略。 |
start_time | 否 | String | 备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。
|
period | 否 | String | 备份周期配置。自动备份将在每星期指定的天进行。启用自动备份策略时，此参数必选。如果自动备份策略关闭，则不需要传递该参数。 取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下：
|
响应参数
状态码：204
无响应参数。
请求示例
- URI样例
PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
- 请求体样例
开启或修改自动备份策略，备份周期为"1,2,3,4,5,6"，备份时间段为"01:00-02:00",备份保留天数为7天：
{ "backup_policy" : { "period" : "1,2,3,4,5,6", "start_time" : "01:00-02:00", "keep_days" : 7 } }关闭自动备份策略：
{ "backup_policy" : { "keep_days" : 0 } }
响应示例
状态码： 204
No Content
{ } 状态码
请参见状态码。
错误码
请参见错误码。
