修改同步对象
更新时间：2023-08-31
接口说明
修改同步对象
请求URI
PUT /v{version}/task/{dtsId}?schema
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| version | String | 是 | API版本号 | "1" | Path |
| dtsId | String | 是 | dts任务Id | dtsmxxxxx | Path |
请求体参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 | 参数位置 |
|---|---|---|---|---|---|
| action | String | 是 | 操作行为 | rewrite | Request Body 参数 |
| dataType | List<String> | 是 | 迁移类型 | ["schema", "base", "increment"] | Request Body 参数 |
| schemaMapping | List<Schema> | 是 | 对象映射 | 需要传入修改后的完整的映射关系 | Request Body 参数 |
Schema字段数据结构说明
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| type | String | 是 | 类型 | "db"、"table" |
| src | String | 是 | 源端库表 | db1.table1 |
| dst | String | 是 | 目标端库表 | db2.table2 |
| where | String | 是 | 行过滤 | id > 10 AND status = "success" |
| fieldBlacklist | String | 否 | 列过滤(黑名单) | k,c |
| fieldWhitelist | String | 否 | 列过滤(白名单) | pad |
| field | Field | 否 | 列映射 | Field |
注意：where、fieldBlacklist、fieldWhitelist、field 只对新增的库表生效
Field字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| mapping | List<MappingItem> |
MappingItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| from | String | 修改之前的列名 | field_1 |
| to | String | 修改之后的列名 | field_2 |
响应头参数
除公共头域，无其它特殊头域。
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | Int | 是否修改成功 | 1：成功 、0 ：失败 |
| message | String | 报错信息 | |
| dtsId | String | 只有新增和修改对象时会返回，用户需要对此Id手动调用预检查接口和启动任务接口 | dtsmxxxxxxxxx |
请求示例
PUT /v1/task/dtsmxxxxxxxxxx?schema
<公共请求头>
Host: dts.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/5a6f0606bf5e48f29dd132aa76aa5182/2017-06-12T13:13:05Z/1800/content-type;host;x-bce-date/8baeafe6bfc35b0cf6205e87e4ce6c0dbb442375951ace4d16e6c7a4dab95943
{
"action": "rewrite",
"dataType": [
"schema",
"base",
"increment"
],
"schemaMapping": [
{
"type": "db",
"src": "dts1",
"dst": "dts2",
"where": ""
},
{
"type": "table",
"src": "db1.table1",
"dst": "db1.table1",
"where": ""
},
]
}响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"success": 1,
"message": "",
"dtsId": "dtsm90sddddxxxxxxx"
}错误码
请参考通用错误码