文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 查询自动备份策略
更新时间：2024-10-28 GMT+08:00
查看PDF
分享

查询自动备份策略

功能介绍

查询自动备份策略，包含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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。

instance_id

是

String

实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

备份策略类型。该参数仅针对GeminiDB Cassandra。可取值：

  • Instance，表示查询实例级备份。
  • DatabaseTable，表示查询库表级备份。
  • 默认取值“Instance”。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

backup_policy

object

备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表5。
表5 ShowBackupPolicyResult

参数

参数类型

描述

keep_days

Integer

备份文件可以保存的天数。

start_time

String

备份时间段。自动备份将在该时间段内触发。

period

String

备份周期配置。自动备份将在每星期指定的天进行。

请求示例

URI样例 
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
  }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复

相关文档