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

文档中心

立即注册

导航

CreateBackup

最近更新时间：2024.10.17 14:42:41首次发布时间：2024.04.26 11:07:55

调用 CreateBackup 接口为目标 MongoDB 实例手动创建备份。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-f9e5d782****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
BackupType	String	否	Physical	备份类型。取值范围如下： `Physical`：物理备份。 `Logical`（默认）：逻辑备份。说明无论是通过逻辑备份还是物理备份方式进行备份，备份对象均为数据备份。更多信息，请参见备份方式和备份对象。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://mongodb.volcengineapi.com/?Action=CreateBackup&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-shard-f9e5d782****",
    "BackupType": "Physical"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420010010023228002****",
        "Action": "CreateBackup",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

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