文档中心

文档数据库 MongoDB 版

备份与恢复

DescribeDBInstanceBackupPolicy

调用 DescribeDBInstanceBackupPolicy 接口查询目标 MongoDB 实例的自动备份策略。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

InstanceId String 必选示例值：mongo-shard-f9e5d782d782

实例 ID。

说明

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

返回参数

AutoBackup String 示例值：Enable

DataFullBackupTime String 示例值：01:00Z-02:00Z

自动备份的备份执行时间，格式为 HH:mmZ-HH:mmZ（UTC）。间隔时间窗口为 1 小时。

DataBackupRetentionDay Integer 示例值：7

备份保留天数。

DataFullBackupPeriods String[] 示例值：[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]

备份周期，即一周内会进行备份的时间。以备份的执行开始时间为准。

示例

请求示例

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstanceBackupPolicy&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-f9e5d782d782"​
}​

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "2022102614294501017424615500FC00FC",​
        "Action": "DescribeDBInstanceBackupPolicy",​
        "Version": "2022-01-01",​
        "Service": "mongodb",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "AutoBackup": "Enable",​
        "DataBackupRetentionDay": 7,​
        "DataFullBackupPeriods": [​
            "MONDAY",​
            "TUESDAY",​
            "WEDNESDAY",​
            "THURSDAY",​
            "FRIDAY",​
            "SATURDAY",​
            "SUNDAY"​
        ],​
        "DataFullBackupTime": "01:00Z-02:00Z"​
    }​
}​

错误码

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

最近更新时间：2026.06.17 16:27:08

这个页面对您有帮助吗？

有用

无用