DescribeCrossRegionBackupPolicy--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeCrossRegionBackupPolicy

最近更新时间：2025.06.24 23:01:40首次发布时间：2025.06.24 23:01:40

调用 DescribeCrossRegionBackupPolicy 接口查询目标 Redis 实例的跨地域备份策略。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
Active	Boolean	true	当前实例的跨地域备份功能是否已开启，取值范围如下： `true`：已开启跨地域备份。 `false`：未开启跨地域备份。
CrossBackupRegion	String	cn-shanghai	跨地域备份的目的地域 ID。
TTL	Integer	7	跨地域备份文件的保留天数，默认为 7 天。

示例

请求示例

POST https://redis.cn-beijing.volcengineapi.com/?Action=DescribeCrossRegionBackupPolicy&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****10023228002****",
        "Action": "DescribeCrossRegionBackupPolicy",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "InstanceId": "redis-cn0212gzmh2xs****",
        "Active": true,
        "CrossBackupRegion": "cn-shanghai",
        "TTL": 7
    }
}

错误码

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