Last updated: 2019-11-29 16:37:26

1. API Description

Domain name for API request:

This API (CreateDBImportJob) is used to create an data import task for a database.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters.
| Parameter Name | Required | Type | Description |
| Action | Yes | String | Common parameter. The value used for this API: CreateDBImportJob |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20 |
| Region | Yes | String | Common parameter. |
| InstanceId | Yes | String | Instance ID, such as cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page. |
| FileName | Yes | String | File name. |
| User | Yes | String | User name of the database. |
| Password | No | String | User account and password of the database instance. |
| DbName | No | String | Name of the destination database for data import. No database is specified if this parameter is not passed. |

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String ID of an async task request, which can be used to query the execution result of an async task.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

The following only lists the error codes related to the API business logic.

Error Code Description
CdbError.ImportError An error occurred with the import task.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied.WrongPassword Incorrect password or verification failed.
OperationDenied.WrongStatus The backend task status is invalid.

5. Example

Example 1 Create a data import task

Input example
&<Common request parameters>

Output example

  "Response": {
    "AsyncRequestId": "be9f64a6-fa652dc6-f5c878b6-a6a50746",
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.