Updating a Professional Event Stream Job

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to update a professional event stream job.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.
job_id	Yes	String	Job ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
cluster_id	Yes	String	Professional event stream cluster ID.
name	Yes	String	Job name. Start with a letter or digit, and only include letters, digits, periods (.), underscores (_), and hyphens (-). (Max. 128 characters)
description	No	String	Job description. The description can contain a maximum of 256 characters.
scene_type	Yes	String	Scenario type. DISASTER_BACKUP: synchronization task.
source_config	No	EventRouterJobSource object	Source configuration of a professional event stream job.
sink_config	No	EventRouterJobSink object	Target configuration of a professional event stream job.
advance_config	No	EventRouterAdvanceConfig object	Advanced configuration of professional event stream jobs.

**Table 4** EventRouterJobSource
Parameter	Mandatory	Type	Description
source_kafka	No	KafkaParameters object	Kafka configuration.
source_rocketmq	No	RocketmqParameters object	RocketMQ configuration.
source_dcs	No	DcsParameters object	DCS configuration.

**Table 5** EventRouterJobSink
Parameter	Mandatory	Type	Description
sink_kafka	No	KafkaParameters object	Kafka configuration.
sink_rocketmq	No	RocketmqParameters object	RocketMQ configuration.
sink_dcs	No	DcsParameters object	DCS configuration.

**Table 6** KafkaParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DMS for Kafka instance.
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	Kafka instance ID. This parameter is mandatory when configuration type is set to CLOUD.
cluster_alias	Yes	String	Kafka cluster alias.
address	No	String	Kafka address.
authenticate_mode	No	String	Authentication mode for Kafka.
sasl_mechanism	No	String	SASL authentication mechanism.
user_name	No	String	Username. This parameter is mandatory when SASL_SSL is enabled.
password	No	String	Password. This parameter is mandatory when SASL_SSL is enabled.

**Table 7** RocketmqParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DMS for RocketMQ instance
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	RocketMQ instance ID. This parameter is mandatory when the configuration type is CLOUD.
cluster_alias	Yes	String	RocketMQ cluster alias.
address	No	String	RocketMQ address.
ssl_open	No	String	Whether to enable RocketMQ SSL. true: Enable false: Disable
acl_open	No	Boolean	Whether to enable RocketMQ ACL. true: Enable false: Disable
user_name	No	String	Username. This parameter is mandatory when ACL is enabled.
password	No	String	Password. This parameter is mandatory when ACL is enabled.

**Table 8** DcsParameters
Parameter	Mandatory	Type	Description
config_type	Yes	String	Instance type. CLOUD: DCS instance
region	Yes	String	Region ID.
project_id	Yes	String	Resource space ID.
instance_id	No	String	DCS instance ID. This parameter is mandatory when the configuration type is set to CLOUD.
address	No	String	DCS address.
password	No	String	Password.

**Table 9** EventRouterAdvanceConfig
Parameter	Mandatory	Type	Description
kafka2kafka	No	Kafka2KafkaAdvanceConfig object	Kafka synchronization custom configuration.
rocketmq2rocketmq	No	Rocketmq2RocketmqAdvanceConfig object	RocketMQ synchronization custom configuration.
dcs2dcs	No	Dcs2DcsAdvanceConfig object	DCS synchronization custom configuration.

**Table 10** Kafka2KafkaAdvanceConfig
Parameter	Mandatory	Type	Description
topics	No	String	Name of the topic to be synchronized. Use commas (,) to separate the topic names for exact match. Either this parameter or topic_regex must be specified.
topic_regex	No	String	Regular expression of the topic to be synchronized. Either this parameter or the topics parameter must be set.
replica_cnt	Yes	Integer	Number of replicas, which cannot be greater than the number of brokers.
seek_to	Yes	String	Data synchronization point.
compress_alg	Yes	String	Compression algorithm. none: The compression algorithm is not used. gzip: Gzip compression algorithm. snappy: Snappy compression algorithm. lz4: LZ4 compression algorithm. zstd: zstd compression algorithm.
is_sync_progress	Yes	Boolean	Indicates whether to synchronize the consumption progress. true: yes false: no
is_add_header	Yes	Boolean	Indicates whether to add the source header.
rename_topic	No	Boolean	Indicates whether to rename a topic.
topic_mappings	No	Array of KafkaTopicMapping objects	Topic mapping.

