全部产品
Search

搜索本产品

    云数据库 MongoDB：DescribeBackupPolicy - 查看实例的自动备份策略

    文档中心

    云数据库 MongoDB：DescribeBackupPolicy - 查看实例的自动备份策略

    更新时间：Sep 29, 2024

    查询MongoDB实例的备份策略。

    调试

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

    授权信息

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

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

    请求参数

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

    实例 ID。

    		dds-bp16cb162771****
    InstanceTypestring否

    实例类型。

    • replicate: 副本集实例
    • sharding: 分片集群实例
    		sharding
    SrcRegionstring否

    实例所在地域。

    		cn-beijing

    返回参数

    名称类型描述示例值
    object

    返回数据。

    PreferredBackupPeriodstring

    备份周期，取值说明：

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

    请求 ID。

    		5A9464CA-F7DC-5434-90B1-DF7F197C****
    PreferredBackupTimestring

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

    		09:00Z-10:00Z
    BackupRetentionPeriodstring

    备份保留天数。

    		30
    PreferredNextBackupTimestring

    下次常规备份时间，格式为yyyy-mm-ddthh:mmz（utc 时间）。

    		2024-06-19T19:11Z
    EnableBackupLoginteger

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

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

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

    		7
    SnapshotBackupTypestring

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

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

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

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

    高频备份保留天数，单位为天。

    		1
    BackupRetentionPolicyOnClusterDeletioninteger

    备份保留策略。

    1. 0：实例释放时立即删除该实例的所有备份集
    2. 1：实例释放时会自动备份，长期保留该备份集
    3. 2：实例释放时会自动备份，并长期保留该集群的所有备份集

    详细信息请参见：长期保留备份

    		0
    SrcRegionstring

    源实例所在区域。

    		cn-hangzhou
    DestRegionstring

    异地备份所在地域。

    		cn-shenzhen
    CrossRetentionTypestring

    异地备份保留类型。

    • delay: 保留一段时间

    • never: 不过期

    		delay
    CrossRetentionValueinteger

    异地备份保留时长。

    		7
    CrossBackupPeriodstring

    异地备份的保留时间。

    1. Monday：周一。
    2. Tuesday：周二。
    3. Wednesday：周三。
    4. Thursday：周四。
    5. Friday：周五。
    6. Saturday：周六。
    7. Sunday：周日。
    说明 异地备份必填
    		Monday
    EnableCrossLogBackupinteger

    是否开启跨地域日志备份 。

    说明 异地备份必填
  • 1： 打开 (分片集群必须为 1)
  • 0： 关闭 (副本实例必须为 0)
    •
    		1
    CrossLogRetentionTypestring

    异地日志备份保留类型。

    • delay: 保留一段时间
    • never: 不过期
    		delay
    CrossLogRetentionValueinteger

    异地日志备份保留时长。

    		7

    示例

    正常返回示例

    JSON格式

    {
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1,
  "HighFrequencyBackupRetention": "1",
  "BackupRetentionPolicyOnClusterDeletion": 0,
  "SrcRegion": "cn-hangzhou",
  "DestRegion": "cn-shenzhen",
  "CrossRetentionType": "delay",
  "CrossRetentionValue": 7,
  "CrossBackupPeriod": "Monday",
  "EnableCrossLogBackup": 1,
  "CrossLogRetentionType": "delay",
  "CrossLogRetentionValue": 7
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-06-25OpenAPI 返回结构发生变更查看变更详情
    2024-02-22OpenAPI 返回结构发生变更查看变更详情