文档中心

云数据库 SQL Server 版

备份恢复

DescribeCrossBackupPolicy - 查询跨地域备份策略

调用 DescribeCrossBackupPolicy 接口查看跨地域备份策略。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeCrossBackupPolicy

要执行的操作，取值：DescribeCrossBackupPolicy。

Version string 必选示例值：2022-01-01

API 的版本，取值：2022-01-01。

InstanceId string 必选示例值：mssql-37e2cc******

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

InstanceId string 示例值：mssql-37e2cc******

实例 ID。

BackupEnabled boolean 示例值：true

是否开启跨地域备份，取值如下：

true：表示开启跨地域备份。

false：表示关闭跨地域备份。

CrossBackupRegion string 示例值：cn-shanghai

跨地域备份的目的地域 ID。

Retention integer 示例值：7

跨地域备份保留天数。

请求示例

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

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "20250513113941DC90D701D6B34F478849-129d82",​
        "Action": "DescribeCrossBackupPolicy",​
        "Version": "2022-01-01",​
        "Service": "rds_mssql",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "BackupEnabled": true,​
        "CrossBackupRegion": "cn-shanghai",​
        "InstanceId": "mssql-37e2cc******",​
        "Retention": 14​
    }​
}​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.12.01 18:11:12

这个页面对您有帮助吗？

有用

无用