
# 获取备份下载链接-ObtainingtheLinkforDownloadingaBackupFile
#### 功能介绍
获取备份下载链接。
#### 接口约束
备份下载链接在更新时间后15分钟内有效。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=DDS&api=ShowBackupDownloadLink)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dds/dds_api_permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                 | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                              | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | dds:backup:download | read | instance    | [g:EnterpriseProjectId](https://support.huaweicloud.com/api-dds/dds_api_0042.html#dds_api_0042__li1539015369314) | -  | -      |
     
  
 
#### URI
- URI格式 GET /v3/{project_id}/backups/download-file
  
- URI样例 https://dds.cn-north-1.myhuaweicloud.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02\&backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02
  ![](https://support.huaweicloud.com/api-dds/public_sys-resources/note_3.0-zh-cn.png)
  backup_id可以通过[查询备份列表](https://support.huaweicloud.com/api-dds/dds_api_0029.html#dds_api_0029__table52869820)获取。
  
表1路径参数 
| 名称         | 是否必选 | 类型     | IN   | 描述                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|:---|
| project_id | 是    | String | path | **参数解释：** 项目ID。请参考[获取项目ID](https://support.huaweicloud.com/api-dds/dds_projectid.html)章节获取项目编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 名称          | 是否必选 | 类型     | IN    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|:---|:---|
| instance_id | 是    | String | path  | **参数解释：** 实例ID，可以调用"[查询实例列表和详情-QueryingInstancesandDetails](https://support.huaweicloud.com/api-dds/dds_api_0023.html)"接口获取。如果未申请实例，可以调用"[创建实例-CreatingaDBInstance](https://support.huaweicloud.com/api-dds/dds_api_0020.html)"接口创建。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| backup_id   | 是    | String | query | **参数解释：** 备份ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                                                                                                                       |
   
#### 请求参数
表3请求Header参数 
| 名称           | 是否必选 | 类型     | IN     | 描述                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | header | **参数解释：** 从IAM服务获取的用户Token。请参考[认证鉴权](https://support.huaweicloud.com/api-dds/dds_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
| X-Language   | 否    | String | header | **参数解释：** 语言。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                          |
   
#### 响应参数
表4响应Body参数 
| 名称     | 参数类型             | 说明                                                                                                                                                                                                  |
|:---|:---|:---|
| files  | Array of objects | **参数解释：** 备份包含的文件列表。 详情请参见[表5]。 **取值范围：** 不涉及。 |
| bucket | String           | **参数解释：** 文件所在的桶名。 **取值范围：** 不涉及。                                                                   |
   
 表5files字段数据结构说明 
| 名称                | 参数类型   | 说明                                                                                                                                                                                               |
|:---|:---|:---|
| name              | String | **参数解释：** 文件名。 **取值范围：** 不涉及。                                                                         |
| size              | Long   | **参数解释：** 文件大小，单位：KB。 **取值范围：** 不涉及。                                                               |
| download_link     | String | **参数解释：** 文件下载链接。 **取值范围：** 不涉及。                                                                    |
| link_expired_time | String | **参数解释：** 下载链接过期时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始，Z指时区偏移量，例如UTC时间偏移显示为+0000。 **取值范围：** 不涉及。 |
| group_id          | String | **参数解释：** 组ID。 **取值范围：** 不涉及。                                                                         |
| group_name        | String | **参数解释：** 组名。 **取值范围：** 不涉及。                                                                        |
   
#### 请求示例
```
GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02&backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02
```
#### 响应示例
```
{
   "files": [
    {
        "name": "43e4feaab48f11e89039fa163ebaa7e4br02.xxx",
        "size": 2803,
        "download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx",
        "link_expired_time":"2018-08-16T10:15:14+0000",
        "group_id": "43e4feaab48f11e89039fa163ebaa7e4gr02",
        "group_name": "shard_1"
     }
     ],
    "bucket": "rdsbucket.bucketname"
}
```
#### SDK
单击[文档数据库服务 DDS SDK](https://sdkcenter.developer.huaweicloud.com/?product=DDS)，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
#### 状态码
详情请参见[状态码](https://support.huaweicloud.com/api-dds/dds_status_code.html)。
#### 错误码
详情请参见[错误码](https://support.huaweicloud.com/api-dds/dds_error_code.html)。
