Querying the Restoration Time Range

Function

This API is used to query the restoration time range of a DB instance.

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 the required permissions in Permissions and Supported Actions.

• 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}/restore-time?date=2020-12-26

• Parameter description

  Table 1 Parameters

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
  instance_id	Yes	String	Definition Instance ID. Constraints N/A Range N/A Default Value N/A
  date	No	String	Definition Date to be queried. The value is in the "yyyy-mm-dd" format, and the time zone is UTC. Constraints N/A Range N/A Default Value N/A

Request

• Request parameters

  None

• URI example
  • Query all restoration time ranges of an instance.

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

  • Query the restoration time range based on a specified date.

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

Response

• Normal response

  Table 2 Parameters

  Parameter	Type	Description
  restore_time	Array of objects	Definition Restoration time ranges. For details, see Table 3.

  Table 3 restore_time field data structure description

  Parameter	Type	Description
  start_time	Integer	Definition 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 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

• Normal

  200

• Abnormal

  For details, see Status Codes.