更新时间:2024-07-11 GMT+08:00

批量导入任务

功能介绍

批量导入创建任务(文件导入 - 模板上传)。

接口约束

目前仅支持MySQL->MySQL迁移和同步场景。

URI

POST /v5/{project_id}/jobs/template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。使用multipart/form-data,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:multipart/form-data

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn
表3 FormData参数

参数

是否必选

参数类型

描述

file

File

待上传的模板文件。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

async_job_id

String

批量导入创建的任务ID。

import_error_messages

Array of objects

导入失败的错误信息。

详情请参见import_error_messages字段数据结构说明

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

表5 import_error_messages字段数据结构说明

参数

参数类型

描述

sheet_name

String

sheet名称。

row_rum

String

错误行号。

value

String

错误行的value列字段值。

error_message

String

错误信息。

请求示例

导入任务参数模板,批量创建任务:

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/template

响应示例

状态码: 200

OK

{
   "async_job_id":"dc6016cf-f3b6-4c2d-b4d7-5084b0fdf456"
}

状态码: 400

Bad Request
{
   "error_code":"DRS.10120001",
   "error_msg":"解析导入文件失败",
   "import_error_messages":[
      {
         "sheet_name":"sheet0",
         "row_rum":"10",
         "value":"test",
         "error_message":"base_info.tags parse object failed."
      }
   ]
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码