响应消息
● 正常响应要素说明
表5-50 要素说明
名称 参数类型 描述
job_id String 工作流ID。
● 正常响应样例
{ "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.6 备份与恢复
5.6.1 查询自动备份策略
功能介绍
查询自动备份策略。
接口约束
该接口支持如下数据库实例
● GaussDB(for Cassandra)
● GaussDB(for Mongo)副本集4.0
● GaussDB(for Influx)
● GaussDB(for Redis)
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy
● URI样例
https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/
v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/
9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
● 参数说明
表5-51 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID。
请求消息
无。
响应消息
● 正常响应要素说明
表5-52 要素说明
名称 参数类型 描述
backup_policy Object 备份策略对象，包括备份保留 的天数和备份开始时间。详情 请参见表5-53。
表5-53 backup_policy 字段数据结构说明
名称 参数类型 描述
keep_days Integer 备份文件可以保存的天数。
start_time String 备份时间段。自动备份将在该
时间段内触发。
period String 备份周期配置。自动备份将在
每星期指定的天进行。
● 正常响应样例 自动备份策略开启：
{ "backup_policy": { "keep_days": 7,
"start_time": "19:00-20:00", "period": "1,2,4,5,6"
} }
自动备份策略关闭：
{ "backup_policy": { "keep_days": 0 }
}
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。
5.6.2 设置自动备份策略
功能介绍
设置自动备份策略。
接口约束
该接口支持如下数据库实例。
● GaussDB(for Cassandra)
● GaussDB(for Influx)
调试
您可以在API Explorer中调试该接口。
URI
● URI格式
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy
● URI样例
https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/
v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/
9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
● 参数说明
表5-54 参数说明
名称 是否必选 描述
project_id 是 租户在某一region下的project ID。
instance_id 是 实例ID。
请求消息
● 参数说明
表5-55 参数说明
名称 是否必选 参数类型 描述
backup_policy 是 Object 备份策略对象，包括备 份保留的天数和备份开 始时间。详情请参见表 5-56。
表5-56 backup_policy 字段数据结构说明
名称 是否必选 参数类型 描述
keep_days 是 Integer 指定已生成的备份文件
可以保存的天数。
取值范围：0～35。取0 值，表示关闭自动备份 策略。
start_time 否 String 备份时间段。自动备份
将在该时间段内触发。
开启自动备份策略时，
该参数必选；关闭自动 备份策略时，不传该参 数。
取值范围：格式必须为 hh:mm-HH:MM，且有 效，当前时间指UTC时 间。
● HH取值必须比hh大 1。
● mm和MM取值必须 相同，且取值必须为 00、15、30和45。
● 不传该参数，默认的 备份时间段为 00:00-01:00。
● 取值示例：
23:00-00:00。
period 否 String 备份周期配置。自动备
份将在每星期指定的天 进行。
取值范围：格式为半角 逗号隔开的数字，数字 代表星期。保留天数取 值不同，备份周期约束 如下：
● 0天，不传该参数。
● 1～6天，备份周期 全选，取值为：
1,2,3,4,5,6,7。
● 7～732天，备份周 期至少选择一周中的 一天。示例：
1,2,3,4。
● 请求体样例
开启或修改自动备份策略：
{ "backup_policy": { "keep_days": 9,
"start_time": "08:00-09:00", "period": "1,4,5,6,7"
} }
关闭自动备份策略：
{ "backup_policy": { "keep_days": 0 }
}
响应消息
● 正常响应 {}
● 异常响应
请参见异常请求结果。
状态码
详情请参见状态码。
错误码
详情请参见错误码。