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

文档中心

立即注册

导航

ModifyDBInstanceBackupPolicy

最近更新时间：2025.06.26 21:40:02首次发布时间：2025.06.26 21:40:02

调用 ModifyDBInstanceBackupPolicy 接口修改目标 MongoDB 实例的自动备份策略。

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-f9e5d782****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。
DataFullBackupTime	String	否	15:00-16:00	执行备份的时间，格式为 `HH:mm-HH:mm`（本地时间）。说明支持设置一天中的任意整点时间来执行备份，时间间隔为 1 小时。若该参数留空，表示不修改实例的备份执行时间。
DataBackupRetentionDay	Integer	否	8	备份保留天数。取值范围：7~365。说明若该参数留空，表示不修改实例的备份保留天数。
DataFullBackupPeriods	String[]	否	["MONDAY","TUESDAY"]	备份周期，取值范围如下： `MONDAY`：周一。 `TUESDAY`：周二。 `WEDNESDAY`：周三。 `THURSDAY`：周四。 `FRIDAY`：周五。 `SATURDAY`：周六。 `SUNDAY`：周日。说明出于安全考虑，必须选择 2 天或以上的时间作为备份周期。多个备份时间之间用英文逗号（,）分隔。若该参数留空，表示不修改实例的备份周期。

返回参数

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

示例

请求示例

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=ModifyDBInstanceBackupPolicy&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-shard-f9e5d782****",
    "DataFullBackupTime": "01:00-02:00",
    "DataFullBackupPeriods": [
        "MONDAY",
        "TUESDAY"
    ],
    "DataBackupRetentionDay": 8
}

返回示例

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

错误码

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