详情页标题前

阿里云RDS数据库DescribeBackupPolicy – 查看实例备份设置-云淘科技

• 阿里云数据库
详情页1

该接口用于查询RDS实例的备份设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试阿里云RDS数据库DescribeBackupPolicy - 查看实例备份设置-云淘科技调试

授权信息

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

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

请求参数

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

实例ID。可调用DescribeDBInstances获取。

 rm-uf6wjk5****
BackupPolicyMode string 否

备份类型，取值：

  • DataBackupPolicy：数据备份
  • LogBackupPolicy：日志备份
 DataBackupPolicy
CompressType string 否

备份压缩方式，取值：

  • 0：不压缩
  • 1：zlib压缩
  • 2：并行zlib压缩
  • 4：quicklz压缩，开启了库表恢复
  • 8：MySQL8.0 quicklz压缩但是还未支持库表恢复
 1
ReleasedKeepPolicy string 否

已删除实例的归档备份保留策略。取值：

  • None：不保留
  • Lastest：保留最后一个
  • All：全部保留
 Lastest

返回参数

名称 类型 描述 示例值
object

返回参数详情。
LogBackupRetentionPeriod integer

日志备份保留天数。

 7
ArchiveBackupKeepPolicy string

归档备份的保留周期。

 ByMonth
ArchiveBackupKeepCount string

归档备份的保留个数。

 1
LocalLogRetentionHours integer

本地日志备份保留小时数。

 0
BackupRetentionPeriod integer

数据备份保留天数。

 7
RequestId string

请求ID。

 B87E2AB3-B7C9-4394-9160-7F639F732031
PreferredBackupPeriod string

数据备份周期，多个取值用英文逗号（,）隔开。返回值：

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
 Monday,Wednesday,Friday,Sunday
CompressType string

备份压缩方式。返回值：

  • 0：不压缩
  • 1：zlib压缩
  • 2：并行zlib压缩
  • 4：quicklz压缩，开启了库表恢复
  • 8：MySQL8.0 quicklz压缩但是还未支持库表恢复
 1
SupportReleasedKeep integer

备用参数。

 0
LocalLogRetentionSpace string

本地日志最大空间使用率。

 30
SupportVolumeShadowCopy integer

实例是否支持快照备份。返回值：

  • 1：是
  • 0：否

说明
仅SQL Server实例会返回此参数。

1
BackupMethodstring

实例的备份方式。返回值：

  • Physical：物理备份
  • Snapshot：快照备份

说明
仅SQL Server云盘版实例会返回本参数。

Physical
LogBackupFrequencystring

日志备份频率。返回值：

  • LogInterval：每30分钟备份一次；
  • 默认与数据备份周期PreferredBackupPeriod一致。

说明
参数LogBackupFrequency仅适用于SQL Server。

LogInterval
PreferredNextBackupTimestring

下次备份时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。

 2018-01-19T15:15Z
HighSpaceUsageProtection string

实例使用空间大于80%，或者剩余空间小于5GB时，是否强制清理Binlog：

  • Disable：不清理
  • Enable：清理
 Enable
ArchiveBackupRetentionPeriod string

归档备份的保留天数。

 365
BackupInterval string

备份间隔，单位：分钟。

  • 对于MySQL实例是指快照备份频率（非快照备份周期）。
  • 对于SQL Server实例是指日志备份频率。
 30
ReleasedKeepPolicy string

已删除实例的归档备份保留策略。返回值：

  • None：不保留
  • Lastest：保留最后一个
  • All：全部保留
 None
PreferredBackupTime string

数据备份时间，格式：HH:mmZ-HH:mmZ（UTC时间）。

 15:00Z-16:00Z
LogBackupLocalRetentionNumber integer

本地Binlog保留个数。

 60
Category string

是否开启秒级备份。返回值：

  • Flash：开启
  • Standard：关闭

说明
仅在BackupPolicyMode参数为DataBackupPolicy时生效。

Standard
EnableBackupLogstring

是否开启日志备份，返回值：

  • 1：开启
  • 0：关闭
 1
BackupLog string

是否已开启日志备份。返回值：

  • Enable：是
  • Disabled：否
 Enable
EnableIncrementDataBackup boolean

是否已开启增量备份。返回值：

  • True：是
  • False：否
 True
SupportModifyBackupPriority boolean

是否支持修改备库备份选项。返回值：

  • True：是
  • False：否
 False
BackupPriority integer

备库备份的设置。返回值：

  • 1：优先备库
  • 2：强制主库

说明
该参数仅适用于SQL Server企业集群版实例，仅当SupportModifyBackupPriority为True时返回该参数。

2

示例

正常返回示例

JSON格式

