文档首页/ 云数据库 RDS/ API参考/ API v3/ 备份与恢复/ 获取备份下载链接 - ShowBackupDownloadLink
更新时间:2026-09-20 GMT+08:00

获取备份下载链接 - ShowBackupDownloadLink

功能介绍

获取备份下载链接。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:backup:download

read

-

-

-

-

接口约束

该接口支持查询RDS for MySQL的全量备份文件下载链接和Binlog备份文件下载链接,RDS for PostgreSQL的全量备份文件下载链接、增量备份文件下载链接和库级备份文件下载链接,RDS for SQL Server的全量备份文件下载链接和增量备份文件下载链接。

URI

  • URI格式

    GET /v3/{project_id}/backup-files?backup_id={backup_id}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    backup_id

    是

    参数解释:

    备份ID。

    约束限制:

    不涉及。

    取值范围:

    该参数值可调用获取备份列表接口,通过表3中的“id”获取。

    默认取值:

    不涉及。

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backup-files?backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    files

    Array of objects

    参数解释:

    备份包含的文件列表。

    详情请参见表3。

    bucket

    String

    参数解释:

    文件所在的桶名。

    取值范围:

    不涉及。

    表3 files字段数据结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释:

    文件名。

    取值范围:

    不涉及。

    size

    Long

    参数解释:

    文件大小,单位:KB。

    取值范围:

    不涉及。

    download_link

    String

    参数解释:

    文件下载链接。

    取值范围:

    不涉及。

    link_expired_time

    String

    参数解释:

    下载链接过期时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,例如北京时间偏移显示为+0800。

    取值范围:

    不涉及。

    database_name

    String

    参数解释:

    数据库名。

    • 对于RDS for SQL Server引擎,下载库级备份文件时,返回数据库名;否则,返回为空。
    • 对于其他引擎,如果下载的备份文件不是库级备份,返回为空。

    取值范围:

    不涉及。

  • 正常响应样例
    {
       "files": [
        {
            "name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx",
            "size": 2803,
            "download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx",
            "link_expired_time":"2018-08-16T10:15:14+0800",
            "database_name" : "rdsbucket"
         }
         ],
        "bucket": "rdsbucket.bucketname"
    }
    
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。