Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Backup and Restoration/ Querying the Restoration Time Range of a Cross-Region Backup
Updated on 2026-02-04 GMT+08:00
View PDF
Share

Querying the Restoration Time Range of a Cross-Region Backup

Function

This API is used to query the restoration time range of a cross-region backup in the backup target region.

If the backup retention period has been set to a long period, you are advised to set the query date by referring to Table 1.

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:getRestoreTime

read

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:list

-

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/offsite-restore-time?date=2020-12-26

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    Constraints

    The value cannot be empty.

    Range

    To obtain the value, see Obtaining a Project ID.

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

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

    Default Value

    N/A

    date

    No

    Definition

    Date to be queried, in the yyyy-mm-dd format and in the UTC time zone.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

  • Request parameters

    None

  • URI example
    • Querying all restoration time ranges of a cross-region backup

      GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time

    • Querying the restoration time range of a cross-region backup based on a specified date

      GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/offsite-restore-time?date=2020-12-26

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    restore_time

    Array of objects

    Definition

    Indicates the list of restoration time ranges.

    For details, see Table 3.
    Table 3 restore_time field data structure description

    Parameter

    Type

    Description

    start_time

    Integer

    Definition

    Indicates the start time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

    Range

    N/A

    end_time

    Integer

    Definition

    Indicates the end time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

    Range

    N/A
  • Example normal response 
    { 
	"restore_time": [ 
		{ 
			"start_time": 1532001446987, 
			"end_time": 1532742139000 
		} 
	] 
}
  • Abnormal Response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: Backup and Restoration