{
  "LogBackupRetentionPeriod": 7,
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupKeepCount": "1",
  "LocalLogRetentionHours": 0,
  "BackupRetentionPeriod": 7,
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "CompressType": "1",
  "SupportReleasedKeep": 0,
  "LocalLogRetentionSpace": "30",
  "SupportVolumeShadowCopy": 1,
  "BackupMethod": "Physical",
  "LogBackupFrequency": "LogInterval",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "HighSpaceUsageProtection": "Enable",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "ReleasedKeepPolicy": "None",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "LogBackupLocalRetentionNumber": 60,
  "Category": "Standard",
  "EnableBackupLog": "1",
  "BackupLog": "Enable",
  "EnableIncrementDataBackup": true,
  "SupportModifyBackupPriority": true,
  "BackupPriority": 2
}

错误码

HTTP status code 错误码 错误信息 描述
400 IO.Exception IO exception, retry later. io异常。
400 InternalFailure Internal failure, retry later. 请求失败，请稍后重试。
400 InvalidParameter.OwnerAccount The specified parameter OwnerAccount is not valid. 操作失败，参数OwnerAccount不合法，请检查。
400 InvalidEngine.Malformed Specified engine is not valid. 当前数据库引擎无效，请选择正确的数据库引擎。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 当前实例状态不支持此操作。
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. 指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404 InvalidDBInstanceName.NotFound Invalid DBInstanceId NotFound. 数据库实例ID不存在，请检查。

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

变更历史

变更时间 变更内容概要 操作
2023-06-29 OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码：400
    删除错误码：403
    删除错误码：404
出参 OpenAPI 返回结构发生变更
2022-06-24 OpenAPI 描述信息更新，OpenAPI 错误码发生变更 看变更集
变更项 变更内容
API 描述 OpenAPI 描述信息更新
错误码 OpenAPI 错误码发生变更
    删除错误码：400
    删除错误码：404

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

阿里云企业补贴进行中： 马上申请

腾讯云限时活动1折起，即将结束： 马上收藏

同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠

转转请注明出处：https://www.yunxiaoer.com/156520.html

赞 (0)
0
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

相关推荐

  • 阿里云ECS云服务器UntagResources-云淘科技

    调用UntagResources为指定的EBS资源统一解绑标签。 接口说明 每次解绑的标签数量不能超过20个。 任一标签在解绑后，如果没有绑定任何实例，则该标签会被删除。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 请求参数 名称 类型 是否必…

    阿里云服务器 2023年12月9日
  • 阿里云RDS数据库复制数据库SQL Server 2008 R2版-云淘科技 阿里云数据库

    阿里云RDS数据库复制数据库SQL Server 2008 R2版-云淘科技

    若您需要创建一个与现有数据库数据完全相同的数据库，您可以使用复制数据库的方式。本文介绍如何通过RDS控制台复制并创建新的数据库。 前提条件 实例版本为SQL Server 2008 R2。 说明 SQL Server 2008 R2（本地盘）实例支持通过RDS控制台复制并创建新的数据库，不支持复制数据库到其他实例。具体操作，请参见复制数据库。 SQL Ser…

    2023年12月9日
  • 信息流广告，信息流部分建议宽度830px，只针对默认列表样式，顺序随机

  • 阿里云RDS数据库创建账号-云淘科技

    本文介绍如何为RDS MariaDB实例创建账号。 账号类型 RDS MariaDB实例支持两种数据库账号：高权限账号和普通账号。您可以在控制台管理所有账号和数据库。 账号类型 说明 高权限账号 只能通过控制台或API创建和管理。 一个实例中只能创建一个高权限账号，可以管理所有普通账号和数据库。 开放了更多权限，可满足个性化和精细化的权限管理需求，例如可按用…

    阿里云数据库 2023年12月9日
  • 阿里云大数据开发治理平台 DataWorks批量操作-云淘科技 阿里云大数据开发治理平台 DataWorks

    阿里云大数据开发治理平台 DataWorks批量操作-云淘科技

    DataWorks支持对节点、资源、函数进行批量修改责任人等批量编辑操作，并支持批量提交并发布，将变更操作发布至生产环境生效。本文为您介绍批量操作的界面入口及详细指导。 操作步骤 登录DataWorks控制台，进入数据开发页面后，在顶部的快捷操作按钮中单击批量操作按钮，即可打开批量操作页面。 批量修改。 在批量操作页面中，您可以在顶部页签中选择对节点、资源或…

    2023年12月10日

  • 阿里云RDS数据库使用限制-云淘科技

    为保障实例的稳定及安全，云数据库MariaDB有部分使用上的约束。 RDS MariaDB的使用限制详情如下表所示。 操作 使用约束 修改实例参数设置 大部分实例参数可以使用控制台或API进行修改，同时出于安全和稳定性考虑，部分参数不支持修改，具体请参见设置实例参数。 数据库的root权限 不提供root或者sa权限。 数据库备份 可使用命令行或图形界面进行…

    阿里云数据库 2023年12月9日

联系我们

400-800-8888

在线咨询： QQ交谈

邮件：admin@example.com

工作时间：周一至周五，9:30-18:30，节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。