Querying Databases Contained in a Database-Level Backup (RDS for PostgreSQL)

Function

This API is used to query databases contained in a database-level backup.

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/database/db-table-name?backup_id={backup_id}

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints The value cannot be empty. Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. Constraints The value cannot be empty. Range N/A Default Value N/A
backup_id	Yes	String	Definition Backup ID. Constraints The value cannot be empty. Range N/A Default Value N/A

Request

None

Example Request

Query databases contained in a database-level backup.

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
databases	Array of objects	Definition Database information. For details, see Table 3. Range N/A
database_limit	Integer	Definition Number of databases that can be restored from a backup. Range N/A
bucket_name	String	Definition OBS bucket name. Range N/A

**Table 3** databases field description
Parameter	Type	Description
database_name	String	Definition Database name. Range N/A
backup_file_name	String	Definition Name of the backup file. Range N/A
backup_file_size	Long	Definition Size of the backup file. Range N/A

Example normal response

{ 
    "bucket_name": "backet1", 
    "databases": [ 
        { 
            "database_name": "databases1", 
            "backup_file_name": "file1", 
            "backup_file_size": 10 
        }, 
        { 
            "database_name": "databases2", 
            "backup_file_name": "file2", 
            "backup_file_size": 11 
        }, 
        { 
            "database_name": "databases3", 
            "backup_file_name": "file3", 
            "backup_file_size": 12 
        }, 
    ], 
    "database_limit": 50 
}