全部产品
Search

搜索本产品

    云数据库 MongoDB：DescribeBackupPolicy - 查看集群自动备份策略

    文档中心

    云数据库 MongoDB：DescribeBackupPolicy - 查看集群自动备份策略

    更新时间：Jan 17, 2023

    查询MongoDB实例的备份策略。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作 访问级别 资源类型 条件关键字 关联操作
    dds:DescribeBackupPolicy READ
    • MongoDB
      acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      无
    		无

    请求参数

    名称 类型 必填 描述 示例值
    DBInstanceId string 是

    实例ID。

    		 dds-bp16cb162771****

    返回参数

    名称 类型 描述 示例值
    object

    返回数据。
    PreferredBackupPeriod string

    备份周期，取值说明：

    • Monday：星期一。
    • Tuesday：星期二。
    • Wednesday：星期三。
    • Thursday：星期四。
    • Friday：星期五。
    • Saturday：星期六。
    • Sunday：星期日。
    		 Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
    RequestId string

    请求ID。

    		 5A9464CA-F7DC-5434-90B1-DF7F197C****
    PreferredBackupTime string

    备份时间，格式为HH:mmZ-HH:mmZ（UTC时间）。

    		 09:00Z-10:00Z
    BackupRetentionPeriod string

    备份保留天数。

    		 30
    EnableBackupLog integer

    是否打开日志备份，取值说明：

    • 0：关闭（默认值）。
    • 1：打开。
    		 1
    LogBackupRetentionPeriod integer

    日志备份保留天数，取值范围：7~730。

    		 7
    SnapshotBackupType string

    快照备份类型，取值说明：

    • Flash：秒级备份。
    • Standard：常规备份（默认值）。
    		 Standard
    BackupInterval integer

    高频备份频率，取值说明：

    • -1：不开启高频备份。
    • 15：每15分钟。
    • 30：每30分钟。
    • 60：每1小时。
    • 120：每2小时。
    • 180：每3小时。
    • 240：每4小时。
    • 360：每6小时。
    • 480：每8小时。
    • 720：每12小时。
    		 -1

    示例

    正常返回示例

    JSON格式

    {
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1
}

    错误码

    访问错误中心查看更多错误码。