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

文档中心

立即注册

导航

DescribeBackupPointDownloadUrls

最近更新时间：2024.07.18 22:55:13首次发布时间：2023.01.19 10:57:42

调用 DescribeBackupPointDownloadUrls 接口查询目标 Redis 实例中指定备份文件的下载地址。

请求类型

同步请求。

注意事项

仅主备实例（即 InstanceClass 为 PrimarySecondary）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone）不支持备份恢复相关操作，不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。
BackupPointId	String	是	b-cn02wp9k2wlw9z9gzl76n2vd****	目标备份文件的备份 ID。说明您可以调用 DescribeBackups 接口查看指定实例的备份集信息列表，包括各备份文件的备份 ID 信息。

返回参数

参数	类型	示例值	描述
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
ShardNumber	Integer	1	实例中的分片总数。
BackupPointDownloadUrls	Object[]		当前备份点所属备份文件的下载地址信息。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeBackupPointDownloadUrls&Version=2020-12-07 HTTP/1.1
Host: redis.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****",
    "BackupPointId":"b-cn02xmmrp751i9cdzcphjmk4****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221226190044FC2ED3F63B861BF6****",
        "Action": "DescribeBackupPointDownloadUrls",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupPointDownloadUrls": [
            {
                "PrivateDownloadUrl": "http://redis-dts-beijing.ivolces.com/bytedance.redis.redis-cn0212gzmh2xs****/20221226182521/0/20221226182521/0.rdb?****",
                "PublicDownloadUrl": "https://redis-dts-beijing.volces.com/bytedance.redis.redis-cn0212gzmh2xs****/20221226182521/0/20221226182521/0.rdb?****",
                "RdbFileSize": 8359,
                "ShardID": "server-redis-cn0212gzmh2xs****-0"
            }
        ],
        "InstanceId": "redis-cn0212gzmh2xs****",
        "ShardNumber": 1
    }
}

错误码

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