CreateDataImportTask - PolarDB - Alibaba Cloud Documentation Center

Creates a data import task to import external data files such as SQL scripts and CSV files into a target database instance.

Operation description

The CreateDataImportTask operation creates a data import task that supports importing SQL or CSV files stored in OSS, ECS, or directly uploaded into a target database instance. By specifying the instance ID, database name, engine type, data source (such as an OSS path), and import type, the system performs data write operations asynchronously or synchronously. This operation is applicable to scenarios such as data migration, initialization, and data backfill. A task ID is returned for subsequent status queries and management.

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

polardbx:CreateDataImportTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the instance resides. > You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-hangzhou
DBInstanceName	string	No	The instance ID. > You can call the DescribeDBInstances operation to query the details of all instances in the target region, including instance IDs.	pxc-********
SrcResId	string	No	The ID of the source ApsaraDB RDS instance. > You can call the DescribeDrivingAccess operation to query the details of all source ApsaraDB RDS instances in the target region, including instance IDs.	pxc-shrnv****kh87z
SrcDb	string	No	The database information of the migration source when the source database is ApsaraDB RDS for MySQL. > The source database must be consistent with the target database.	transfer_for_st
SrcUserName	string	No	The username of the source instance.	drds_test
SrcPassword	string	No	The read/write mode for executing the import task on the source instance. Valid values: * rw: read/write. * ro: read-only.	******
DstResId	string	No	The migration task ID.	pxc-shr8****k36vrn
DstDb	string	No	The execution status of the target SQL import. Valid values: * importing: importing. * success: import succeeded. * fail: import failed.	transfer_test3
DstUserName	string	No	The username of the target instance.	bbt_cms_prod
DstPassword	string	No	The password of the privileged account for the target ApsaraDB RDS instance. > * You can call the DescribeDBInstances operation to query the privileged account information of the target instance, including the password. * This parameter takes effect only when DstPassword is set to true.	******
SlinkTaskId	string	Yes	The import task ID.	etx-szr2rr6i*****

Response elements

Element	Type	Description	Example
	object
Message	string	The response message.	*****
RequestId	string	The request ID.	173CA69A-3513-591D-8A09-C1EA37CBE2D9
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned result.
SlinkTaskId	string	The import task ID.	etx-szr2rr6i*****

Examples

Success response

JSON format

{
  "Message": "*****",
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9",
  "Success": true,
  "Data": {
    "SlinkTaskId": "etx-szr2rr6i*****"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.