GetBackupDownloadLink--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

GetBackupDownloadLink

最近更新时间：2025.06.10 11:39:06首次发布时间：2025.06.05 17:21:56

调用 GetBackupDownloadLink 接口获取备份的下载链接。

请求类型

同步请求。

注意事项

仅允许下载请求所发往地域下的备份文件。
如果调用该接口后返回的各字段值为空，则需要先调用 DownloadBackup 接口触发下载备份文件的前置工作。
当前仅支持下载逻辑备份。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-a3e7eb2f****	实例 ID。
BackupId	String	是	20250512-194654-3836LI	待下载的逻辑备份的 ID。

返回参数

参数	类型	示例值	描述
BackupDescription	String	This is a description of the backup set.	备份集的描述信息。
BackupDownloadLink	String	请参见返回示例。	备份的公网下载地址。
BackupFileName	String	postgres-a3e7eb2f****-20250512-194654-3836LI.zip	备份文件名。
BackupFileSize	Long	1024	备份文件大小，单位为 Byte。
BackupId	String	20250512-194654-3836LI	备份的 ID。
BackupMethod	String	Logical	备份类型。取值： `Physical`：物理备份。默认值。 `Logical`：逻辑备份。说明当 BackupScope 取值为 `Database` 时，BackupMethod 只能取值 `Logical`。
InnerBackupDownloadLink	String	请参见返回示例。	备份的私网下载地址。
InstanceId	String	postgres-a3e7eb2f****	实例 ID。
LinkExpiredTime	String	2025-05-19T14:03:27.603Z	下载链接过期时间，格式：`yyyy-MM-ddTHH:mm:ss.sssZ`（UTC 时间）。
PrepareProgess	Integer	100	备份文件的准备进度。调用 DownloadBackup 开始下载备份的前置工作后，可通过此参数查看备份文件的准备进度，单位为 %。

示例

请求示例

POST /?Action=GetBackupDownloadLink&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-postgresql.cn-beijing.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "postgres-a3e7eb2f****",
    "BackupId": "20250512-194654-3836LI"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250512220327F839DCF033BA01385243-18218e",
        "Action": "GetBackupDownloadLink",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupDescription": "",
        "BackupDownloadLink": "https://for-cq-boe-rdspg-backup.tos-s3-cn-beijing.volces.com/backrestrepo/postgres-a3e7eb2f****-backrest-shared-repo/logical-backup/20250512-194654-3836LI/postgres-a3e7eb2f****-20250512-194654-3836LI.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTYThjOGU3ZmYwMTFlNGQ5YmEwMGI5ZTdmZWIzMTA****%2F20250512%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20250512T140327Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=18bd7c43d730771444a6778fff78ae44beeac7f69f981c393e3622e8f0ec****",
        "BackupFileName": "postgres-a3e7eb2f****-20250512-194654-3836LI.zip",
        "BackupFileSize": 32093,
        "BackupId": "20250512-194654-3836LI",
        "BackupMethod": "Logical",
        "InnerBackupDownloadLink": "https://for-cq-boe-rdspg-backup.s3.cn-beijing.amazonaws.com/backrestrepo/postgres-a3e7eb2f****-backrest-shared-repo/logical-backup/20250512-194654-3836LI/postgres-a3e7eb2f****-20250512-194654-3836LI.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTYThjOGU3ZmYwMTFlNGQ5YmEwMGI5ZTdmZWIzMTA****%2F20250512%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20250512T140327Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aa896c51b45ccc307c5b1d7d432e42781b8f96950852b97207d6e767f30c****",
        "InstanceId": "postgres-a3e7eb2f****",
        "LinkExpiredTime": "2025-05-19T14:03:27.603Z",
        "PrepareProgess": 100
    }
}