有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: cdb.tencentcloudapi.com 。

本接口(CreateDBImportJob)用于创建云数据库数据导入任务。

注意,用户进行数据导入任务的文件,必须提前上传到腾讯云。用户须在控制台进行文件导入。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDBImportJob。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例的 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
示例值:cdb-ids6j1b3
User String 云数据库的用户名。
示例值:xxxxx
FileName String 文件名称。该文件是指用户已上传到腾讯云的文件,仅支持.sql文件。
示例值:test.sql
Password String 云数据库实例 User 账号的密码。
示例值:xxxxxxxxxx
DbName String 导入的目标数据库名,不传表示不指定数据库。
示例值:""
CosUrl String 腾讯云COS文件链接。 用户需要指定 FileName 或者 CosUrl 其中一个。 COS文件需要是 .sql 文件。
示例值:XXX

3. 输出参数

参数名称 类型 描述
AsyncRequestId String 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
示例值:be9f64a6-fa652dc6-f5c878b6-a6a50746
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建数据导入任务

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBImportJob
<公共请求参数>

{
    "InstanceId": "cdb-ids6j1b3",
    "Password": "xxxxxxxxxx",
    "User": "xxxxx",
    "FileName": "test.sql"
}

输出示例

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

示例2 使用COS地址创建数据导入任务

输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDBImportJob
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
CdbError 后端错误或者流程错误。
CdbError.ImportError 导入任务错误。
FailedOperation.StatusConflict 任务状态冲突。
InternalError.CdbError 系统错误。
InternalError.DatabaseAccessError 数据库内部错误。
InternalError.ExecuteSQLError sql执行失败。
InternalError.ImportError 导入失败。
InternalError.UndefinedError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InstanceNotFound 实例不存在。
OperationDenied 操作被拒绝。
OperationDenied.ActionNotSupport 不支持的操作。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。
OperationDenied.WrongPassword 密码错误或校验未通过。
OperationDenied.WrongStatus 后端任务状态非法。