文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 备份管理/ 查询自动备份策略
更新时间：2024-05-31 GMT+08:00
查看PDF
分享

查询自动备份策略

功能介绍

查询自动备份策略。

该接口计划于2025-03-31下线，建议及时切换到新接口查询自动备份策略。

调试

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

URI

GET /mysql/v3/{project_id}/instances/{instance_id}/backups/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。

instance_id

是

String

实例ID，严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

backup_policy

BackupPolicy object

备份策略信息。
表4 BackupPolicy

参数

参数类型

描述

keep_days

Integer

指定已生成的备份文件可以保存的天数。取值范围：1～732，您也可以联系客服将最大保留天数调整为3660。

最小值：1

最大值：732

start_time

String

备份时间段。自动备份将在该时间段内触发。 取值范围：格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。

period

String

备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字代表星期。

retention_num_backup_level1

Integer

一级备份保留数量。当一级备份开关开启时，返回此参数。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/backups/policy

响应示例

状态码： 200

Success.

{
  "backup_policy" : {
    "start_time" : "19:00-20:00",
    "keep_days" : "7",
    "period" : "1,2",
    "retention_num_backup_level1" : 1
  }
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 备份管理

相关文档