Help & DocumentationAPIsTencentDB for MySQLData Import APICreateDBImportJob

CreateDBImportJob

Last updated: 2020-03-23 14:59:34

Contents：

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API (CreateDBImportJob) is used to create a data import task for a TencentDB instance.

Note that the files for a data import task must be uploaded to Tencent Cloud in advance. You need to do so in the console.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request 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. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
FileName Yes String Filename. The file should have already been uploaded to Tencent Cloud.
User Yes String TencentDB username
Password No String Password of a TencentDB instance user account
DbName No String Name of the target database. If this parameter is not passed in, no database is specified.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String Async task request ID, 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. Example

Example1 Creating a Data Import Task

Input Example

https://cdb.tencentcloudapi.com/?Action=CreateDBImportJob
&InstanceId=cdb-ids6j1b3
&User=xxxxx
&Password=xxxxxxxxxx
&FileName=test.sql
&<common request parameters>

Output Example

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

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
CdbError.ImportError Import task error.
FailedOperation.StatusConflict Task status conflict.
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.