Creates a restoration task.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dbs:CreateRestoreTask | create |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BackupPlanId | string | Yes | The ID of the backup schedule. | dbs1hvb0ww**** |
| DestinationEndpointInstanceType | string | Yes | The location of the database. Valid values:
| RDS |
| DestinationEndpointRegion | string | No | The region ID of the destination database instance. Note
You must specify this parameter if DestinationEndpointInstanceType is set to RDS, ECS, DDS, Express, or Agent.
| cn-hangzhou |
| DestinationEndpointInstanceID | string | No | The ID of the database instance. Note
This parameter is required if the DestinationEndpointInstanceType parameter is set to RDS, ECS, DDS, or Express.
| rm-bp1p8c29***** |
| DestinationEndpointIP | string | No | The endpoint that is used to connect to the database. Note
This parameter is required if the DestinationEndpointInstanceType parameter is set to Express, Agent, or Other.
| rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com |
| DestinationEndpointPort | integer | No | The port of the database. Note
This parameter is required if the DestinationEndpointInstanceType parameter 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 is a PostgreSQL database or a MongoDB database.
| test |
| DestinationEndpointUserName | string | No | The username of the account that is used to connect to the database. Note
This 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 |
| DestinationEndpointPassword | string | No | The password of the account that is used to connect to the source database. Note
This 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 |
| BackupGatewayId | long | No | The ID of the backup gateway. Note
This parameter is required if the DestinationEndpointInstanceType parameter is set to Agent.
| 4312**** |
| RestoreObjects | string | No | The objects to be restored. Note
This 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"}] |
| RestoreTime | long | No | The time to run the restore task, such as 1554560477000. | 1554560477000 |
| BackupSetId | string | No | The ID of the full backup set. | dbs1hvb0w***** |
| RestoreTaskName | string | Yes | The name of the restore task. | test |
| DestinationEndpointOracleSID | string | No | The system ID (SID) of the Oracle database. Note
This parameter is required if the source database is an Oracle database.
| test |
| RestoreDir | string | No | 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 |
| RestoreHome | string | No | The program directory of the database. | test |
| DuplicateConflict | string | No | The method of processing objects with the same name. Valid values:
| renamenew |
| CrossAliyunId | string | No | The unique ID (UID) of the Alibaba Cloud account to which the source database belongs. | 2749528728******** |
| CrossRoleName | string | No | The name of the RAM role that is used to perform backups across Alibaba Cloud accounts. | test123 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. | ETnLKlblzczshOTUbOC******** |
Response parameters
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": "s102h*****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 403 | Request.Forbidden | Have no Permissions |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|