对象选择(文件导入 - 模板上传) - UploadDbObjectTemplate
功能介绍
对象选择(文件导入 - 模板上传)。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
接口约束
- 仅支持部分Region使用,详情参考终端节点。
- 目前Oracle->GaussDB分布式同步场景支持xls和xlsx文件,文件阈值是5MB,导入模板可通过对象选择(文件导入 - 模板下载) - DownloadDbObjectTemplate接口获取。
- TaurusDB->Kafka、 MySQL->Kafka的导入支持json、txt文件,以及包含json、txt的ZIP压缩包(ZIP压缩包中仅支持包含一个文件)。
- TaurusDB->Kafka、 MySQL->Kafka导入的文件内容仅支持json格式, 可参考更新指定ID任务详情 - UpdateJob接口中的•更新租户指定ID任务对象信息示例。
- TaurusDB->Kafka、 MySQL->Kafka导入支持json、txt文件的阈值限制是5MB,ZIP压缩包阈值是1MB,ZIP压缩中文件大小阈值是20MB。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/jobs/{job_id}/db-object/template
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
job_id | 是 | String | 任务ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
file_import_db_level | 否 | String | 文件模板支持数据同步级别,不填默认为table表级。 缺省值:table 枚举值:
|
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
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 枚举值:
|
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
file | 是 | File | 待上传的模板文件。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
send_success | Boolean | 是否上传完成。 |
process_status | String | 文件解析状态。 取值范围:
|
parsed_success_number | String | 解析成功的行数。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 最小长度:12 最大长度:12 |
error_msg | String | 错误描述。 最小长度:1 最大长度:512 |
请求示例
导入该任务的对象选择模板。
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/db-object/template 响应示例
状态码:200
OK
{
"send_success" : true
} 状态码:400
Bad Request
{
"error_code" : "DRS.10000010",
"error_msg" : "Job does not exist, please check job ID."
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
错误码
请参见错误码。

