You need to enable JavaScript to run this app.
文档中心
文档数据库 MongoDB 版

文档数据库 MongoDB 版

复制全文
下载 pdf
备份与恢复
DescribeDBInstanceBackupURL
复制全文
下载 pdf
DescribeDBInstanceBackupURL
调用 DescribeDBInstanceBackupURL 接口查询目标 MongoDB 实例下指定备份文件的获取进度、下载地址以及下载地址有效期等信息。​
请求类型​
同步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
InstanceId String 必选 示例值:mongo-replica-3b96fa21****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。​
​
BackupId String 必选 示例值:ff4ab943f6ef450f8f48c1c258b4****​
需要获取备份文件的备份 ID。​
说明​
针对通过物理备份方式生成的备份,由于这些备份文件在对象存储 TOS 中以分片形式存储。您需要先调用 ModifyDBInstanceBackupURL 接口获取备份文件,然后调用 DescribeDBInstanceBackupURL 接口来查看备份文件的下载地址,并通过下载地址将指定备份文件下载至本地。因此该备份 ID 需与 ModifyDBInstanceBackupURL 请求参数中的 BackupId保持一致。​
​
​
返回参数​
InstanceId String 示例值:mongo-replica-3b96fa21****​
实例 ID。​
​
BackupId String 示例值:ff4ab943f6ef450f8f48c1c258b4****​
备份 ID。​
​
BackupDownloadLink String 示例值:https://mongodb.tos-s3-cn-beijing.volces.com/mongo/mongo-replica-3b96fa21****​
备份文件的公网下载地址。​
说明​
您可以先复制该下载地址,然后粘贴在浏览器地址栏中并按回车键,浏览器即可自动完成下载。​
​
PrivateDownloadLink String 示例值:https://mongodb.tos-s3-cn-beijing.ivolces.com/mongo/mongo-replica-3b96fa21****​
备份文件的私网下载地址。​
说明​
您需要在私网环境中(例如,与当前 MongoDB 实例在同一 VPC 下)才能使用该地址进行下载。更多详情,请参见管理备份文件。​
​
LinkExpiredTime String 示例值:2022-10-26T07:32:16Z​
备份文件下载地址的到期时间,格式为 yyyy-MM-ddTHH:mm:ssZ(UTC)。​
说明​
下载地址的有效期为 15 分钟。下载地址失效后,您可以再次调用 DescribeDBInstanceBackupURL 接口获取最新的下载地址。​
​
DownloadProgress Integer 示例值:100​
备份文件的获取进度,单位:%。​
说明​
您需要等进度为 100% 后再进行下载。​
​
​
示例​
请求示例​
​
POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceBackupURL&Version=2022-01-01 HTTP/1.1​
Host: mongodb.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****​
{​
"InstanceId": "mongo-replica-3b96fa21****",​
"BackupId": "ff4ab943f6ef450f8f48c1c258b4****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20221026151716010174243134020E****",​
"Action": "DescribeDBInstanceBackupURL",​
"Version": "2022-01-01",​
"Service": "mongodb",​
"Region": "cn-beijing"​
},​
"Result": {​
"BackupDownloadLink": "https://mongodb.tos-s3-cn-beijing.volces.com/mongo/mongo-replica-3b96fa21****",​
"PrivateDownloadLink": "https://mongodb.tos-s3-cn-beijing.ivolces.com/mongo/mongo-replica-3b96fa21****",​
"BackupId": "ff4ab943f6ef450f8f48c1c258b4****",​
"DownloadProgress": 100,​
"InstanceId": "mongo-shard-f9e5d782****",​
"LinkExpiredTime": "2022-10-26T07:32:16Z"​
}​
}​
​
错误码​
更多详情,请参见错误码。​
最近更新时间:2026.06.17 16:29:23
这个页面对您有帮助吗?
有用
有用
无用
无用