调用DescribeBackupPolicy接口查询实例备份设置_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeBackupPolicy	系统规定参数。取值：DescribeBackupPolicy。
RegionId	String	是	cn-hangzhou	实例所属地域的ID。
DBInstanceName	String	是	pxc-********	实例名称。

返回数据

名称	类型	示例值	描述
Message	String	success	返回信息，成功返回success，错误返回对应错误码。
RequestId	String	B87E2AB3-B7C9-4394-9160-7F639F732031	请求ID。
Success	Boolean	true	请求是否成功。
Data	Array of Account		返回体。
LogLocalRetentionSpace	Integer	30	本地日志最大空间使用率。
DBInstanceName	String	pxc-xxxxxx	实例ID。
BackupWay	String	P	备份方法： L：逻辑备份 P：物理备份
BackupPeriod	String	1001000	备份周期。至少需要指定2天，7位数数值，从左到右每一位数值代表周一到周日是否开启备份。取值0代表不备份，取值1代表备份：第一位数值：周一第二位数值：周二第三位数值：周三第四位数值：周四第五位数值：周五第六位数值：周六第七位数值：周日
ForceCleanOnHighSpaceUsage	Integer	1	实例使用空间大于80%，或者剩余空间小于50 GB时，是否强制清理Binlog： 0：不清理 1：清理
BackupType	String	0	备份类型： 0：快速备份； 1：一致性备份。
LocalLogRetention	Integer	30	本地日志备份保留小时数。
RemoveLogRetention	Integer	7	日志备份远程保留天数（ 7~730）单位：天，默认7天。
BackupPlanBegin	String	03:00Z	用户计划备份开始时间段。
BackupSetRetention	Integer	7	备份集保留时间。
IsEnabled	Integer	1	是否开启日志备份，取值： 1：表示开启 0：表示关闭
ColdDataBackupInterval	Integer	30	冷数据备份间隔天数，取值范围为1~59。
ColdDataBackupRetention	Integer	30	冷数据备份保留天数，取值范围为30~730。
LocalLogRetentionNumber	Integer	60	本地Binlog保留个数，默认为60，取值范围为6~100。
IsCrossRegionDataBackupEnabled	Boolean	false	是否开启跨地域数据备份，默认为false。
IsCrossRegionLogBackupEnabled	Boolean	false	是否开启跨地域日志备份，默认为false。
DestCrossRegion	String	cn-shanghai	跨地域备份的目标地域。
CrossRegionDataBackupRetention	Integer	30	跨地域数据备份的保存时间，单位：天。
CrossRegionLogBackupRetention	Integer	30	跨地域日志备份的保存时间，单位：天。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupPolicy
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupPolicyResponse>
    <Message>success</Message>
    <RequestId>B87E2AB3-B7C9-4394-9160-7F639F732031</RequestId>
    <Success>true</Success>
    <Data>
        <LogLocalRetentionSpace>30</LogLocalRetentionSpace>
        <DBInstanceName>pxc-xxxxxx</DBInstanceName>
        <BackupWay>P</BackupWay>
        <BackupPeriod>1001000</BackupPeriod>
        <ForceCleanOnHighSpaceUsage>1</ForceCleanOnHighSpaceUsage>
        <BackupType>0</BackupType>
        <LocalLogRetention>30</LocalLogRetention>
        <RemoveLogRetention>7</RemoveLogRetention>
        <BackupPlanBegin>03:00Z</BackupPlanBegin>
        <BackupSetRetention>7</BackupSetRetention>
        <IsEnabled>1</IsEnabled>
        <ColdDataBackupInterval>30</ColdDataBackupInterval>
        <ColdDataBackupRetention>30</ColdDataBackupRetention>
        <LocalLogRetentionNumber>60</LocalLogRetentionNumber>
        <IsCrossRegionDataBackupEnabled>false</IsCrossRegionDataBackupEnabled>
        <IsCrossRegionLogBackupEnabled>false</IsCrossRegionLogBackupEnabled>
        <DestCrossRegion>cn-shanghai</DestCrossRegion>
        <CrossRegionDataBackupRetention>30</CrossRegionDataBackupRetention>
        <CrossRegionLogBackupRetention>30</CrossRegionLogBackupRetention>
    </Data>
</DescribeBackupPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "Success" : true,
  "Data" : [ {
    "LogLocalRetentionSpace" : 30,
    "DBInstanceName" : "pxc-xxxxxx",
    "BackupWay" : "P",
    "BackupPeriod" : "1001000",
    "ForceCleanOnHighSpaceUsage" : 1,
    "BackupType" : "0",
    "LocalLogRetention" : 30,
    "RemoveLogRetention" : 7,
    "BackupPlanBegin" : "03:00Z",
    "BackupSetRetention" : 7,
    "IsEnabled" : 1,
    "ColdDataBackupInterval" : 30,
    "ColdDataBackupRetention" : 30,
    "LocalLogRetentionNumber" : 60,
    "IsCrossRegionDataBackupEnabled" : false,
    "IsCrossRegionLogBackupEnabled" : false,
    "DestCrossRegion" : "cn-shanghai",
    "CrossRegionDataBackupRetention" : 30,
    "CrossRegionLogBackupRetention" : 30
  } ]
}

错误码

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