You need to enable JavaScript to run this app.
导航
ModifyDBInstanceBackupURL
最近更新时间:2024.07.10 22:19:49首次发布时间:2024.04.26 11:07:55

调用 ModifyDBInstanceBackupURL 接口获取目标 MongoDB 实例中的指定备份文件。

请求类型

异步请求。

注意事项

说明

针对通过物理备份方式生成的数据备份,由于这些备份文件在对象存储 TOS 中以分片形式存储。您通过 ModifyDBInstanceBackupURL 接口获取备份文件后,需要再调用 DescribeDBInstanceBackupURL 接口来查看备份文件的下载地址才可下载指定备份文件。

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mongo-shard-f9e5d782****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。

BackupId
String
c89103a4821f47dfb9384b324aa0****

需要获取备份文件的备份 ID。

说明

仅通过物理备份方式生成的数据备份需要使用 ModifyDBInstanceBackupURL 接口来获取备份文件。您可以调用 DescribeBackups 接口查询指定实例下的备份文件 ID,并在返回结果中找到同时符合如下条件的备份文件:

  • 备份状态为成功,即 BackupStatus 取值为 Success
  • 备份方式为物理备份,即 BackupType 取值为 Physical
  • 备份对象为数据备份,即 BackupObject 取值为 Data
  • 备份文件的下载状态为还未获取备份文件,即 BackupDownloadStatus 取值为 NotDownLoad

返回参数

无。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=ModifyDBInstanceBackupURL&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=****
{
    "BackupId": "c89103a4821f47dfb9384b324aa0****",
    "InstanceId": "mongo-shard-f9e5d782****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221025165245010174249126050D2029",
        "Action": "ModifyDBInstanceBackupURL",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码