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 this API, learn how to authenticate it.
Before calling this API, learn about the request header parameters.

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 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
rds:instance:tableRestore	write	-	-	-	-

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	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A

Request

**Table 2** Parameters
Parameter	Mandatory	Type	Description
restore_time	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A
instance_ids	Yes	Array of strings	Definition Instance IDs. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

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	Definition 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	Definition Instance ID. Range N/A
is_support_fast_table_restore	Boolean	Definition Whether fast restoration can be used for restoring tables. Range true: Fast restoration is supported. false: Fast restoration is not supported.
is_support_fast_database_restore	Boolean	Definition Whether fast restoration can be used for restoring databases. Range true: Fast restoration is supported. false: Fast restoration is not supported.

Example normal response

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