文档中心

云数据库 PostgreSQL 版

备份与恢复

DescribeDetachedBackups

DescribeDetachedBackups

调用 DescribeDetachedBackups 接口查询已删除实例备份。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
BackupId	String	否	20231016-024****	备份 ID。
InstanceId	String	否	postgres-5704170c****	实例 ID。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
InstanceName	String	否	测试实例	实例名称。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupStartTime	String	否	2022-01-01T10:10:10.000Z	备份创建最早时间。以备份开始时间为准。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupEndTime	String	否	2022-01-01T10:10:10.000Z	备份创建最晚时间。以备份开始时间为准。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
ProjectName	String	否	Test	实例所属的项目。说明无默认值。不传该字段时返回其他参数所限定的查询条件下所有备份。
BackupStatus	String	否	Success	备份状态。可不设置，默认取值为 Success，即查询状态为成功的备份。
BackupType	String	否	Full	备份类型。可不设置，默认值取值为 Full，即查询全量备份。
PageNumber	Integer	否	1	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	10	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。

返回参数

参数	类型	示例值	描述
Total	Integer	1	备份总数。
Backups	Array of BackupsInfo	请参见返回示例。	备份列表。

BackupsInfo

参数	类型	示例值	描述
BackupId	String	20231016-024**_20231017-125**	备份 ID。
BackupFileName	String	20230508-021**_20230511-141**	备份文件名称。
BackupStatus	String	Success	备份状态，取值： Success：成功。 Failed：失败。 Running：执行中。
BackupProgress	Integer	70	备份进展百分比。当 BackupStatus 为 Success 时，BackupProgress 为 100。当 BackupStatus 为 Running 时，BackupProgress 最小为 0，最大为 100。
BackupType	String	Full	备份类型，取值： Full：全量备份（默认）。 Increment：增量备份。
CreateType	String	System	创建类型，取值： System：系统。 User：用户。说明无默认值。不指定时，则返回其他查询条件限定的备份。
BackupFileSize	Long	41750219	备份文件大小，单位为 Byte。
BackupStartTime	String	2022-01-01T10:10:10.000Z	备份的开始时间，格式 yyyy-MM-dd HH:mm:ss.sssZ（UTC 时间）。
BackupEndTime	String	2022-01-01T10:10:10.000Z	备份的结束时间，格式 yyyy-MM-dd HH:mm:ss.sssZ（UTC 时间）。
InstanceInfo	Object of InstanceInfoObject	请参见返回示例。	实例信息。

InstanceInfoObject

参数	类型	示例值	描述
AllowListIds	Array of String	[ "acl-fdd6293f300143f2a4932bb483c8**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	备份所属实例绑定的白名单的信息。
ChargeDetail	Object of ChargeDetailObject	请参见返回示例。	实例计费信息。
DBEngineVersion	String	PostgreSQL_12	兼容版本。取值： PostgreSQL_11：PostgreSQL 11。 PostgreSQL_12：PostgreSQL 12。 PostgreSQL_13：PostgreSQL 13。 PostgreSQL_14：PostgreSQL 14。 PostgreSQL_15：PostgreSQL 15。 PostgreSQL_16：PostgreSQL 16。 PostgreSQL_17：PostgreSQL 17。 PostgreSQL_18：PostgreSQL 18。
InstanceId	String	postgres-21a3333b****	实例 ID。
InstanceName	String	test-instance-name	实例名称。
InstanceStatus	String	Running	实例状态，取值： Running：运行中。 Creating：创建中。 Deleting：删除中。 Restarting：重启中。 Restoring：恢复中。 Updating：变更中。 Upgrading：升级中。 Error：错误。 Released：已释放。 CreateError：创建错误。 MasterChanging：主节点切换中。 Deleted：已删除。 Recycled：已回收。
InstanceType	String	HA	实例类型。取值：HA（高可用版）。
Memory	Integer	2	内存大小。单位：GB。
Nodes	Array of NodeObject	请参见返回示例。	实例节点信息。
ProjectName	String	testProject	项目名称。
StorageSpace	Integer	200	实例总存储空间。单位：GB。
StorageType	String	LocalSSD	实例存储类型。取固定值 LocalSSD（本地 SSD 盘）。
SubnetId	String	subnet-30vhlwb1el0qo7r2qr2c5****	子网 ID。
VCPU	Integer	1	CPU 大小。例如：1 表示 1U。
VpcId	String	vpc-3rebt5uf5fr405zsk2if9****	私有网络（VPC） ID。
ZoneId	String	cn-beijing-a	可用区 ID。

ChargeDetailObject

参数	类型	示例值	描述
ChargeType	String	PostPaid	付费类型。取值： PostPaid：按量付费。 PrePaid：包年包月（默认）。
AutoRenew	Boolean	true	预付费场景下是否自动续费。 true：自动续费。 false：不自动续费（默认）。
Number	Integer	1	实例数量。
PeriodUnit	String	Month	预付费场景下的购买周期。 Month：包月（默认）。 Year：包年。
Period	Integer	1	预付费场景下的购买时长。默认值：1。
ChargeStatus	String	Normal	付费状态。取值： Normal：正常。 Overdue：欠费。 Unpaid：等待支付。
ChargeStartTime	String	2023-01-10T11:13:30.000Z	实例的计费开始时间。
ChargeEndTime	String	2023-01-10T11:13:34.000Z	包年包月实例的计费到期时间。
OverdueTime	String	2023-01-10T11:13:30.000Z	实例的欠费关停时间。
OverdueReclaimTime	String	2023-01-15T16:00:00.000Z	实例欠费关停后的预计释放时间。
TempModifyStartTime	String	2023-12-01T10:10:10.000Z	临时升配的开始时间。说明当实例处于临时升配期时返回。如果对实例进行了多次连续的临时升配，此处返回的为首次临时升配的开始时间。
TempModifyEndTime	String	2023-12-07T10:10:09.000Z	临时升配的还原时间。说明当实例处于临时升配期时返回。

NodeObject

参数	类型	示例值	描述
InstanceId	String	postgres-ca7b7019****	实例 ID。
NodeId	String	postgres-ca7b7019****-zgqy	节点 ID。
RegionId	String	cn-beijing	地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。
ZoneId	String	cn-beijing-a	可用区 ID。
NodeType	String	Primary	节点类型，取值为： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。
NodeStatus	String	Running	节点状态。
NodeSpec	String	rds.postgres.1c2g	节点规格。
VCPU	Integer	4	CPU大小。例如：1 表示 1U。
Memory	Integer	16	内存大小，单位为 GB。
CreateTime	String	2022-01-01T10:10:10Z	节点创建的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。
UpdateTime	String	2022-01-01T10:10:10Z	节点更新的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

示例

请求示例

返回示例

最近更新时间：2026.10.16 14:22:31

这个页面对您有帮助吗？

有用

有用

无用

无用