Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Backup and Restoration/ Querying the Backup Method of an Instance (RDS for PostgreSQL)
Updated on 2026-07-21 GMT+08:00
View PDF
Share

Querying the Backup Method of an Instance (RDS for PostgreSQL)

Function

This API is used to query the backup method of an instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:getBackupConfiguration

read

-

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Constraints

  • To use this function in certain regions, submit a service ticket to request required permissions.
  • This API is available only for RDS for PostgreSQL.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/backups/config

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

None

Example Request

Query the backup method of an instance.

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/backups/config

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    default_backup_method

    String

    Definition

    Backup method.

    Range

    • EBACKUP: CBR snapshot backup
    • PHYSICALBACKUP: physical backup
  • Example normal response 
    { 
  "default_backup_method" : "EBACKUP" 
}
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration