Domain name for API request: cdb.intl.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.
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 Params. The value used for this API: CreateDBImportJob. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. 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. |
User | Yes | String | TencentDB username |
FileName | No | String | Filename. The file must be a .sql file uploaded to Tencent Cloud. |
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. |
CosUrl | No | String | URL of a .sql file stored in COS. Either FileName or CosUrl must be specified. |
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBImportJob
<Common request parameters>
{
"InstanceId": "cdb-ids6j1b3",
"Password": "xxxxxxxxxx",
"User": "xxxxx",
"FileName": "test.sql"
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "be9f64a6-fa652dc6-f5c878b6-a6a50746"
}
}
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBImportJob
<Common request parameters>
{
"InstanceId": "cdb-ids6j1b3",
"CosUrl": "https://test-bulk-XXXXX.cos.ap-chengdu.myqcloud.com/myFile/create_db.sql",
"Password": "xxxxxxxxxx",
"User": "xxxxx"
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"AsyncRequestId": "be9f64a6-fa652dc6-f5c878b6-a6a50746"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Backend or process error. |
CdbError.ImportError | Import task error. |
FailedOperation.StatusConflict | Task status conflict. |
InternalError.CdbError | System error. |
InternalError.DatabaseAccessError | Internal database error. |
InternalError.ExecuteSQLError | Failed to execute SQL statement |
InternalError.ImportError | Import failed |
InternalError.UndefinedError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.InstanceNotFound | The instance does not exist. |
OperationDenied | Operation denied. |
OperationDenied.ActionNotSupport | Unsupported operation. |
OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
OperationDenied.WrongPassword | Incorrect password or verification failed. |
OperationDenied.WrongStatus | The backend task status is invalid. |
Was this page helpful?