获取备份文件下载地址v2
更新时间 2026-06-30 18:12:33
最近更新时间: 2026-06-30 18:12:33
接口功能介绍
获取备份数据下载地址
接口约束
无
URI
GET /DDS2/v2/openApi/getBackupDownloadAddress
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 文档数据库对外的实例标识 | 60d420bffb394**************** | |
| backupId | 是 | Integer | 备份ID | 25 | |
| urlExpiredSeconds | 否 | Long | 下载链接有效期,范围:300-3600,默认值3600,单位:秒。 | 3600 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 项目id | 0 | |
| regionId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应码 取值范围:800为成功,900为失败 | 800 | |
| message | String | 响应信息 | 获取备份数据下载地址成功 | |
| returnObj | Object | 返回对象数组 | returnObj | |
| error | String | 错误码。当接口失败时才返回具体错误编码,成功不返回或者为空。 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| fileName | String | 备份文件名(对于分片集群实例,为了区分不同分片故包含父路径)。 | 1 | |
| downloadAddr | String | 备份文件对应的下载地址 | 2022-10-10 00:00:00 时间格式为:yyyy-MM-dd HH:mm:ss | |
| innerDownloadAddr | String | 备份文件对应的内网下载地址 |
枚举参数
无
请求示例
请求url
/v2/openApi/getBackupDownloadAddress?prodInstId=60d420bffb394*************************&backupId=4125
请求头header
project-id=0
regionId=bb9fdb42056f11eda1610242ac110002
请求体body
无
响应示例
{
"statusCode": 800 ,
"message": "获取备份数据下载地址成功" ,
"returnObj": [
{
"fileName": "sizeStorer.wt" ,
"downloadAddr": "https://jiangsu-10.zos.ctyun.cn/953333ef0c*********a11b41010aac8/953333ef*********1b41010aac8/20240923*********_backup/sizeStorer.wt?AWSAccessKeyId=UJA1EIQ3C58P9DF2T1OT&Signature=LK1pbSonQj***dIgTylNYrcA%3D&Expires=1727091941",
"innerDownloadAddr": "http://****:**/953333ef0c*********a11b41010aac8/953333ef*********1b41010aac8/20240923*********_backup/backupCompress.tar.gz?AWSAccessKeyId=UJA1*********2T1OT&Signature=LK1pbSonQj***dIgTylNYrcA%3D&Expires=1727091941"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码