# 获取UDB备份下载地址 - DescribeUDBInstanceBackupURL

## 简介

获取UDB备份下载地址





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUDBInstanceBackupURL`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.sigcalcloud.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Region** | string | 地域。 参见 [地域和可用区列表](/docs/api/summary/regionlist) |**Yes**|
| **Zone** | string | 可用区。参见 [可用区列表](/docs/api/summary/regionlist) |No|
| **ProjectId** | string | 项目ID。不填写为默认项目，子帐号必须填写。 请参考[GetProjectList接口](/docs/api/summary/get_project_list) |No|
| **DBId** | string | DB实例Id,该值可通过DescribeUDBInstance获取 |**Yes**|
| **BackupId** | int | DB实例备份ID,该值可以通过DescribeUDBBackup获取 |**Yes**|
| **ValidTime** | int | DB响应中URL的过期时间,该值最小默认4小时,最大7天。不填默认为四小时。(单位/秒) |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **BackupPath** | string | DB实例备份文件公网的地址 |No|
| **InnerBackupPath** | string | DB实例备份文件内网的地址 |No|
| **MD5** | string | 备份文件的md5值 |No|




## 示例

### 请求示例
    
```
https://api.sigcalcloud.com/?Action=DescribeUDBInstanceBackupURL
&Region=cn-bj2
&DBId=udb-xxx
&BackupId=1234
&ValidTime=5
&ValidTime=8
```

### 响应示例
    
```json
{
  "Action": "DescribeUDBInstanceBackupURLResponse",
  "BackupPath": "http://udbbackup.ufile.ucloud.cn/bbasd?UCloudPublicKey=ucloududb@ucloud.cn1426152414000604875621",
  "InnerBackupPath": "ZDblezgJ",
  "Md5": "SltVqrDH",
  "RetCode": 0
}
```