调用DescribeBackupPolicy接口查询实例备份设置。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupPolicy

系统规定参数,取值:DescribeBackupPolicy

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

BackupPolicyMode String DataBackupPolicy

备份类型,取值:

  • DataBackupPolicy:数据备份
  • LogBackupPolicy:日志备份
CompressType String 1

备份压缩方式,取值:

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

返回数据

名称 类型 示例值 描述
BackupRetentionPeriod Integer 7

数据备份保留天数。

PreferredBackupTime String 15:00Z-16:00Z

数据备份时间,格式:HH:mmZ-HH:mmZ(UTC时间)。

PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

数据备份周期,多个取值用英文逗号(,)隔开,取值:

  • Monday:周一
  • Tuesday:周二
  • Wednesday:周三
  • Thursday:周四
  • Friday:周五
  • Saturday:周六
  • Sunday:周日
BackupLog String Enable

日志备份开关,取值:Enable | Disabled

LogBackupRetentionPeriod Integer 7

日志备份保留天数。

Duplication String Enable

是否将备份文件转储至OSS,取值:Enable | Disabled

DuplicationContent String DATA&LOG

转储数据备份或者日志备份,取值:

  • DATA:转储数据备份
  • LOG:转储日志备份
  • DATA&LOG:转储数据备份和日志备份
说明Duplication=Enable时,本参数必填。
DuplicationLocation Struct

备份文件的存储位置。

Location Struct

位置信息。

Bucket String mybucket

转储的目标OSS Bucket的名称。

Endpoint String oss-cn-shanghai.aliyuncs.com

转储目的域的名称。

Sotrage String OSS

备份存储的介质。通常保存在OSS上。

EnableBackupLog String 1

是否开启日志备份,取值:

  • 1:表示开启
  • 0:表示关闭
HighSpaceUsageProtection String Enable

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

  • Disable:不清理
  • Enable:清理
LocalLogRetentionHours Integer 0

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

LocalLogRetentionSpace String 30

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

LogBackupFrequency String LogInterval

日志备份频率,取值:

  • LogInterval:每30分钟备份一次;
  • 默认与数据备份周期PreferredBackupPeriod一致。
说明 参数LogBackupFrequency仅适用于SQL Server。
PreferredNextBackupTime String 2018-01-19T15:15Z

下次备份时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

RequestId String B87E2AB3-B7C9-4394-9160-7F639F732031

请求ID。

ArchiveBackupKeepCount String 1

归档备份的保留个数。

ArchiveBackupKeepPolicy String ByMonth

归档备份的保留周期。

ArchiveBackupRetentionPeriod String 365

归档备份的保留天数。

Category String HighAvailability

实例系列,取值:

  • Basic:基础版
  • HighAvailability:高可用版
  • AlwaysOn:集群版
  • Finance:三节点企业版
CompressType String 1

备份压缩方式,取值:

  • 0:不压缩
  • 1:zlib压缩
  • 2:并行zlib压缩
  • 4:quicklz压缩,开启了库表恢复
  • 8:MySQL8.0 quicklz压缩但是还未支持库表恢复
LogBackupLocalRetentionNumber Integer 60

本地Binlog保留个数。

ReleasedKeepPolicy String None

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

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

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<DescribeBackupPolicyResponse>
  <LogBackupRetentionPeriod>100</LogBackupRetentionPeriod>
  <LogBackupFrequency></LogBackupFrequency>
  <HighSpaceUsageProtection>Enable</HighSpaceUsageProtection>
  <DuplicationLocation>
        <Location>
              <Bucket></Bucket>
              <Endpoint></Endpoint>
        </Location>
        <Sotrage>OSS</Sotrage>
  </DuplicationLocation>
  <ArchiveBackupKeepPolicy>ByMonth</ArchiveBackupKeepPolicy>
  <CompressType>4</CompressType>
  <Duplication></Duplication>
  <LocalLogRetentionHours>18</LocalLogRetentionHours>
  <EnableBackupLog>1</EnableBackupLog>
  <PreferredNextBackupTime>2019-12-24T07:56Z</PreferredNextBackupTime>
  <BackupLog>Enable</BackupLog>
  <ArchiveBackupKeepCount>1</ArchiveBackupKeepCount>
  <PreferredBackupPeriod>Monday,Tuesday</PreferredBackupPeriod>
  <ArchiveBackupRetentionPeriod>0</ArchiveBackupRetentionPeriod>
  <RequestId>E48F2D79-C580-44DB-B756-AB21B5DAA3A7</RequestId>
  <DuplicationContent></DuplicationContent>
  <ReleasedKeepPolicy>None</ReleasedKeepPolicy>
  <BackupRetentionPeriod>7</BackupRetentionPeriod>
  <PreferredBackupTime>07:00Z-08:00Z</PreferredBackupTime>
  <LogBackupLocalRetentionNumber>50</LogBackupLocalRetentionNumber>
  <LocalLogRetentionSpace>30</LocalLogRetentionSpace>
</DescribeBackupPolicyResponse>

JSON 格式

{
	"LogBackupRetentionPeriod": "100",
	"LogBackupFrequency": "",
	"HighSpaceUsageProtection": "Enable",
	"DuplicationLocation": {
		"Location": {
			"Bucket": "",
			"Endpoint": ""
		},
		"Sotrage": "OSS"
	},
	"ArchiveBackupKeepPolicy": "ByMonth",
	"CompressType": "4",
	"Duplication": "",
	"LocalLogRetentionHours": "18",
	"EnableBackupLog": "1",
	"PreferredNextBackupTime": "2019-12-24T07:56Z",
	"BackupLog": "Enable",
	"ArchiveBackupKeepCount": 1,
	"PreferredBackupPeriod": "Monday,Tuesday",
	"ArchiveBackupRetentionPeriod": 0,
	"RequestId": "E48F2D79-C580-44DB-B756-AB21B5DAA3A7",
	"DuplicationContent": "",
	"ReleasedKeepPolicy": "None",
	"BackupRetentionPeriod": 7,
	"PreferredBackupTime": "07:00Z-08:00Z",
	"LogBackupLocalRetentionNumber": 50,
	"LocalLogRetentionSpace": "30"
}

错误码

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