全部产品
Search
文档中心

云原生数据库 PolarDB:DescribeBackupLocal - 查看本地备份集

更新时间:Jul 10, 2026

调用DescribeBackupLocal接口查看本地日志设置。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
drds:DescribeBackupLocal
*instance
acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

请求参数

名称类型必填描述示例值
DrdsInstanceIdstring

DRDS 实例 ID。

drds************

返回参数

名称类型描述示例值
object
Successboolean

请求结果。

true
RequestIdstring

请求 ID。

FDC9CFD5-306D-4A23-9D8C-057274C6****
BackupPolicyDOobject

备份策略设置详情。

BackupDbNamestring

本 Api 无此返回

null
LogBackupRetentionPeriodlong

本 Api 无此返回

0
DataBackupRetentionPeriodlong

本 Api 无此返回

0
BackupTypestring

本 Api 无此返回

null
BackupLevelstring

本 Api 无此返回

null
LocalLogRetentionHourslong

日志备份本地保留小时数,取值范围为 0~168,0 表示不保留,默认值为 18

18
HighSpaceUsageProtectionlong

当实例使用空间超过 90%或剩余空间小于 5GB 时,是否开启无条件清理 Binlog,取值范围如下:

  • 1:开启
  • 0:不开启
1
GmtModifiedlong

本 Api 无此返回

0
BackupRetentionPeriodlong

本 Api 无此返回

0
BackupPolicyModestring

本 Api 无此返回

null
PreferredBackupPeriodstring

本 Api 无此返回

null
LocalLogRetentionSpacelong

本地日志最大空间使用率。 取值范围为 0~50,此为循环空间,默认为 30

30
BackupAppNamestring

本 Api 无此返回

null
PreferredBackupTimestring

本 Api 无此返回

null
GmtCreatelong

本 Api 无此返回

0
BackupModestring

本 Api 无此返回

null
BackupLogstring

本 Api 无此返回

null
NextBackupActuallyTimestring

本 Api 无此返回

null

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "FDC9CFD5-306D-4A23-9D8C-057274C6****",
  "BackupPolicyDO": {
    "BackupDbName": null,
    "LogBackupRetentionPeriod": 0,
    "DataBackupRetentionPeriod": 0,
    "BackupType": null,
    "BackupLevel": null,
    "LocalLogRetentionHours": 18,
    "HighSpaceUsageProtection": 1,
    "GmtModified": 0,
    "BackupRetentionPeriod": 0,
    "BackupPolicyMode": null,
    "PreferredBackupPeriod": null,
    "LocalLogRetentionSpace": 30,
    "BackupAppName": null,
    "PreferredBackupTime": null,
    "GmtCreate": 0,
    "BackupMode": null,
    "BackupLog": null,
    "NextBackupActuallyTime": null
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
暂无变更历史