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

文档中心

立即注册

导航

DescribeDBInstanceBackupPolicy

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

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

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mongo-shard-f9e5d782****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
AutoBackup	String	Enable	自动备份功能默认开启且不支持关闭。该参数取值固定为 `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.volcengineapi.com/?Action=DescribeDBInstanceBackupPolicy&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****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022102614294501017424615500FC****",
        "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"
    }
}

错误码

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