Call the DescribeDetachedBackups API to query the backup of a deleted instance.

Request type

Synchronous request.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameter	Type	Required?	Example	Description
BackupId	String	No	20231016-024****	Backup ID.
InstanceId	String	No	postgres-5704170c****	Instance ID. tip Default value. If this field is not specified, all backups limited by other query conditions are returned.
InstanceName	String	No	Test instance	Storage type. tip Default value. If this field is not specified, all backups limited by other query conditions are returned.
BackupStartTime	String	No	2022-01-01T10:10:10.000Z	Earliest backup creation time. Based on backup start time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time). tip Default value. If this field is not specified, all backups limited by other query conditions are returned.
BackupEndTime	String	No	2022-01-01T10:10:10.000Z	Latest backup creation time. Based on backup start time. Format: yyyy-MM-ddTHH:mm:ss.sssZ (UTC time). tip Default value. If this field is not specified, all backups limited by other query conditions are returned.
ProjectName	String	No	Test	The project to which the instance belongs. tip Default value. If this field is not specified, all backups limited by other query conditions are returned.
BackupStatus	String	No	Success	Backup status. Optional. Default value is Success, which means querying backups with a successful status.
BackupType	String	No	Full	Backup type. Optional. Default value is Full, which means full backups are queried.
PageNumber	Integer	No	1	The query offset of the current page. The default value is 1.
PageSize	Integer	No	10	The number of records on each page. The value must be greater than 0 and no more than 1,000. The default value is 10.

Response parameters

Parameter	Type	Example	Description
Total	Integer	1	Total number of backups.
Backups	Array of BackupsInfo	Refer to the sample response.	Backup list.

BackupsInfo

Parameter	Type	Example	Description
BackupId	String	20231016-024**_20231017-125**	Backup ID.
BackupFileName	String	20230508-021**_20230511-141**	Backup file name.
BackupStatus	String	Success	Backup status, values: Succeeded: succeeded. Failed: failed. In progress: in progress.
BackupProgress	Integer	70	Backup progress percentage. When BackupStatus is Success, BackupProgress is 100. When BackupStatus is Running, BackupProgress ranges from 0 to 100.
BackupType	String	Full	Backup type, values: Full: full backup (default). Increment: incremental backup.
CreateType	String	System	Create type. Value range: System: system. User: user. tip Default value. If not specified, return backups limited by other query conditions.
BackupFileSize	Long	41750219	Backup file size in bytes.
BackupStartTime	String	2022-01-01T10:10:10.000Z	Backup start time, in the format yyyy-MM-dd HH:mm:ss.sssZ (UTC time).
BackupEndTime	String	2022-01-01T10:10:10.000Z	Backup end time, in the format yyyy-MM-dd HH:mm:ss.sssZ (UTC time).
InstanceInfo	Object of InstanceInfoObject	Refer to the sample response.	Summary.

InstanceInfoObject

Parameter	Type	Example	Description
AllowListIds	Array of String	[ "acl-fdd6293f300143f2a4932bb483c8**", "acl-ded4c0b707e44efd8f0dbc4e88f5**" ]	Information about the allowlist associated with the instance to which the backup belongs.
ChargeDetail	Object of ChargeDetailObject	Refer to the Sample response.	Instance billing information.
DBEngineVersion	String	PostgreSQL_12	Compatible version. Values: 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****	Instance ID.
InstanceName	String	test-instance-name	Storage type.
InstanceStatus	String	Running	Instance state, values: Running: running. Creating: creating. Deleting: deleting. Restarting: Restarting. Restoring: recovering. Updating: modifying. Upgrading: upgrading. Error: error. Released: released. CreateError: create error. MasterChanging: primary node switching. Deleted: Deleted. Recycled: recycled.
InstanceType	String	HA	Instance type. Value: HA (High-availability Edition).
Memory	Integer	2	Memory size. Unit: GB.
Nodes	Array of NodeObject	Refer to the sample response.	Instance node information.
ProjectName	String	testProject	Project name.
StorageSpace	Integer	200	The storage space for the instance. Unit: GB.
StorageType	String	LocalSSD	Instance storage type. Fixed value LocalSSD (local SSD disk).
SubnetId	String	subnet-30vhlwb1el0qo7r2qr2c5****	Subnet ID.
VCPU	Integer	1	CPU size. For example: 1 indicates 1U.
VpcId	String	vpc-3rebt5uf5fr405zsk2if9****	Virtual private cloud (VPC) ID.
ZoneId	String	cn-beijing-a	Availability zone ID.

ChargeDetailObject

Parameter	Type	Example	Description
ChargeType	String	PostPaid	Payment type. Values: PostPaid: pay-as-you-go. PrePaid: subscription (default).
AutoRenew	Boolean	true	Is automatic renewal enabled for the prepaid scenario? yes: automatic renewal. false: no automatic renewal (default).
Number	Integer	1	Number of instances.
PeriodUnit	String	Month	Purchase period for prepaid scenarios. Month: monthly (default). Year: subscription.
Period	Integer	1	Subscription duration in a prepaid scenario. default value: 1.
ChargeStatus	String	Normal	Payment status. Values: Normal: normal. Overdue: overdue. Overdue: waiting for payment.
ChargeStartTime	String	2023-01-10T11:13:30.000Z	Instance billing start time.
ChargeEndTime	String	2023-01-10T11:13:34.000Z	Subscription instance expiration time.
OverdueTime	String	2023-01-10T11:13:30.000Z	Overdue shutdown time of the instance.
OverdueReclaimTime	String	2023-01-15T16:00:00.000Z	Estimated release time after the instance is suspended due to overdue payments.
TempModifyStartTime	String	2023-12-01T10:10:10.000Z	Start time of temporary upgrade. tip Return when the instance is under temporary upgrade. If multiple consecutive temporary upgrades are performed on the instance, this returns the start time of the first temporary upgrade.
TempModifyEndTime	String	2023-12-07T10:10:09.000Z	Restoration time of temporary upgrade. tip Return when the instance is under temporary upgrade.

NodeObject

Parameter	Type	Example	Description
InstanceId	String	postgres-ca7b7019****	Instance ID.
NodeId	String	postgres-ca7b7019****-zgqy	Node ID.
RegionId	String	cn-beijing	Region ID. You can call the DescribeRegions API to query the list of available regions. Use this parameter to specify the region where you want to create the instance.
ZoneId	String	cn-beijing-a	Availability zone ID.
NodeType	String	Primary	Node type, with values: Primary: Primary node. Secondary: indicates the secondary node. ReadOnly: Read-only node.
NodeStatus	String	Running	Node status.
NodeSpec	String	rds.postgres.1c2g	Node specification.
VCPU	Integer	4	CPU size. For example: 1 means 1U.
Memory	Integer	16	Memory size. Unit is GB.
CreateTime	String	2022-01-01T10:10:10Z	Node creation time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).
UpdateTime	String	2022-01-01T10:10:10Z	Node update time. Format is yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).

Example

Sample request

Sample response

RDS for PostgreSQL