DescribeDBInstanceBackupURL--文档数据库 MongoDB 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceBackupURL

最近更新时间：2024.12.12 21:46:13首次发布时间：2024.04.26 11:07:55

调用 DescribeDBInstanceBackupURL 接口查询目标 MongoDB 实例下指定备份文件的下载地址信息。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
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****	备份文件的下载地址。说明您可以先复制该下载地址，然后粘贴在浏览器地址栏中并按回车键，浏览器即可自动完成下载。
LinkExpiredTime	String	2022-10-26T07:32:16Z	备份文件下载地址的到期时间，格式为 `yyyy-MM-ddTHH:mm:ssZ`（UTC）。说明下载地址的有效期为 15 分钟。下载地址失效后，您可以再次调用 DescribeDBInstanceBackupURL 接口获取最新的下载地址。
DownloadProgress	Integer	100	备份文件的获取进度，单位：%。说明您需要等进度为 100% 后再进行下载。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=DescribeDBInstanceBackupURL&Version=2022-01-01 HTTP/1.1
Host: mongodb.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": "20221026151716010174243134****",
        "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****",
        "BackupId": "ff4ab943f6ef450f8f48c1c258b4****",
        "DownloadProgress": 100,
        "InstanceId": "mongo-shard-f9e5d782****",
        "LinkExpiredTime": "2022-10-26T07:32:16Z"
    }
}

错误码

更多详情，请参见错误码。