发起文件导入任务

最近更新时间:2017-12-14 11:49:55

1. 接口描述

本接口(StartCdbImportJob)用于发起文件导入任务。
接口请求域名:cdb.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为StartCdbImportJob。

参数名称 是否必选 类型 描述
uInstanceId Int 需要执行导入的实例ID,格式如:cdb-c1nl9rpv。与云数据库控制台页面中显示的实例ID相同,可使用查询实例列表 接口获取,其值为输出参数中字段 uInstanceId 的值。
dbName Int 导入的目标数据库名,不传表示不指定数据库
rootPassword Int 实例的root密码
fileName Int 需要导入的文件名称,可以从查询导入文件列表接口获取

3. 输出参数

参数名称 类型 描述
code Int 公共错误码, 0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误描述
data Object 导入任务详情

其中, data 参数的构成如下:

参数名称 类型 描述
jobId Int 任务ID,可用于终止任务

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码。

错误代码 英文提示 错误描述
9003 InvalidParameter 参数错误
9520 InternalError 文件导入内部错误
9541 Import.FileSize 文件内容不能为空
9572 InstanceNotExists 实例不存在
9576 OperationDenied 实例不在运行中,或正在执行其它操作
9587 InvalidParameter 密码错误
9590 InternalFailure 文件导入内部错误

5. 示例

输入

https://cdb.api.qcloud.com/v2/index.php?Action=StartCdbImportJob
&<公共请求参数>
&uInstanceId=cdb-2d9mgksg
&rootPassword=xxxxxxxx
&fileName=test.sql

输出

{
    "code":"0",
    "message":"",
    "codeDesc":"Success",
    "data":{
        "jobId": "18302"
     }
}