文档首页/ 事件网格 EG/ API参考/ API/ 专业版事件流作业管理/ 更新专业版事件流作业 - UpdateEventRouterJob

更新时间：2025-10-22 GMT+08:00

在线调试

CLI示例

查看PDF

更新专业版事件流作业 - UpdateEventRouterJob

功能介绍

更新专业版事件流作业

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/{project_id}/eventrouter/jobs/{job_id}

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户资源空间ID
job_id	是	String	作业ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
cluster_id	是	String	专业版事件流集群ID
name	是	String	作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。
description	否	String	作业描述，约束：作业描述不能超过256位。
scene_type	是	String	场景类型，DISASTER_BACKUP：同步任务
source_config	否	EventRouterJobSource object	专业版事件流作业源端配置
sink_config	否	EventRouterJobSink object	专业版事件流作业目标端配置
advance_config	否	EventRouterAdvanceConfig object	专业版事件流作业高级配置

表4 EventRouterJobSource
参数	是否必选	参数类型	描述
source_kafka	否	KafkaParameters object	kafka配置
source_rocketmq	否	RocketmqParameters object	rocketmq配置
source_dcs	否	DcsParameters object	dcs配置

表5 EventRouterJobSink
参数	是否必选	参数类型	描述
sink_kafka	否	KafkaParameters object	kafka配置
sink_rocketmq	否	RocketmqParameters object	rocketmq配置
sink_dcs	否	DcsParameters object	dcs配置

表6 KafkaParameters
参数	是否必选	参数类型	描述
config_type	是	String	实例类型 CLOUD：云服务DMS kafka实例
region	是	String	区域ID
project_id	是	String	资源空间ID
instance_id	否	String	kafka实例ID，配置类型选择CLOUD时必填
cluster_alias	是	String	kafka集群别名
address	否	String	kafka地址
authenticate_mode	否	String	kafka认证方式
sasl_mechanism	否	String	SASL认证机制
user_name	否	String	用户名，开启SASL_SSL时必填
password	否	String	用户密码，开启SASL_SSL时必填

表7 RocketmqParameters
参数	是否必选	参数类型	描述
config_type	是	String	实例类型。 CLOUD：云服务DMS Rocketmq实例
region	是	String	区域id
project_id	是	String	资源空间ID
instance_id	否	String	rocketmq实例ID，配置类型选择CLOUD时必填
cluster_alias	是	String	rocketmq集群别名
address	否	String	rocketmq地址
ssl_open	否	String	rocketmq SSL开关 true: 开启 false: 关闭
acl_open	否	Boolean	rocketmq ACL开关 true: 开启 false: 关闭
user_name	否	String	用户名，开启ACL时必填
password	否	String	用户密码，开启ACL时必填

表8 DcsParameters
参数	是否必选	参数类型	描述
config_type	是	String	实例类型 CLOUD：云服务DCS实例
region	是	String	区域id
project_id	是	String	资源空间ID
instance_id	否	String	dcs实例ID，配置类型选择CLOUD时必填
address	否	String	dcs地址
password	否	String	用户密码

表9 EventRouterAdvanceConfig
参数	是否必选	参数类型	描述
kafka2kafka	否	Kafka2KafkaAdvanceConfig object	kafka同步自定义配置
rocketmq2rocketmq	否	Rocketmq2RocketmqAdvanceConfig object	rocketmq同步自定义配置
dcs2dcs	否	Dcs2DcsAdvanceConfig object	dcs同步自定义配置

**表10** Kafka2KafkaAdvanceConfig
参数	是否必选	参数类型	描述
topics	否	String	要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一
topic_regex	否	String	要同步的topic正则表达式，与topics参数二选一
replica_cnt	是	Integer	副本数，不能大于broker数量
seek_to	是	String	数据同步点
compress_alg	是	String	压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法
is_sync_progress	是	Boolean	是否同步消费进度 true：同步 false：不同步
is_add_header	是	Boolean	是否添加来源Header
rename_topic	否	Boolean	是否重命名Topic
topic_mappings	否	Array of KafkaTopicMapping objects	topic映射

**表11** KafkaTopicMapping
参数	是否必选	参数类型	描述
source_topic	否	String	源主题
sink_topic	否	String	目标主题

