doc-exports/docs/opengauss/api-ref/opengauss_newapi_0026.html

Querying the Restoration Time Range

Function

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

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• Obtain the required region and endpoint.

URI

• URI format

  GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time?date={date}

• Example

  https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/d2113b7c60154636b94bea1320b6a874in14/restore-time?date=2022-04-17

• Parameter description

  Table 1 Parameter description

  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	Instance ID.
  date	Yes	String	Date to be queried. The value is in the "yyyy-mm-dd" format, and the time zone is UTC.

Request

None

Response

• Normal response

  Table 2 Parameter description

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

  Table 3 restore_time field data structure description

  Parameter	Type	Description
  start_time	Long	Start time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.
  end_time	Long	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": 1652084311000,
            "end_time": 1652092839000
        },
        {
            "start_time": 1652092847000,
            "end_time": 1652094792000
        }
    ]
}

• 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.

Parent topic: Backup Management