DocsICP FilingConsole
Documentation

CreateRestoreTask

Updated at:
Copy as MD
Product
My Favorites

Creates a Database Backup (DBS) restore task.

Operation description

Related operations

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:CreateRestoreTask

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
BackupPlanId

string

Yes

The ID of the backup plan.

dbs1hvb0ww****
DestinationEndpointInstanceType

string

Yes

The location of the database. Valid values:

  • RDS

  • ECS

  • Express: databases connected over Express Connect circuits, VPN gateways, or Smart Access Gateway (SAG)

  • Agent: databases connected over backup gateways

  • DDS: ApsaraDB for MongoDB

  • Other: databases connected by using IP addresses and port numbers

  • dg: self-managed databases that have no public IP addresses or port numbers and are connected over Database Gateway

RDS
DestinationEndpointRegion

string

No

The region of the database instance.

Note

This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, Express, or Agent.

cn-hangzhou
DestinationEndpointInstanceID

string

No

The instance ID of the database.

Note

This parameter is required if DestinationEndpointInstanceType is set to RDS, ECS, DDS, or Express.

rm-bp1p8c29*****
DestinationEndpointIP

string

No

The database connection address.

Note

This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, or Other.

rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
DestinationEndpointPort

integer

No

The port number of the database.

Note

This parameter is required if DestinationEndpointInstanceType is set to Express, Agent, Other, or ECS.

3306
DestinationEndpointDatabaseName

string

No

The name of the database.

Note

This parameter is required if the database engine is PostgreSQL or MongoDB.

test
DestinationEndpointUserName

string

No

The username of the database account.

Note

This parameter is not required if the database engine is Redis, or if the database is connected over a backup gateway and the database engine is SQL Server. In other scenarios, this parameter is required.

test
DestinationEndpointPassword

string

No

The password of the database account.

Note

This parameter is not required if the database engine is Redis, or if the database is connected over a backup gateway and the database engine is SQL Server. In other scenarios, this parameter is required.

Test
BackupGatewayId

integer

No

The ID of the backup gateway.

Note

This parameter is required if DestinationEndpointInstanceType is set to Agent.

4312****
RestoreObjects

string

No

The objects to be restored.

  • For more information, see the definition of the RestoreObjects parameter below. This parameter is not required if the database is connected over a backup gateway. In other scenarios, this parameter is required.

  • Template: [{ "DBName": "Name of the database to be restored", "NewDBName": "Name of the destination database" }]

Note

Restoring objects by calling this API operation only supports restoration at the database level. To restore specific tables, go to the console. For more information, see Restore a database.

Example of MySQL table-level restoration: [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
RestoreTime

integer

No

The point in time to which you want to restore the database. The value is a UNIX timestamp in milliseconds.

1554560477000
BackupSetId

string

No

The ID of the full backup set used for restoration. This parameter and RestoreTime are mutually exclusive.

dbs1hvb0w*****
RestoreTaskName

string

Yes

The name of the restore task.

test
DestinationEndpointOracleSID

string

No

The Oracle SID.

Note

This parameter is required if the database engine is Oracle.

test
RestoreDir

string

No

This parameter is required if DestinationEndpointInstanceType is set to Agent and the backup plan is for MySQL.

test
RestoreHome

string

No

The directory of the database program.

test
DuplicateConflict

string

No

The method used to handle conflicts between objects with the same name. Valid values:

  • renamenew: renames the object if an object with the same name exists.

renamenew
CrossAliyunId

string

No

The UID of the Alibaba Cloud account used for cross-account backup.

2749528728********
CrossRoleName

string

No

The name of the RAM role used for cross-account backup.

test123
ClientToken

string

No

The client token that is used to ensure the idempotence of the request and prevent duplicate submissions.

ETnLKlblzczshOTUbOC********
RestoreDestinationMode

string

No

The method used to restore data to the destination. Valid values:

  • EXIST_INSTANCE: restores data to an existing instance.

  • NEW_INSTANCE: restores data to a new instance.

EXIST_INSTANCE
EnableDestinationEndpointSsl

boolean

No

Specifies whether to connect to the destination by using an SSL-encrypted connection.

true
SslCaPem

string

No

The credential for the SSL-encrypted connection to the destination.

-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
DestDatabaseInstanceType

string

No

The instance type of the new database to which data is restored.

rds
DestDatabaseInstanceRegion

string

No

The region of the new database instance to which data is restored.

cn-beijing
DestDatabaseInstanceVpc

string

No

The VPC of the new database instance to which data is restored.

vpc-xx
DestDatabaseInstanceClass

string

No

The instance specifications of the new database instance to which data is restored.

mysql.x4.large.2
DestDatabaseInstanceStorageSize

string

No

The instance storage size of the new database to recover.

500
DestDatabaseInstanceVSwitch

string

No

The vSwitch of the new database instance to which data is restored.

vsw-xx
DestDatabaseInstanceDatabaseVersion

string

No

The database engine version of the new database instance to which data is restored.

8.0
AutoOpenDatabase

string

No

Specifies whether to automatically start the instance after an Oracle physical backup is restored.

true
AutoShutdownDatabase

string

No

Specifies whether to automatically shut down the instance after an Oracle physical backup is restored.

true

Response elements

Element

Type

Description

Example

object

The details of the response parameters.

HttpStatusCode

integer

The HTTP status code.

200
RequestId

string

The ID of the request.

60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
ErrCode

string

The error code.

Param.NotFound
Success

boolean

Indicates whether the request was successful.

true
ErrMessage

string

The error message.

The specified parameter %s value is not valid.

RestoreTaskId

string

The ID of the restore task.

s102h*****

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "RestoreTaskId": "s102h*****"
}

Error codes

HTTP status code

Error code

Error message

Description
403 Request.Forbidden Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.