**Table 11** KafkaTopicMapping
Parameter	Mandatory	Type	Description
source_topic	No	String	Source topic.
sink_topic	No	String	Target topic.

**Table 12** Rocketmq2RocketmqAdvanceConfig
Parameter	Mandatory	Type	Description
topics	No	String	Specifies the name of the topic to be synchronized. Use commas (,) to separate the topic names for exact match. Either this parameter or topic_regex must be specified.
topic_regex	No	String	Regular expression of the topic to be synchronized. Either this parameter or the topics parameter must be set.
is_sync_progress	Yes	Boolean	Indicates whether to sync the consumption progress.
seek_to	Yes	String	Data synchronization point. Options: first, last, custom timestamp (long type).
compress_alg	Yes	String	Compression algorithm. none: The compression algorithm is not used. gzip: Gzip compression algorithm. lz4: LZ4 compression algorithm. zstd: zstd compression algorithm.

**Table 13** Dcs2DcsAdvanceConfig
Parameter	Mandatory	Type	Description
synchronize_type	Yes	String	Synchronization type. Default: Full+Incremental.
connect_retry_time	Yes	String	Retry interval upon connection failure. The default value is 60 seconds.
other_retry_time	Yes	String	Retry interval upon other failures. The default value is 60 seconds.
use_rate_limit	No	Boolean	Whether to limit the incremental synchronization rate. The default value is 5 MB/s. true: yes false: no
rate_limit	No	String	Limited incremental synchronization rate. The default value is 5 MB/s.
use_salve_node	No	Boolean	Whether to use the standby node. true: Use the standby node to synchronize data. false: Use the master node to synchronize data.

Response Parameters

Status code: 200

**Table 14** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 15** Response body parameters
Parameter	Type	Description
cluster_id	String	Professional event stream cluster ID.
job_id	String	Professional event stream job ID.
name	String	Job name. Start with a letter or digit, and only include letters, digits, periods (.), underscores (_), and hyphens (-). (Max. 128 characters)
description	String	Job description. The description can contain a maximum of 256 characters.
scene_type	String	Scenario type.
source_type	String	Source type.
sink_type	String	Target type.
subnet_id	String	Subnet ID.
vpc_id	String	VPC ID.
source_config	EventRouterJobSource object	Source configuration of a professional event stream job.
sink_config	EventRouterJobSink object	Target configuration of a professional event stream job.
advance_config	EventRouterAdvanceConfig object	Advanced configuration of professional event stream jobs.
status	String	Job status.
err_code	String	Error code.
err_message	String	Error cause.
created_time	String	UTC time when the event source is created.
updated_time	String	UTC time when the event source is updated.
sink_status	String	Target connectivity status.
sink_status_info	String	Target connectivity status information.
source_status	String	Source connectivity status.
source_status_info	String	Source connectivity status information.
log_group_id	String	User log group ID for the event stream job.
log_stream_id	String	User log stream ID for the event stream job.

**Table 16** EventRouterJobSource
Parameter	Type	Description
source_kafka	KafkaParameters object	Kafka configuration.
source_rocketmq	RocketmqParameters object	RocketMQ configuration.
source_dcs	DcsParameters object	DCS configuration.

**Table 17** EventRouterJobSink
Parameter	Type	Description
sink_kafka	KafkaParameters object	Kafka configuration.
sink_rocketmq	RocketmqParameters object	RocketMQ configuration.
sink_dcs	DcsParameters object	DCS configuration.

**Table 18** KafkaParameters
Parameter	Type	Description
config_type	String	Instance type. CLOUD: DMS for Kafka instance.
region	String	Region ID.
project_id	String	Resource space ID.
instance_id	String	Kafka instance ID. This parameter is mandatory when configuration type is set to CLOUD.
cluster_alias	String	Kafka cluster alias.
address	String	Kafka address.
authenticate_mode	String	Authentication mode for Kafka.
sasl_mechanism	String	SASL authentication mechanism.
user_name	String	Username. This parameter is mandatory when SASL_SSL is enabled.
password	String	Password. This parameter is mandatory when SASL_SSL is enabled.

