文档首页/数据复制服务 DRS/API参考/API v5（公测中）/参数管理/更新任务的参数信息 - UpdateJobConfigurations
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新任务的参数信息 - UpdateJobConfigurations

功能介绍

更新任务的参数信息。

接口约束

  • 仅支持MySQL->MySQL、MySQL->PostgreSQL、MySQL->GaussDB分布式、MySQL->GaussDB集中式、MySQL->TaurusDB、MySQL->Kafka、MySQL->Oracle的实时同步任务使用。
  • 任务状态为配置中、全量中、增量中、全量失败、增量失败、暂停中的实时同步任务使用。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

PUT /v5/{project_id}/jobs/{job_id}/modify-configuration

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值，请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

values

是

Array of objects

参数值对象，基于默认参数模板初始化的参数值。

详情请参见表4。

表4 values字段数据结构说明

参数

是否必选

参数类型

描述

parameter_name

是

String

参数名称，如：“applier_thread_num”，“read_task_num”等。为空时表示不修改参数值。

parameter_value

是

String

参数名称对应的参数值，如：“20”，“false”。parameter_name不为空时，parameter_value也不可为空。

响应参数

无

请求示例

更新任务全量阶段写数据到目标数据库的线程数和全量阶段从源数据库读取数据的线程数。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/modify-configuration 
 
{ 
  "values" : [ { 
    "parameter_name" : "applier_thread_num", 
    "parameter_value" : "20" 
  }, { 
    "parameter_name" : "read_task_num", 
    "parameter_value" : "3" 
  } ] 
}

响应示例

状态码：204

No Content

状态码

状态码

描述

204

No Content

错误码

请参见错误码。

父主题：参数管理

相关文档