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.

• Before calling an API, you need to understand the API in Authentication.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.
  date	No	Specifies the date to be queried. The value is in the yyyy-mm-dd format, and the time zone is UTC.

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 Parameter description

  Name	Type	Description
  restore_time	Array of objects	Indicates the list of restoration time ranges. For details, see Table 3.

  Table 3 restore_time field data structure description

  Name	Type	Description
  start_time	Integer	Indicates the start time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.
  end_time	Integer	Indicates the end time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.

• Example normal response

  { 
  	"restore_time": [ 
  		{ 
  			"start_time": 1532001446987, 
  			"end_time": 1532742139000 
  		} 
  	] 
  }

• Abnormal Response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.