**表12** Rocketmq2RocketmqAdvanceConfig
参数	是否必选	参数类型	描述
topics	否	String	要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一
topic_regex	否	String	要同步的topic正则表达式，与topics参数二选一
is_sync_progress	是	Boolean	是否同步消费进度
seek_to	是	String	数据同步点最早（first），最新（last），自定义时间戳（long类型）
compress_alg	是	String	压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法

**表13** Dcs2DcsAdvanceConfig
参数	是否必选	参数类型	描述
synchronize_type	是	String	同步类型默认全量加增量
connect_retry_time	是	String	无法连接后重试时间，默认60秒
other_retry_time	是	String	出现其他问题后的重试时间，默认60秒
use_rate_limit	否	Boolean	是否限制增量同步速率，默认5MS/s true：限制 false：不限制
rate_limit	否	String	限制增量同步速率，默认5MB/s
use_salve_node	否	Boolean	是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点
allow_keys	否	String	Redis事件流作业，允许同步的key，以英文逗号分隔
allow_key_prefix	否	String	Redis事件流作业，允许同步的key前缀，以英文逗号分隔
allow_key_suffix	否	String	Redis事件流作业，允许同步的key后缀，以英文逗号分隔
block_keys	否	String	Redis事件流作业，不允许同步的key，以英文逗号分隔
block_key_prefix	否	String	Redis事件流作业，不允许同步的key前缀，以英文逗号分隔
block_key_suffix	否	String	Redis事件流作业，不允许同步的key后缀，以英文逗号分隔
allow_db	否	Array of integers	Redis事件流作业，允许同步的DB列表
db_mapping	否	Map<String,String>	Redis事件流作业，DB同步的映射关系

响应参数

状态码：200

**表14** 响应Header参数
参数	参数类型	描述
X-Request-Id	String	请求ID

**表15** 响应Body参数
参数	参数类型	描述
cluster_id	String	专业版事件流集群ID
job_id	String	专业版事件流作业ID
name	String	作业名称。约束：作业名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。
description	String	作业描述，约束：作业描述不能超过256位。
scene_type	String	场景类型
source_type	String	源端类型
sink_type	String	目标端类型
subnet_id	String	子网ID
vpc_id	String	虚拟私有云ID
source_config	EventRouterJobSource object	专业版事件流作业源端配置
sink_config	EventRouterJobSink object	专业版事件流作业目标端配置
advance_config	EventRouterAdvanceConfig object	专业版事件流作业高级配置
status	String	作业状态
err_code	String	错误码
err_message	String	错误原因
created_time	String	创建UTC时间
updated_time	String	更新UTC时间
sink_status	String	目标端连通性状态
sink_status_info	String	目标端连通性状态信息
source_status	String	源端连通性状态
source_status_info	String	源端连通性状态信息
log_group_id	String	用户侧保存事件流作业日志的日志组ID
log_stream_id	String	用户侧保存事件流作业日志的日志流ID

**表16** EventRouterJobSource
参数	参数类型	描述
source_kafka	KafkaParameters object	kafka配置
source_rocketmq	RocketmqParameters object	rocketmq配置
source_dcs	DcsParameters object	dcs配置

**表17** EventRouterJobSink
参数	参数类型	描述
sink_kafka	KafkaParameters object	kafka配置
sink_rocketmq	RocketmqParameters object	rocketmq配置
sink_dcs	DcsParameters object	dcs配置

**表18** KafkaParameters
参数	参数类型	描述
config_type	String	实例类型 CLOUD：云服务DMS kafka实例
region	String	区域ID
project_id	String	资源空间ID
instance_id	String	kafka实例ID，配置类型选择CLOUD时必填
cluster_alias	String	kafka集群别名
address	String	kafka地址
authenticate_mode	String	kafka认证方式
sasl_mechanism	String	SASL认证机制
user_name	String	用户名，开启SASL_SSL时必填
password	String	用户密码，开启SASL_SSL时必填

