All Products
Search
Document Center

Database Backup:CreateRestoreTask

Last Updated:Mar 27, 2023

Creates a restore task.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociation operation
dbs:CreateRestoreTaskRead
    All Resources
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule.

dbs1hvb0wwXXXX
DestinationEndpointInstanceTypestringYes

The location of the database. Valid values:

  • RDS
  • ECS
  • Express: The database is connected to Database Backup (DBS) by using Express Connect, VPN Gateway, or Smart Access Gateway.
  • Agent: The database is connected to DBS over a DBS backup gateway.
  • DDS: The database is an ApsaraDB for MongoDB database.
  • Other: The database is connected to DBS by using the IP address and port of the database.
RDS
DestinationEndpointRegionstringNo

The region in which the database is deployed.

NoteThis parameter is required if the DestinationEndpointInstanceType parameter is set to RDS, ECS, DDS, Express, or Agent.
100.X.X.10:33204
DestinationEndpointInstanceIDstringNo

The ID of the database instance.

NoteThis parameter is required if the DestinationEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.
rm-bp1p8c29XXXXX
DestinationEndpointIPstringNo

The endpoint that is used to connect to the database.

NoteThis parameter is required if the DestinationEndpointInstanceType parameter is set to Express, Agent, or Other.
rm-bpXXXXX9jv8pxero.mysql.rds.aliyuncs.com
DestinationEndpointPortintegerNo

The port of the database.

NoteThis parameter is required if the DestinationEndpointInstanceType parameter is set to Express, Agent, Other, or ECS.
3306
DestinationEndpointDatabaseNamestringNo

The name of the database.

NoteThis parameter is required if the database is a PostgreSQL database or a MongoDB database.
test
DestinationEndpointUserNamestringNo

The username of the account that is used to connect to the database.

NoteThis parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.
test
DestinationEndpointPasswordstringNo

The password of the account that is used to connect to the source database.

NoteThis parameter is required except that the database is an SQL Server database that is connected to DBS over a DBS backup gateway or a Redis database.
Test
BackupGatewayIdlongNo

The ID of the backup gateway.

NoteThis parameter is required if the DestinationEndpointInstanceType parameter is set to Agent.
43123424
RestoreObjectsstringNo

The objects to be restored.

NoteThis parameter is required except that the DestinationEndpointInstanceType parameter is set to Agent. For information about the parameter definition, see RestoreObjects.
\[ { "DBName":"Name of the database to be restored", "NewDBName":"Name of the database to which the objects will be restored", "SchemaName":"Schema name of the database to be restored", "NewSchemaName":"Schema name of the destination database to which the objects will be restored"}]
RestoreTimelongNo

The time to run the restore task, such as 1554560477000.

1554560477000
BackupSetIdstringNo

The ID of the full backup set that is used to restore data. This parameter is mutually exclusive with the RestoreTime parameter.

dbs1hvb0wXXXXX
RestoreTaskNamestringYes

The name of the restore task.

test
DestinationEndpointOracleSIDstringNo

The system ID (SID) of the Oracle database.

NoteThis parameter is required if the source database is an Oracle database.
test
RestoreDirstringNo

This parameter is required if the DestinationEndpointInstanceType parameter is set to Agent and the backup object of the backup schedule is a MySQL database.

test
RestoreHomestringNo

The program directory of the database.

test
DuplicateConflictstringNo

The method of processing objects with the same name. Valid values:

  • failure: The restore task fails if the system detects objects with the same name. This is the default value.
  • renamenew: The restore task renames objects with the same name starting from the second occurrence.
failure
CrossAliyunIdstringNo

The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs.

2xxx7778xxxxxxxxxx
CrossRoleNamestringNo

The name of the RAM role that can be used to perform backups cross Alibaba Cloud accounts.

test123
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
RequestIdstring

The ID of the request.

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

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
RestoreTaskIdstring

The ID of the restore task.

s102hXXXXX

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.