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 MySQL instance with 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

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    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 get its ID.

    cn-hangzhou
    Host

    string

    Yes

    The IP address of the source MySQL host. RDS uses this IP address to get a backup.

    172.20.246.90
    Port

    integer

    Yes

    The port of the source MySQL host.

    3306
    StreamPort

    integer

    Yes

    The streaming port that is used to transfer the backup.

    9999
    User

    string

    Yes

    The source MySQL account. This account must have the permissions to create backups and set up replication. For the required permissions, see the following 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 account. The password must be Base64-encoded.

    OEF5JjVOM2pzZXFKRw==
    SourcePlatform

    string

    No

    The source instance type.

    ECS
    SourceInstanceId

    string

    No

    The source instance ID.

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