DescribeBackupPolicy - 查询实例备份设置 - 云原生数据库 PolarDB

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeBackupPolicy

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属地域的 ID。	cn-hangzhou
DBInstanceName	string	是	实例名称。	pxc-********

返回参数

名称	类型	描述	示例值
	object	返回数据。
Message	string	返回信息，成功返回 success，错误返回对应错误码。	success
RequestId	string	请求 ID。	B87E2AB3-B7C9-4394-9160-7F639F732031
Success	boolean	请求是否成功。	true
Data	object	返回体。
LogLocalRetentionSpace	integer
DBInstanceName	string
BackupWay	string
BackupPeriod	string
ForceCleanOnHighSpaceUsage	integer
BackupType	string
LocalLogRetention	integer
RemoveLogRetention	integer
BackupPlanBegin	string
BackupSetRetention	integer
IsEnabled	integer
ColdDataBackupInterval	integer
ColdDataBackupRetention	integer
LocalLogRetentionNumber	integer
IsCrossRegionDataBackupEnabled	boolean
IsCrossRegionLogBackupEnabled	boolean
DestCrossRegion	string
CrossRegionDataBackupRetention	integer
CrossRegionLogBackupRetention	integer
CrossRegionFilterValue	string

示例

正常返回示例

JSON格式

{
  "Message": "success",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "Success": true,
  "Data": {
    "LogLocalRetentionSpace": 0,
    "DBInstanceName": "",
    "BackupWay": "",
    "BackupPeriod": "",
    "ForceCleanOnHighSpaceUsage": 0,
    "BackupType": "",
    "LocalLogRetention": 0,
    "RemoveLogRetention": 0,
    "BackupPlanBegin": "",
    "BackupSetRetention": 0,
    "IsEnabled": 0,
    "ColdDataBackupInterval": 0,
    "ColdDataBackupRetention": 0,
    "LocalLogRetentionNumber": 0,
    "IsCrossRegionDataBackupEnabled": true,
    "IsCrossRegionLogBackupEnabled": true,
    "DestCrossRegion": "",
    "CrossRegionDataBackupRetention": 0,
    "CrossRegionLogBackupRetention": 0,
    "CrossRegionFilterValue": ""
  }
}

错误码

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

变更历史

更多信息，参考变更详情。