DescribeLogBackupPolicy - 查询集群日志备份保留策略 - 云原生数据库 PolarDB

查询PolarDB集群日志备份的保留策略。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeLogBackupPolicy	Read	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。说明您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。	pc-*****************

返回参数

名称	类型	描述	示例值
	object
LogBackupRetentionPeriod	integer	日志保留周期，取值范围如下： 3～7300：日志保留周期，单位天。 -1：长期保留。	7
RequestId	string	请求 id。	62EE0051-102B-488D-9C79-D607B8******
LogBackupAnotherRegionRetentionPeriod	string	日志备份跨地域备份保留周期。取值范围如下： 0：关闭日志备份跨地域备份功能。 30～7300：日志备份跨地域备份保留周期，单位为天。 -1：长期保留。说明创建集群时，默认取值为 0，即关闭日志备份跨地域备份功能。	0
LogBackupAnotherRegionRegion	string	日志备份跨地域备份区域。跨地域备份支持的地域请参见概述。	cn-beijing
EnableBackupLog	integer	是否开启日志备份，取值范围如下： 0：未开启。 1：开启（默认全部开启且不支持关闭）。	1

示例

正常返回示例

JSON格式

{
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。

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

变更历史

变更时间

变更内容概要

操作

2023-09-12

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 404 变更
	删除错误码：400

2022-06-01

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：404
出参	OpenAPI 返回结构发生变更。