DescribeBackupPolicy
调用DescribeBackupPolicy接口查看实例备份设置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeBackupPolicy |
系统规定参数,取值:DescribeBackupPolicy。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxx |
实例ID。 |
BackupPolicyMode | String | 否 | DataBackupPolicy |
备份类型,取值:
|
CompressType | String | 否 | 1 |
备份压缩方式,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | B87E2AB3-B7C9-4394-9160-7F639F732031 |
请求ID。 |
BackupRetentionPeriod | Integer | 7 |
数据备份保留天数。 |
PreferredNextBackupTime | String | 2018-01-19T15:15Z |
下次备份时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。 |
PreferredBackupTime | String | 15:00Z-16:00Z |
数据备份时间,格式:HH:mmZ-HH:mmZ(UTC时间)。 |
PreferredBackupPeriod | String | Monday,Wednesday,Friday,Sunday |
数据备份周期,多个取值用英文逗号(,)隔开,取值:
|
BackupLog | String | Enable |
日志备份开关,取值:Enable | Disabled |
LogBackupRetentionPeriod | Integer | 7 |
日志备份保留天数。 |
EnableBackupLog | String | 1 |
是否开启日志备份,取值:
|
LocalLogRetentionHours | Integer | 0 |
本地日志备份保留小时数。 |
LocalLogRetentionSpace | String | 30 |
本地日志最大空间使用率。 |
Duplication | String | Enable |
是否将备份文件转储至OSS,取值:Enable | Disabled |
DuplicationContent | String | DATA&LOG |
转储数据备份或者日志备份,取值:
说明 当Duplication=Enable时,本参数必填。
|
HighSpaceUsageProtection | String | Enable |
实例使用空间大于80%,或者剩余空间小于5GB时,是否强制清理Binlog:
|
LogBackupFrequency | String | LogInterval |
日志备份频率,取值:
说明 参数LogBackupFrequency仅适用于SQL Server。
|
CompressType | String | 1 |
备份压缩方式,取值:
|
ArchiveBackupRetentionPeriod | String | 365 |
归档备份的保留天数。 |
ArchiveBackupKeepPolicy | String | ByMonth |
归档备份的保留周期。 |
ArchiveBackupKeepCount | String | 1 |
归档备份的保留个数。 |
ReleasedKeepPolicy | String | None |
已删除实例的归档备份保留策略。取值:
|
LogBackupLocalRetentionNumber | Integer | 60 |
本地Binlog保留个数。 |
DuplicationLocation | Struct |
备份文件的存储位置。 |
|
Sotrage | String | OSS |
备份存储的介质。通常保存在OSS上。 |
Location | Struct |
位置信息。 |
|
Endpoint | String | oss-cn-shanghai.aliyuncs.com |
转储目的域的名称。 |
Bucket | String | mybucket |
转储的目标OSS Bucket的名称。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>
正常返回示例
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"
}
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>
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论