**表19** RocketmqParameters
参数	参数类型	描述
config_type	String	实例类型。 CLOUD：云服务DMS Rocketmq实例
region	String	区域id
project_id	String	资源空间ID
instance_id	String	rocketmq实例ID，配置类型选择CLOUD时必填
cluster_alias	String	rocketmq集群别名
address	String	rocketmq地址
ssl_open	String	rocketmq SSL开关 true: 开启 false: 关闭
acl_open	Boolean	rocketmq ACL开关 true: 开启 false: 关闭
user_name	String	用户名，开启ACL时必填
password	String	用户密码，开启ACL时必填

**表20** DcsParameters
参数	参数类型	描述
config_type	String	实例类型 CLOUD：云服务DCS实例
region	String	区域id
project_id	String	资源空间ID
instance_id	String	dcs实例ID，配置类型选择CLOUD时必填
address	String	dcs地址
password	String	用户密码

**表21** EventRouterAdvanceConfig
参数	参数类型	描述
kafka2kafka	Kafka2KafkaAdvanceConfig object	kafka同步自定义配置
rocketmq2rocketmq	Rocketmq2RocketmqAdvanceConfig object	rocketmq同步自定义配置
dcs2dcs	Dcs2DcsAdvanceConfig object	dcs同步自定义配置

**表22** Kafka2KafkaAdvanceConfig
参数	参数类型	描述
topics	String	要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一
topic_regex	String	要同步的topic正则表达式，与topics参数二选一
replica_cnt	Integer	副本数，不能大于broker数量
seek_to	String	数据同步点
compress_alg	String	压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 snappy：snappy压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法
is_sync_progress	Boolean	是否同步消费进度 true：同步 false：不同步
is_add_header	Boolean	是否添加来源Header
rename_topic	Boolean	是否重命名Topic
topic_mappings	Array of KafkaTopicMapping objects	topic映射

**表23** KafkaTopicMapping
参数	参数类型	描述
source_topic	String	源主题
sink_topic	String	目标主题

**表24** Rocketmq2RocketmqAdvanceConfig
参数	参数类型	描述
topics	String	要同步的topic名称，精确匹配，用","间隔，与topic_regex参数二选一
topic_regex	String	要同步的topic正则表达式，与topics参数二选一
is_sync_progress	Boolean	是否同步消费进度
seek_to	String	数据同步点最早（first），最新（last），自定义时间戳（long类型）
compress_alg	String	压缩算法 none：不使用压缩算法 gzip：gzip压缩算法 lz4：lz4压缩算法 zstd：zstd压缩算法

**表25** Dcs2DcsAdvanceConfig
参数	参数类型	描述
synchronize_type	String	同步类型默认全量加增量
connect_retry_time	String	无法连接后重试时间，默认60秒
other_retry_time	String	出现其他问题后的重试时间，默认60秒
use_rate_limit	Boolean	是否限制增量同步速率，默认5MS/s true：限制 false：不限制
rate_limit	String	限制增量同步速率，默认5MB/s
use_salve_node	Boolean	是否使用Slave节点 true：使用从节点同步数据 false：不使用从节点同步数据，即使用主节点
allow_keys	String	Redis事件流作业，允许同步的key，以英文逗号分隔
allow_key_prefix	String	Redis事件流作业，允许同步的key前缀，以英文逗号分隔
allow_key_suffix	String	Redis事件流作业，允许同步的key后缀，以英文逗号分隔
block_keys	String	Redis事件流作业，不允许同步的key，以英文逗号分隔
block_key_prefix	String	Redis事件流作业，不允许同步的key前缀，以英文逗号分隔
block_key_suffix	String	Redis事件流作业，不允许同步的key后缀，以英文逗号分隔
allow_db	Array of integers	Redis事件流作业，允许同步的DB列表
db_mapping	Map<String,String>	Redis事件流作业，DB同步的映射关系

请求示例

更新jobId=123的专业版事件流作业

PUT https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/123

