Querying the Restoration Time Range (a V3 API)

Function

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

URI

GET /v3/{project_id}/instances/{instance_id}/backups/restorable-time-interval

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID.
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Which page the server starts returning items Constraints N/A Range The value is greater than or equal to 0. Default Value 0
limit	No	Integer	Definition Number of records on each page Constraints N/A Range The value is greater than 0 and less than or equal to 128. Default Value 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
restorable_time_intervals	Array of RestoreTimeInterval objects	Restoration time point.
offset	Integer	Which page the server starts returning items
limit	Integer	Number of records displayed on each page
total	Integer	Total number of records

**Table 5** RestoreTimeInterval
Parameter	Type	Description
start_time	String	Start time in UTC, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.
end_time	String	End time in UTC, accurate to milliseconds. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Request

Querying the restoration time range

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/1f5c9fd6cd984056ba89c8c87cc03278in09/backups/restorable-time-interval

Example Response

Status code: 200

{
	"restorable_time_intervals": [{
		"start_time": "2025-05-20T09:40:40+0000",
		"end_time": "2025-05-21T11:15:43+0000"
	}],
	"offset": 0,
	"limit": 10,
	"total": 1
}

Status code: 400

Bad request

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status code: 500

Server error

{
  "error_msg" : "Parameter error.",
  "error_code" : "DBS.280001"
}

Status Codes

Status Codes	Description
200	OK
400	Bad request
500	Server error

Error Codes

For details, see Error Codes.

Parent topic: Backup Management

Previous topic: Querying Data Nodes Associated with an Instance at a Restoration Time Point (a V3 API)

Next topic: Querying Data Nodes Available to Restore Data to a Point in Time (a V3 API)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot