Updated on 2026-07-16 GMT+08:00

Querying the Restoration Time Range

Function

This API is used to query the restoration time range of an instance. Before calling this API:

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/restore-time

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance. For details about how to obtain the instance ID, see Querying DB Instances.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

date

Yes

String

Definition

Date to be queried.

Constraints

N/A

Range

The value is a 10-character string in the yyyy-mm-dd format, consisting only of digits and hyphens (-).

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn: Chinese
  • en-us: English

Default Value

en-us

Response Parameters

Table 3 Parameter description

Parameter

Type

Description

restore_time

Array of objects

Definition

Restoration time ranges.

For details, see Table 4.

Table 4 restore_time field data structure description

Parameter

Type

Description

start_time

Long

Definition

Start time of the recoverable time range, formatted as a UNIX timestamp in milliseconds (UTC).

Range

N/A

end_time

Long

Definition

End time of the recoverable time range, formatted as a UNIX timestamp in milliseconds (UTC).

Range

N/A

Example Request

Querying the restoration time range

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/d2113b7c60154636b94bea1320b6a874in14/restore-time?date=2022-04-17

Example Response

Restoration time range queried.

{
    "restore_time": [
        {
            "start_time": 1652084311000,
            "end_time": 1652092839000
        },
        {
            "start_time": 1652092847000,
            "end_time": 1652094792000
        }
    ]
}

Status Codes

Error Codes

For details, see Error Codes.