Querying the Restoration Time Ranges

Function

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

Constraints

Currently, this API only supports replica set instances and cluster instances 4.0.

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 Policies 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
dds:backup:getRestoreTimeList	read	-	-	dds:instance:list	-

URI

URI format
GET /v3/{project_id}/instances/{instance_id}/restore-time
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	path	Definition Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Name	Mandatory	Type	IN	Description
date	Yes	string	query	Definition The 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 Parameters

**Table 3** Request Parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 4** Parameter description
Name	Mandatory	Type	Description
restore_time	Yes	Array of objects	Definition The restoration time ranges. For details, see Table 5. Range N/A

**Table 5** restore_time description
Name	Mandatory	Type	Description
start_time	Yes	Long	Definition 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	Yes	Long	Definition 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 Request

GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12

Example Response

{
  "restore_time": [
    {
      "start_time": 1607731200000,
      "end_time": 1607756414000
    },
    {
      "start_time": 1607756825000,
      "end_time": 1607761999000
    },
    {
      "start_time": 1607762943000,
      "end_time": 1607817599000
    }
  ]
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.