开启/关闭事件流作业日志 - UpdateEventRouterTaskLogFeature
功能介绍
开启/关闭事件流作业日志功能。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/eventrouter/jobs/{job_id}/log
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户资源空间ID |
job_id | 是 | String | 作业ID |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
enabled | 是 | Boolean | 开启或者关闭事件流作业日志 true: 开启 false: 关闭 |
log_group_id | 否 | String | 用户侧日志组ID,开启日志时不填此参数则由EG云服务创建自定义日志组 |
log_stream_id | 否 | String | 用户侧日志流ID,开启日志时不填此参数则由EG云服务创建自定义日志流 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
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 |
参数 | 参数类型 | 描述 |
|---|---|---|
source_kafka | KafkaParameters object | kafka配置 |
source_rocketmq | RocketmqParameters object | rocketmq配置 |
source_dcs | DcsParameters object | dcs配置 |
参数 | 参数类型 | 描述 |
|---|---|---|
sink_kafka | KafkaParameters object | kafka配置 |
sink_rocketmq | RocketmqParameters object | rocketmq配置 |
sink_dcs | DcsParameters object | dcs配置 |
参数 | 参数类型 | 描述 |
|---|---|---|
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时必填 |
参数 | 参数类型 | 描述 |
|---|---|---|
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时必填 |
参数 | 参数类型 | 描述 |
|---|---|---|
config_type | String | 实例类型 CLOUD:云服务DCS实例 |
region | String | 区域id |
project_id | String | 资源空间ID |
instance_id | String | dcs实例ID,配置类型选择CLOUD时必填 |
address | String | dcs地址 |
password | String | 用户密码 |
参数 | 参数类型 | 描述 |
|---|---|---|
kafka2kafka | Kafka2KafkaAdvanceConfig object | kafka同步自定义配置 |
rocketmq2rocketmq | rocketmq同步自定义配置 | |
dcs2dcs | Dcs2DcsAdvanceConfig object | dcs同步自定义配置 |
参数 | 参数类型 | 描述 |
|---|---|---|
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映射 |
参数 | 参数类型 | 描述 |
|---|---|---|
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压缩算法 |
参数 | 参数类型 | 描述 |
|---|---|---|
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同步的映射关系 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_detail | String | 错误详情 |
error_msg | String | 错误信息 |
请求示例
开启事件流作业日志
https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/{job_id}/log { "enabled" : true, "log_group_id" : "xxxxxxxxxxx", "log_stream_id" : "xxxxxxxxxxx" }关闭事件流作业日志
https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/{job_id}/log { "enabled" : false, "log_group_id" : "", "log_stream_id" : "" }
响应示例
状态码:200
开启事件流作业日志成功
{
"job_id" : "1a84ce5e-d060-1000-0094-xxxxxxxxxxx",
"cluster_id" : "1a84cdab-8ae0-1000-0094-xxxxxxxxxxx",
"name" : "eventRoute-xxxxxxxxxxx",
"description" : "",
"scene_type" : "DISASTER_BACKUP",
"source_type" : "ROCKETMQ",
"source_config" : null,
"sink_type" : "ROCKETMQ",
"sink_config" : null,
"advance_config" : null,
"status" : "PAUSED",
"updated_time" : "2025-04-12T02:14:02Z",
"vpc_id" : "0c4975eb-5575-4be0-b788-xxxxxxxxxxx",
"subnet_id" : "33bd70bd-1d62-4438-96c8-xxxxxxxxxxx",
"source_status" : "UNDEFINED",
"source_status_info" : "",
"sink_status" : "UNDEFINED",
"sink_status_info" : "",
"log_group_id" : "3cfe3347-43b9-4aa4-b62e-xxxxxxxxxxx",
"log_stream_id" : "1a5b9d49-3003-49d3-93af-xxxxxxxxxxx"
} 状态码:400
开启事件流作业日志失败
{
"err_code" : "00513000",
"err_detail" : "EventRoute task log is already enabled.",
"err_msg" : "invalid parameters"
} 状态码
状态码 | 描述 |
|---|---|
200 | 开启事件流作业日志成功 |
400 | 开启事件流作业日志失败 |
错误码
请参见错误码。

