查询自动备份策略

接口说明

查询自动备份策略。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

• URI样例

  https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy

请求消息

• 参数说明

  表1 请求参数

  名称	类型	IN	是否必选	描述
  X-Auth-Token	string	header	是	参数解释： 从IAM服务获取的用户Token。请参考认证鉴权。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
  project_id	string	path	是	参数解释： 租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
  instance_id	string	path	是	参数解释： 实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

• 请求示例
  备份策略开启，包括自动备份策略和增量备份策略：

  GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
   { 
     "backup_policy" : { 
       "keep_days" : 7, 
       "start_time" : "19:00-20:00", 
       "period" : "1,2,4,5,6", 
       "enable_incremental_backup" : true 
     } 
   }

  自动备份策略开启，但增量备份策略关闭：

  GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
   { 
     "backup_policy" : { 
       "keep_days" : 7, 
       "start_time" : "19:00-20:00", 
       "period" : "1,2,4,5,6", 
       "enable_incremental_backup" : false 
     } 
   }
  

  备份策略关闭，包括自动备份策略和增量备份策略：

  GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/backups/policy 
   { 
     "backup_policy" : { 
       "keep_days" : 0 
     } 
   }

响应消息

• 参数说明

  表2 参数说明

  名称	参数类型	是否必选	描述
  backup_policy	Object	是	备份策略对象，包括备份保留的天数和备份开始时间。详情请参见表3。

  表3 backup_policy字段数据结构说明

  名称	参数类型	是否必选	描述
  keep_days	Integer	是	备份文件可以保存的天数。
  start_time	String	否	备份时间段。自动备份将在该时间段内触发。
  period	String	否	备份周期配置。自动备份将在每星期指定的天进行。
  enable_incremental_backup	Boolean	否	是否开启增量备份。true：表示增量备份策略为开启状态；false：表示增量备份策略为关闭状态。

• 响应示例

  状态码： 200

  Success.

  {    "backup_policy" : {  
         "keep_days" : 7, 
         "start_time" : "19:00-20:00", 
         "period" : "1,2,4,5,6",  
         "enable_incremental_backup" : true 
     } 
   }

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。