All Products
Search

This Product

    ApsaraDB RDS:CreateImportTask

    Document Center

    ApsaraDB RDS:CreateImportTask

    Last Updated:Apr 18, 2026

    Creates a data import task.

    Operation description

    Creates a data import task to import data into an RDS for MySQL instance that uses native replication.

    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

    rds:CreateImportTask

    create

    *All Resource

    *

    		 None None

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the DescribeRegions operation to query the latest region list.

    cn-hangzhou
    Host

    string

    Yes

    The IP address of the source MySQL database. RDS accesses this IP address to obtain a backup.

    172.20.246.90
    Port

    integer

    Yes

    The port of the source MySQL database.

    3306
    StreamPort

    integer

    Yes

    The streaming port used to transfer the backup.

    9999
    User

    string

    Yes

    The user of the source MySQL database. This user requires permissions to create backups and set up replication. For more information, see the following sample SQL statements:

    -- MySQL 5.7
mysql> CREATE USER 'myadmin'@'%' IDENTIFIED BY 's3cret';
mysql> GRANT RELOAD, LOCK TABLES, PROCESS, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO
       'myadmin'@'%';
mysql> FLUSH PRIVILEGES;
-- MySQL 8.0
mysql> CREATE USER 'myadmin'@'%' IDENTIFIED BY 'Test123!';
mysql> GRANT BACKUP_ADMIN, PROCESS, RELOAD, LOCK TABLES, REPLICATION CLIENT, REPLICATION SLAVE ON *.* TO 'myadmin'@'%';
mysql> GRANT SELECT ON performance_schema.log_status TO 'myadmin'@'%';
mysql> GRANT SELECT ON performance_schema.keyring_component_status TO myadmin@'%';
mysql> GRANT SELECT ON performance_schema.replication_group_members TO myadmin@'%';
mysql> FLUSH PRIVILEGES;

    myadmin
    Password

    string

    Yes

    The password for the source MySQL user. It must be Base64-encoded.

    OEF5JjVOM2pzZXFKRw==
    SourcePlatform

    string

    No

    The type of the cloud instance that hosts the source database.

    ECS
    SourceInstanceId

    string

    No

    The ID of the cloud instance that hosts the source database.

    i-bp1fe296n52ub3chezpg
    XtrabackupPath

    string

    No

    The installation path of xtrabackup on the source server.

    /usr/bin/xtrabackup
    DbInstanceId

    string

    Yes

    The ID of the destination RDS instance.

    rm-bp1u*****ggm7j9j
    EstimatedSize

    integer

    No

    The estimated data size, in GB.

    1000

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

    8B993DA9-5272-5414-94E3-4CA8BA0146C2
    TaskId

    string

    The import task ID.

    3384382

    Examples

    Success response

    JSON format

    {
  "RequestId": "8B993DA9-5272-5414-94E3-4CA8BA0146C2",
  "TaskId": "3384382"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 INVALID_SOURCE_INSTANCE.RDS_CUSTOM Source RdsCustom instance is not valid to import, please check instance attributes. The source RdsCustom instance cannot be used for RDS data import. Check the instance properties.
    400 InvalidParam %s. Parameter error, please check the parameters.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.