DescribeCrossBackupPolicy--云数据库 MySQL 版-火山引擎

文档中心

立即注册

导航

DescribeCrossBackupPolicy

最近更新时间：2024.11.05 16:00:08首次发布时间：2023.08.14 13:16:21

调用 DescribeCrossBackupPolicy 接口查看跨地域备份配置。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-1ece4e51****	实例 ID。

返回参数

参数	类型	示例值	描述
BackupEnabled	Boolean	true	是否开启跨地域备份。 `true`：开启。 `false`：关闭。
LogBackupEnabled	Boolean	true	是否开启跨地域日志备份。 `true`：开启。 `false`：关闭。说明仅支持在开启跨地域备份时开启跨地域日志备份。
InstanceId	String	mysql-1ece4e51****	实例 ID。
CrossBackupRegion	String	cn-guangzhou	跨地域备份的目的地域 ID。如 BackupEnabled 取值为 `true`，则 CrossBackupRegion 必选。
Retention	Integer	7	跨地域备份保留天数，取值范围为 7~1825 天。

示例

请求示例

POST /?Action=DescribeCrossBackupPolicy&Version=2022-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-1ece4e51****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230707182506781C76ED810CD0D29C31",
        "Action": "DescribeCrossBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupEnabled": true,
        "CrossBackupRegion": "cn-guangzhou",
        "InstanceId": "mysql-1ece4e51****",
        "LogBackupEnabled": true,
        "Retention": 100
    }
}

错误码

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