**Table 19** RocketmqParameters
Parameter	Type	Description
config_type	String	Instance type. CLOUD: DMS for RocketMQ instance
region	String	Region ID.
project_id	String	Resource space ID.
instance_id	String	RocketMQ instance ID. This parameter is mandatory when the configuration type is CLOUD.
cluster_alias	String	RocketMQ cluster alias.
address	String	RocketMQ address.
ssl_open	String	Whether to enable RocketMQ SSL. true: Enable false: Disable
acl_open	Boolean	Whether to enable RocketMQ ACL. true: Enable false: Disable
user_name	String	Username. This parameter is mandatory when ACL is enabled.
password	String	Password. This parameter is mandatory when ACL is enabled.

**Table 20** DcsParameters
Parameter	Type	Description
config_type	String	Instance type. CLOUD: DCS instance
region	String	Region ID.
project_id	String	Resource space ID.
instance_id	String	DCS instance ID. This parameter is mandatory when the configuration type is set to CLOUD.
address	String	DCS address.
password	String	Password.

**Table 21** EventRouterAdvanceConfig
Parameter	Type	Description
kafka2kafka	Kafka2KafkaAdvanceConfig object	Kafka synchronization custom configuration.
rocketmq2rocketmq	Rocketmq2RocketmqAdvanceConfig object	RocketMQ synchronization custom configuration.
dcs2dcs	Dcs2DcsAdvanceConfig object	DCS synchronization custom configuration.

**Table 22** Kafka2KafkaAdvanceConfig
Parameter	Type	Description
topics	String	Name of the topic to be synchronized. Use commas (,) to separate the topic names for exact match. Either this parameter or topic_regex must be specified.
topic_regex	String	Regular expression of the topic to be synchronized. Either this parameter or the topics parameter must be set.
replica_cnt	Integer	Number of replicas, which cannot be greater than the number of brokers.
seek_to	String	Data synchronization point.
compress_alg	String	Compression algorithm. none: The compression algorithm is not used. gzip: Gzip compression algorithm. snappy: Snappy compression algorithm. lz4: LZ4 compression algorithm. zstd: zstd compression algorithm.
is_sync_progress	Boolean	Indicates whether to synchronize the consumption progress. true: yes false: no
is_add_header	Boolean	Indicates whether to add the source header.
rename_topic	Boolean	Indicates whether to rename a topic.
topic_mappings	Array of KafkaTopicMapping objects	Topic mapping.

**Table 23** KafkaTopicMapping
Parameter	Type	Description
source_topic	String	Source topic.
sink_topic	String	Target topic.

**Table 24** Rocketmq2RocketmqAdvanceConfig
Parameter	Type	Description
topics	String	Specifies the name of the topic to be synchronized. Use commas (,) to separate the topic names for exact match. Either this parameter or topic_regex must be specified.
topic_regex	String	Regular expression of the topic to be synchronized. Either this parameter or the topics parameter must be set.
is_sync_progress	Boolean	Indicates whether to sync the consumption progress.
seek_to	String	Data synchronization point. Options: first, last, custom timestamp (long type).
compress_alg	String	Compression algorithm. none: The compression algorithm is not used. gzip: Gzip compression algorithm. lz4: LZ4 compression algorithm. zstd: zstd compression algorithm.

**Table 25** Dcs2DcsAdvanceConfig
Parameter	Type	Description
synchronize_type	String	Synchronization type. Default: Full+Incremental.
connect_retry_time	String	Retry interval upon connection failure. The default value is 60 seconds.
other_retry_time	String	Retry interval upon other failures. The default value is 60 seconds.
use_rate_limit	Boolean	Whether to limit the incremental synchronization rate. The default value is 5 MB/s. true: yes false: no
rate_limit	String	Limited incremental synchronization rate. The default value is 5 MB/s.
use_salve_node	Boolean	Whether to use the standby node. true: Use the standby node to synchronize data. false: Use the master node to synchronize data.

Example Requests

Update the professional event stream job whose ID is 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" : ""
    }
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "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"
}