All Products
Search

This Product

    Data Management:CreateRestoreTask

    Document Center

    Data Management:CreateRestoreTask

    Last Updated:Dec 01, 2025

    Creates a Database Backup Service (DBS) restore job.

    Operation description

    Related documents

    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: a database connected over a leased line, VPN Gateway, or Smart Access Gateway.

    • Agent: a database connected using a backup gateway.

    • DDS: a cloud MongoDB instance.

    • Other: a database connected over the Internet.

    • dg: a self-managed database that does not have a public IP address and port. This type of database is connected using Database Gateway (DG).

    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 ID of the database instance.

    Note

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

    rm-bp1p8c29*****
    DestinationEndpointIP

    string

    No

    The database endpoint.

    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 database port.

    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 type is PostgreSQL or MongoDB.

    test
    DestinationEndpointUserName

    string

    No

    The database account.

    Note

    This parameter is not required if the database type is Redis, or if DestinationEndpointInstanceType is set to agent and the database type is MSSQL. In other scenarios, this parameter is required.

    test
    DestinationEndpointPassword

    string

    No

    The password.

    Note

    This parameter is not required if the database type is Redis, or if DestinationEndpointInstanceType is set to agent and the database type is MSSQL. 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 restore.

    • This parameter is not required if DestinationEndpointInstanceType is set to agent. In other scenarios, this parameter is required.

    • Template: [{ "DBName": "source_database_name", "NewDBName": "destination_database_name" }]

    Note

    When you use this API operation, you can only restore objects at the database level. To restore specific tables, use the console. For more information, see Restore a database.

    MySQL表级别恢复示例如下： [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
    RestoreTime

    integer

    No

    The restore time, specified as a Unix timestamp in milliseconds.

    1554560477000
    BackupSetId

    string

    No

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

    dbs1hvb0w*****
    RestoreTaskName

    string

    Yes

    The name of the restore job.

    test
    DestinationEndpointOracleSID

    string

    No

    The Oracle system ID (SID).

    Note

    This parameter is required if the database type is Oracle.

    test
    RestoreDir

    string

    No

    This parameter is required if DestinationEndpointInstanceType is set to agent and the backup plan is for a MySQL database.

    test
    RestoreHome

    string

    No

    The directory of the database program.

    test
    DuplicateConflict

    string

    No

    The policy for handling conflicts with objects that have the same name. The following value is supported:

    renamenew: If an object with the same name exists, rename the new object.

    renamenew
    CrossAliyunId

    string

    No

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

    2749528728********
    CrossRoleName

    string

    No

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

    test123
    ClientToken

    string

    No

    A client token used to ensure the idempotence of the request. This prevents duplicate submissions.

    ETnLKlblzczshOTUbOC********

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    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 job.

    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.