Checking Whether Fast Restoration Can Be Used for Restoring Databases or Tables (RDS for MySQL)

Function

This API is used to check whether fast restoration can be used for restoring databases or tables of a DB instance.

Before calling an API, you need to understand the API in Authentication.

Constraints

This API is available to RDS for MySQL only.
Fast restoration is disabled by default. To use this function, contact customer service.

URI

URI format
POST /v3/{project_id}/instances/fast-restore

Parameter description

**Table 1** Parameters
Parameter	Mandatory	Description
project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
restore_time	Yes	String	Time point to which data is to be restored. 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 time zone offset is shown as +0800.
instance_ids	Yes	Array of strings	Instance IDs.

Example Request

Check whether fast restoration can be used for restoring databases or tables of a DB instance.

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/fast-restore
{
  "restore_time" : "2023-06-25T11:35:40+0800",
  "instance_ids" : [ "14fc6c06d7e842829ee91d11c6b88b3ain01" ]
}

Response

Normal response

**Table 3** Response body parameters
Parameter	Type	Description
support_fast_restore_list	Array of objects	Whether fast restoration is supported for the DB instance. For details, see Table 4.

**Table 4** support_fast_restore_list field data structure description
Parameter	Type	Description
instance_id	String	Instance ID.
is_support_fast_table_restore	Boolean	Whether fast restoration can be used for restoring tables.
is_support_fast_database_restore	Boolean	Whether fast restoration can be used for restoring databases.

Example normal response

{
  "support_fast_restore_list" : [ {
    "instance_id" : "14fc6c06d7e842829ee91d11c6b88b3ain01",
    "is_support_fast_table_restore" : true,
    "is_support_fast_database_restore" : true
  } ]
}