DescribeBackupPolicy--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeBackupPolicy

最近更新时间：2024.08.28 10:56:53首次发布时间：2023.07.26 13:58:16

调用 DescribeBackupPolicy 接口查询指定 veDB MySQL 实例的数据备份策略。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-gzwdsf9b****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。

返回参数

名称	类型	示例值	描述
InstanceId	String	vedbm-gzwdsf9b****	实例 ID。
BackupTime	String	18:00Z-20:00Z	执行备份任务的时间，间隔窗口为两小时。格式：HH:mmZ-HH:mmZ（UTC 时间）。
FullBackupPeriod	String	Friday,Monday,Saturday	全量备份周期，多个取值用英文逗号（,）隔开。取值： `Monday`：周一。 `Tuesday`：周二。 `Wednesday`：周三。 `Thursday`：周四。 `Friday`：周五。 `Saturday`：周六。 `Sunday`：周日。
BackupRetentionPeriod	String	7	数据备份保留天数，取值：7~30 天。
ContinueBackup	Bool	true	是否开启持续备份，取值固定为 `true`。

请求示例

POST /?Action=DescribeBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220614T114308Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220614/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****

{
    "InstanceId": "vedbm-gzwdsf9b****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307191407166A09199F8080EF9ED490",
        "Action": "DescribeBackupPolicy",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupRetentionPeriod": 7,
        "BackupTime": "18:00Z-20:00Z",
        "ContinueBackup": true,
        "FullBackupPeriod": "Friday,Monday,Saturday,Sunday,Thursday,Tuesday,Wednesday",
        "IncrementBackupPeriod": 20,
        "InstanceId": "vedbm-gzwdsf9b****"
    }
}

错误码

更多详情，请参见错误码。