{
  "advance_config" : {
    "kafka2kafka" : {
      "compress_alg" : "none",
      "is_add_header" : false,
      "is_sync_progress" : true,
      "rename_topic" : false,
      "replica_cnt" : 1,
      "seek_to" : "earliest",
      "topic_mappings" : [ ],
      "topic_regex" : ".*",
      "topics" : ""
    }
  },
  "cluster_id" : "1a8b384f-b788-3000-0010-924ef6f516b2",
  "description" : "",
  "name" : "eventRoute-0ztrqj7o",
  "scene_type" : "DISASTER_BACKUP",
  "sink_config" : {
    "sink_kafka" : {
      "address" : "192.168.0.49:9092,192.168.0.91:9092,192.168.0.210:9092",
      "authenticate_mode" : "PLAINTEXT",
      "cluster_alias" : "b",
      "config_type" : "CLOUD",
      "instance_id" : "d7d5bcec-2b73-4331-a568-1288f23dbbb0",
      "password" : null,
      "project_id" : "bac852160cc743158936edaab6dda813",
      "region" : "cn-north-7",
      "sasl_mechanism" : "",
      "user_name" : ""
    }
  },
  "source_config" : {
    "source_kafka" : {
      "address" : "192.168.0.107:9092,192.168.0.216:9092,192.168.0.220:9092",
      "authenticate_mode" : "PLAINTEXT",
      "cluster_alias" : "a",
      "config_type" : "CLOUD",
      "instance_id" : "9280ed54-bd21-4721-bd99-7773b6b724ab",
      "password" : null,
      "project_id" : "bac852160cc743158936edaab6dda813",
      "region" : "cn-north-7",
      "sasl_mechanism" : "",
      "user_name" : ""
    }
  }
}

响应示例

状态码：200

请求成功

{
  "advance_config" : {
    "dcs2dcs" : null,
    "kafka2kafka" : {
      "compress_alg" : "none",
      "is_add_header" : false,
      "is_sync_progress" : true,
      "rename_topic" : false,
      "replica_cnt" : 1,
      "seek_to" : "earliest",
      "topic_mappings" : [ ],
      "topic_regex" : ".*",
      "topics" : ""
    }
  },
  "cluster_id" : "1a8b384f-b788-3000-0010-924ef6f516b2",
  "created_time" : "2025-04-25T03:16:32Z",
  "description" : "",
  "err_code" : null,
  "err_message" : null,
  "job_id" : "1a959958-06f9-0000-0013-0bcb5b2cb356",
  "name" : "eventRoute-0ztrqj7o",
  "scene_type" : "DISASTER_BACKUP",
  "sink_config" : {
    "sink_kafka" : {
      "address" : "192.168.0.49:9092,192.168.0.91:9092,192.168.0.210:9092",
      "authenticate_mode" : "PLAINTEXT",
      "cluster_alias" : "b",
      "config_type" : "CLOUD",
      "instance_id" : "d7d5bcec-2b73-4331-a568-1288f23dbbb0",
      "password" : null,
      "project_id" : "bac852160cc743158936edaab6dda813",
      "region" : "cn-north-7",
      "sasl_mechanism" : "",
      "user_name" : ""
    }
  },
  "sink_status" : "UNDEFINED",
  "sink_status_info" : "",
  "sink_type" : "KAFKA",
  "source_config" : {
    "source_kafka" : {
      "address" : "192.168.0.107:9092,192.168.0.216:9092,192.168.0.220:9092",
      "authenticate_mode" : "PLAINTEXT",
      "cluster_alias" : "a",
      "config_type" : "CLOUD",
      "instance_id" : "9280ed54-bd21-4721-bd99-7773b6b724ab",
      "password" : null,
      "project_id" : "bac852160cc743158936edaab6dda813",
      "region" : "cn-north-7",
      "sasl_mechanism" : "",
      "user_name" : ""
    }
  },
  "source_status" : "UNDEFINED",
  "source_type" : "KAFKA",
  "status" : "WAIT_START",
  "subnet_id" : "33bd70bd-1d62-4438-96c8-da19fdd65230",
  "updated_time" : "2025-04-25T03:16:32Z",
  "vpc_id" : "0c4975eb-5575-4be0-b788-539ee002f45c"
}

状态码

状态码	描述
200	请求成功

错误码

请参见错误码。

父主题： 专业版事件流作业管理

上一篇：查询专业版事件流作业详情 - ShowEventRouterJob

下一篇：操作专业版事件流作业 - ExecuteEventRouterJobOperation

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消