DescribeBackupPolicy - 查看集群自动备份策略 - 云原生数据库 PolarDB

调用DescribeBackupPolicy接口查看备份策略设置详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
drds:DescribeBackupPolicy	Read	instance acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*	无	无

请求参数

名称	类型	必填	描述	示例值
DrdsInstanceId	string	是	实例 ID。	drdshbga71nn****

返回参数

名称	类型	描述	示例值
	object
Success	boolean	操作是否成功。取值：true：成功。false：失败。	true
RequestId	string	请求 ID。	8FAF3989-79CD-4A67-8FFD-97899B64SD5T
BackupPolicyDO	object	备份策略设置详情。
BackupDbName	string	此 api 无返回	null
LogBackupRetentionPeriod	long	日志备份保留天数。	10
DataBackupRetentionPeriod	long	数据备份保留时，单位为天。	10
BackupType	string	备份类型，取值范围如下： manual：手动备份 auto：自动备份	auto
BackupLevel	string	备份级别，取值范围如下： db：数据库级别 instance：实例级别	db
LocalLogRetentionHours	long	此 api 无返回	0
HighSpaceUsageProtection	long	此 api 无返回
GmtModified	long	此 api 无返回	0
BackupRetentionPeriod	long	备份保留天数。	8
BackupPolicyMode	string	备份策略模式，取值范围如下： DataBackupPolicy：数据备份策略 LogBackupPolicy：日志备份策略	DataBackupPolicy
PreferredBackupPeriod	string	备份周期，允许传入多个时间周期，多个周期间用英文逗号（,）分隔，取值范围如下： 1: 星期日 2: 星期一 3: 星期二 4: 星期三 5: 星期四 6: 星期五 7: 星期六	2
LocalLogRetentionSpace	long	此 api 无返回	0
BackupAppName	string	此 api 无返回	null
PreferredBackupTime	string	备份的时间段（UTC 时间）。	22:00:00-23:00:00
GmtCreate	long	此 api 无返回	0
BackupMode	string	备份方式，取值范围如下： logic：逻辑备份 phy：快速备份	phy
BackupLog	string	是否开启备份日志，取值范围如下： 1：开启 0：关闭	1
NextBackupActuallyTime	string	此 api 无返回	null

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "8FAF3989-79CD-4A67-8FFD-97899B64SD5T",
  "BackupPolicyDO": {
    "BackupDbName": "null",
    "LogBackupRetentionPeriod": 10,
    "DataBackupRetentionPeriod": 10,
    "BackupType": "auto",
    "BackupLevel": "db",
    "LocalLogRetentionHours": 0,
    "HighSpaceUsageProtection": 0,
    "GmtModified": 0,
    "BackupRetentionPeriod": 8,
    "BackupPolicyMode": "DataBackupPolicy",
    "PreferredBackupPeriod": "2",
    "LocalLogRetentionSpace": 0,
    "BackupAppName": "null",
    "PreferredBackupTime": "22:00:00-23:00:00",
    "GmtCreate": 0,
    "BackupMode": "phy",
    "BackupLog": "1",
    "NextBackupActuallyTime": "null"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	请求失败，内部错误

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史