查询自动备份策略
功能介绍
查询自动备份策略,包含GeminiDB Cassandra库表信息。
接口约束
该接口支持如下数据库实例:
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。可以调用查询实例列表和详情接口获取。如果未申请实例,可以调用创建实例接口创建。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
参数解释: 备份策略类型。该参数仅针对GeminiDB Cassandra。 约束限制: 不涉及。 取值范围:
默认取值: “Instance”。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
backup_policy |
object |
参数解释: 备份策略对象,包括备份保留的天数和备份开始时间。详情请参考表5。 取值范围: 不涉及。 |
请求示例
GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/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 } }
状态码
请参见状态码。
错误码
请参见错误码。