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

文档中心

立即注册

导航

GetBackupDownloadLink

最近更新时间：2024.07.26 14:50:52首次发布时间：2023.02.02 17:41:21

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

注意事项

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

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-ce48081d****	实例 ID。
BackupId	String	是	BackupId 示例：f1f2284117a344a38370c37b841fec75 FileName 示例：binlog-1683420632178737071-binlog.000044	同地域备份文件的 BackupId 或 FileName。如果下载的是数据备份，该字段的值为备份文件的 BackupId，可通过调用 DescribeBackups 接口获取；如果下载的是 Binlog 备份，该字段的值为备份文件的 FileName，可通过调用 DescribeBinlogFiles 接口获取。说明批量获取 Binlog 备份链接时，多个 FileName 之间使用英文逗号（,）分隔。

名称

类型

是否必选

示例值

描述

InstanceId

String

是

mysql-ce48081d****

实例 ID。

BackupId

String

是

BackupId 示例：f1f2284117a344a38370c37b841fec75
FileName 示例：binlog-1683420632178737071-binlog.000044

同地域备份文件的 BackupId 或 FileName。

如果下载的是数据备份，该字段的值为备份文件的 BackupId，可通过调用 DescribeBackups 接口获取；
如果下载的是 Binlog 备份，该字段的值为备份文件的 FileName，可通过调用 DescribeBinlogFiles 接口获取。

说明

批量获取 Binlog 备份链接时，多个 FileName 之间使用英文逗号（,）分隔。

返回参数

名称	类型	示例值	描述
BackupDownloadLink	String	https://rds-mysql-inner-fake.tos-s3-cn-beijing.volces.com/rds/mysql-c7a79d83**/mysql-c7a79d83-sd211-0/merge/full-1720687620088031497.qp.xbstream?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTMzI4MTNiZmQ5MzZiNDM1NmEzYmEyM2FmOTY4ODk%2F20240715%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20240715T100901Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ae5708c6dc628598e43eb037382af43724d19edae9b65dc5a3b75bee77e**	备份的外网下载地址。
BackupFileName	String	full-16347766163043687****.xbstream	备份文件名。说明下载日志备份文件时有返回值，下载数据备份文件时返回为空。
BackupFileSize	Integer	1024	备份文件大小，单位为 Byte。
BackupId	String	BackupId 示例：f1f2284117a344a38370c37b841fec75 FileName 示例：binlog-1683420632178737071-binlog.000044	备份文件名或备份 ID，与为请求参数 BackupId 传入的值保持一致。
BackupType	String	Full	备份类型，取值： `Full`：全量备份。 `Increment`：增量备份。
DownloadProgress	Long	10	备份文件准备进度，单位为 %。
InnerBackupDownloadLink	String	https://rds-mysql-inner-fake.tos-cn-beijing.ivolces.com/rds/mysql-c7a79d83**/mysql-c7a79d83-sd211-0/merge/full-1720687620088031497.qp.xbstream?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTMzI4MTNiZmQ5MzZiNDM1NmEzYmEyM2FmOTY4ODk%2F20240715%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20240715T100901Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e25826b29900310556dc2407ff495fbbc31856e8dfb564a7b67e7d791ec0**	备份的私网下载地址。
InstanceId	String	mysql-ce48081d****	实例 ID。
LinkExpiredTime	String	2022-01-01T10:10:59.000Z	下载链接过期时间，格式：`yyyy-MM-dd HH:mm:ss.sssZ`（UTC 时间）。

请求示例

POST /?Action=GetBackupDownloadLink&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=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZjMzY/20211202/cn-beijing/rds_mysql/request, SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645aff88

{
    "InstanceId": "mysql-ce48081d****",
    "BackupId": "541631e5f0614267a04d63d096a3****"
}

返回示例

正常返回示例

```json
{
    "ResponseMetadata": {
        "RequestId": "20240715180900E9B7EB45E0B20729EC63-811ac0",
        "Action": "GetBackupDownloadLink",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupDownloadLink": "https://rds-mysql-inner-fake.tos-s3-cn-beijing.volces.com/rds/mysql-c7a79d83****/mysql-c7a79d83****-sd211-0/merge/full-1720687620088031497.qp.xbstream?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTMzI4MTNiZmQ5MzZiNDM1NmEzYmEyM2FmOTY4ODk****%2F20240715%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20240715T100901Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ae5708c6dc628598e43eb037382af43724d19edae9b65dc5a3b75bee77e****",
        "BackupFileName": "",
        "BackupFileSize": 0,
        "BackupId": "607da9fc51d042c89b1c17c9eac3006e",
        "BackupType": "Full",
        "DownloadProgress": 100,
        "InnerBackupDownloadLink": "https://rds-mysql-inner-fake.tos-cn-beijing.ivolces.com/rds/mysql-c7a79d83****/mysql-c7a79d83****-sd211-0/merge/full-1720687620088031497.qp.xbstream?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKLTMzI4MTNiZmQ5MzZiNDM1NmEzYmEyM2FmOTY4ODk****%2F20240715%2Fcn-beijing%2Fs3%2Faws4_request&X-Amz-Date=20240715T100901Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e25826b29900310556dc2407ff495fbbc31856e8dfb564a7b67e7d791ec0****",
        "InstanceId": "mysql-c7a79d83****",
        "LinkExpiredTime": "2024-07-22T10:08:59.000Z"
    }
}

错误码

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