# 获取实例备份下载链接 - DescribeUMongoDBBackupURL

## 简介

获取实例备份下载链接





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `DescribeUMongoDBBackupURL`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.genesissai.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|
| **ClusterId** | string | 集群ID |**Yes**|
| **BackupId** | string | 文件备份ID |No|
| **PackageId** | int | 打包ID |No|
| **ValidTime** | int | 备份链接过期时间（单位秒） |No|
| **Category** | string | 类型:如 oplog |No|

### 响应字段

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




## 示例

### 请求示例
    
```
https://api.genesissai.com/?Action=DescribeUMongoDBBackupURL
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=DatUQmzF
&ClusterId=cDNCLXDU
&BackupId=reAlkmik
&ValidTime=1
&PackageId=3
&Category=NmFaVOQi
```

### 响应示例
    
```json
{
  "Action": "DescribeUMongoDBBackupURLResponse",
  "InternetAddress": "DYnKJjGA",
  "IntranetAddress": "eZNhwqZl",
  "RetCode": 0
}
```