对象选择(文件导入 - 模板下载) - DownloadDbObjectTemplate
功能介绍
对象选择(文件导入 - 模板下载)。
接口约束
- 目前仅支持Oracle->GaussDB分布式、TaurusDB->Kafka、MySQL->Kafka同步场景。
- 仅支持部分Region使用,详情参考终端节点。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /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类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json |
X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
X-Language | 否 | String | 请求语言类型。 缺省值:en-us 枚举值:
|
响应参数
状态码: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
响应体为文件流格式,文件下载内容为zip类型。
状态码:400
Bad Request
{
"error_code" : "DRS.10000001",
"error_msg" : "Failed."
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
错误码
请参见错误码。

