修改模版参数
更新时间：2026-02-03
修改模版参数
接口描述
本接口用于修改模版参数。
注意事项 支持任务在运行中(running)、已暂停(stopped)、运行失败(runFailed)、重试中(retrying)的状态下修改参数
请求结构
Plain Text
1PUT /v{version}/modifyParameters/${dtsId}
2Host: dts.baidubce.com
3Authorization: authorization string
4[
5 {
6 "dataType": "increment",
7 "name": "concurrentWriterNum",
8 "value": "17"
9 }
10]请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号。 |
| dtsId | String | 是 | URL参数 | 任务ID。迁移任务或数据校验任务ID |
请求体参数说明
请求体为 JSON 数组格式，数组内每个对象对应一个待修改的参数项，参数对象字段说明如下：
| 字段名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
| dataType | String | 是 | 枚举值：schema(结构迁移)，base(全量迁移)，increment(增量同步)；校验任务只支持 base |
| name | String | 是 | 参数名 |
| value | String | 是 | 变更后的值 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 接口状态 |
| result | Result | 任务变更结果 |
Result数据结构说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
| success | String | 变更状态； 1：成功；0：失败 |
| message | String | 失败原因 |
请求示例
Plain Text
1PUT http://dts.baidubce.com/v1/task/modifyParameters/dtsxxxxxxxxxxxxxx
2Host: dts.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4[
5 {
6 "dataType": "increment",
7 "name": "concurrentWriterNum",
8 "value": "17"
9 }
10]响应示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6{
7 "success": true,
8 "result": {
9 "success": 1,
10 "message": ""
11 }
12}