DescribeBackups_云数据库 PolarDB_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为200/60(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
polardb:DescribeBackups
Get
Backup
acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}
DBCluster
acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

请求参数

字段名称字段详情
DBClusterIdstring

集群 ID。

示例值:pc-****************参考取值来源:
    ModifyDBCluster
    CreateDBCluster
    DescribeDBClusters
    RestartDBLink
    EnableDBClusterServerless
    TransformDBClusterPayType
    DisableDBClusterServerless
BackupIdstring

备份 ID。

示例值:11111111参考取值来源:
    DescribeDetachedBackups
BackupStatusstring

备份状态,取值范围如下:展开详情

示例值:Success
BackupModestring

备份模式,取值范围如下: 展开详情

示例值:Automated参考取值来源:
    DescribeDetachedBackups
StartTimestring

查询开始时间,格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

示例值:2020-11-14T00:00Z
EndTimestring

查询结束时间,查询结束时间需晚于开始时间,格式为YYYY-MM-DDThh:mmZ(UTC 时间)。

示例值:2020-11-16T00:00Z
BackupRegionstring

跨地域备份的目的地域。展开详情

示例值:cn-hangzhou
PageSizeinteger<int32>

每页记录数,取值范围如下: 展开详情

示例值:30取值 <= 100
PageNumberinteger<int32>

页码,取值范围为大于 0 但不超过 Integer 最大值的整数,默认值为 1

示例值:1取值 <= 2147483647

返回参数

字段名称字段详情
TotalRecordCountstring

总记录数。

示例值:1
PageRecordCountstring

本页记录数。

示例值:1
RequestIdstring

请求 ID。

示例值:24A1990B-4F6E-482B-B8CB-75C612******
PageNumberstring

页码。

示例值:1
Itemsobject
TotalLevel2BackupSizestring

指定地域的二级备份总大小,单位为 Byte。展开详情

示例值:4639948800

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidDBClusterId.Malformed
The specified parameter DBClusterId is not valid.诊断
400
InvalidBackupStatus.Malformed
The specified parameter BackupStatus is not valid.诊断
400
InvalidBackupMode.Malformed
The specified parameter BackupMode is not valid.诊断
400
InvalidStartTime.Malformed
The specified parameter StartTime is not valid.诊断
400
InvalidEndTime.Malformed
The specified parameter EndTime is not valid.诊断
400
InvalidPageSize.Malformed
The specified parameter PageSize is not valid.诊断
400
InvalidPageNumber.Malformed
The specified parameter PageNumber is not valid.诊断
404
InvalidDBCluster.NotFound
The DBClusterId provided does not exist in our records.诊断
404
InvalidDBClusterId.NotFound
The DBInstanceId provided does not exist in our records.诊断

变更历史

变更时间变更内容概要操作
2024-11-14
变更返回参数
2023-09-12
变更错误码400
变更错误码404
2023-05-26
变更返回参数
2022-07-25
新增错误码400
2022-06-01
新增请求参数BackupRegion