更新事件流
功能介绍
更新事件流。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v1/{project_id}/eventstreamings/{eventstreaming_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
eventstreaming_id |
是 |
String |
事件流ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:16384 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
事件流名称,租户下唯一,由字母、数字、点、下划线和中划线组成,必须字母或数字开头 最小长度:1 最大长度:128 |
description |
否 |
String |
事件流描述 最大长度:255 |
source |
是 |
EventStreamingSource object |
事件源,一个事件流中事件源只有一个 |
sink |
是 |
EventStreamingSink object |
事件目标,一个事件流中只有一个 |
rule_config |
否 |
rule_config object |
事件规则,包括过滤规则和转换规则 |
option |
否 |
RunOption object |
运行时配置信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source_kafka |
否 |
SourceKafkaMQParameters object |
华为云DMS版kafka类型事件源 |
source_mobile_rocketmq |
否 |
SourceMobileMQParameters object |
移动云版rocketMQ类型事件源 |
source_community_rocketmq |
否 |
SourceCommunityMQParameters object |
社区版rocketMQ类型事件源 |
source_dms_rocketmq |
否 |
SourceDMSMQParameters object |
华为云DMS版rocketMQ事件源 |
name |
否 |
String |
事件源类型名称 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
addr |
否 |
String |
kafka连接地址 |
group |
是 |
String |
kafka消费组 最小长度:1 最大长度:256 |
instance_name |
否 |
String |
kafka实例名称 最小长度:4 最大长度:64 |
security_protocol |
否 |
String |
安全协议 |
instance_id |
否 |
String |
kafka实例ID 最小长度:1 最大长度:256 |
topic |
是 |
String |
kafka topic名称 最小长度:3 最大长度:200 |
seek_to |
否 |
String |
消费点位 枚举值:
|
enable_sasl_ssl |
否 |
Boolean |
SASL_SSL是否开启 |
sasl_mechanism |
否 |
String |
SASL认证机制 枚举值:
|
ssl_certificate_url |
否 |
String |
SASL证书地址,配置的obs地址 最小长度:1 最大长度:512 |
ssl_certificate_pwd |
否 |
String |
SASL证书密码 最小长度:1 最大长度:256 |
user_name |
否 |
String |
用户名 最小长度:1 最大长度:256 |
password |
否 |
String |
用户密码 最小长度:1 最大长度:256 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
String |
消费组id 最小长度:3 最大长度:128 |
instance_id |
是 |
String |
实例id 最小长度:3 最大长度:128 |
topic |
是 |
String |
topic 最小长度:3 最大长度:128 |
tag |
否 |
String |
标签 最大长度:128 |
authentication_required |
否 |
Boolean |
鉴权认证 |
msg_trace_switch |
否 |
Boolean |
保存消息轨迹 |
access_key |
否 |
String |
AccessKey 最大长度:128 |
secret_key |
否 |
String |
SecretKey 最大长度:128 |
message_model |
是 |
String |
订阅方式 缺省值:CLUSTERING 枚举值:
|
addr_type |
是 |
String |
接入点类型 缺省值:PUBLIC 枚举值:
|
addr |
是 |
String |
地址 最大长度:256 |
sdk_url |
是 |
String |
依赖SDK 最大长度:256 |
consume_timeout |
是 |
Integer |
消费超时时间 最小值:1000 最大值:900000 缺省值:30000 |
message_type |
是 |
String |
消息类型 枚举值:
|
suspend_time |
否 |
Integer |
失败重试的等待时间 最小值:10 最大值:1800 缺省值:1800 |
max_reconsumer_times |
否 |
Integer |
最大重试次数 最小值:1 最大值:16 缺省值:3 |
consumer_thread_nums |
否 |
Integer |
消费线程数 最小值:20 最大值:64 缺省值:20 |
consumer_batch_max_size |
否 |
Integer |
批量消费最大消息数 最小值:1 最大值:1024 缺省值:20 |
consumer_max_wait |
否 |
Integer |
批量消费最大等待时长,单位:秒 最小值:0 最大值:450 缺省值:5 |
vpc_id |
否 |
String |
虚拟私有云 |
subnet_id |
否 |
String |
子网 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_name |
否 |
String |
实例名称,仅dms的rockectMq需要该字段 最大长度:128 |
instance_id |
否 |
String |
实例ID,仅dms的rockectMq需要该字段 最大长度:128 |
addr |
是 |
String |
rockectMq连接地址 |
group |
是 |
String |
消费组 最小长度:3 最大长度:64 |
topic |
是 |
String |
topic名称 最小长度:3 最大长度:64 |
tag |
否 |
String |
标签 最大长度:128 |
vpc_id |
是 |
String |
虚拟云id 最大长度:256 |
subnet_id |
是 |
String |
子网id 最大长度:256 |
ssl_enable |
否 |
Boolean |
开启SSL |
enable_acl |
否 |
Boolean |
ACL访问控制 |
access_key |
否 |
String |
用户名 最大长度:128 |
secret_key |
否 |
String |
密码 |
message_type |
否 |
String |
消息类型 枚举值:
|
consume_timeout |
否 |
Integer |
消费超时时间 最小值:1000 最大值:900000 缺省值:30000 |
consumer_thread_nums |
否 |
Integer |
线程消费数 最小值:20 最大值:64 缺省值:20 |
consumer_batch_max_size |
否 |
Integer |
批量消费最大消息数 最小值:1 最大值:32 缺省值:1 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
instance_name |
否 |
String |
实例名称,仅dms的rockectMq需要该字段 最大长度:128 |
instance_id |
是 |
String |
实例ID,仅dms的rockectMq需要该字段 最大长度:128 |
group |
是 |
String |
消费组 最小长度:3 最大长度:64 |
topic |
是 |
String |
topic名称 最小长度:3 最大长度:64 |
tag |
否 |
String |
标签 最大长度:128 |
ssl_enable |
否 |
Boolean |
开启SSL |
enable_acl |
否 |
Boolean |
ACL访问控制 |
access_key |
否 |
String |
用户名 最大长度:128 |
secret_key |
否 |
String |
密码 |
message_type |
否 |
String |
消费方式,针对不同生产顺序消息类型,选择消费方式会导致不同结果,请严格按照需求选择消费方式。1、生产顺序为:设置消息组,保证消息顺序发送。消费方式为:顺序消费,实际消息处理结果:按照消息组粒度,严格保证消息顺序。 同一消息组内的消息的消费顺序和发送顺序完全一致。2、生产顺序为:设置消息组,保证消息顺序发送。消费方式为:并发消费,实际消息处理结果:并发消费,尽可能按时间顺序处理。3、生产顺序为:未设置消息组,消息乱序发送。消费方式为:顺序消费,实际消息处理结果:按队列存储粒度,严格顺序。 基于 Apache RocketMQ 本身队列的属性,消费顺序和队列存储的顺序一致,但不保证和发送顺序一致。4、生产顺序为:未设置消息组,消息乱序发送。消费方式为:并发消费,实际消息处理结果:并发消费,尽可能按照时间顺序处理。 枚举值:
|
engine_version |
否 |
String |
mq实例版本 枚举值:
|
consume_timeout |
否 |
Integer |
消费超时时间 最小值:1000 最大值:900000 缺省值:30000 |
consumer_thread_nums |
否 |
Integer |
线程消费数 最小值:20 最大值:64 缺省值:20 |
consumer_batch_max_size |
否 |
Integer |
批量消费最大消息数 最小值:1 最大值:32 缺省值:1 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sink_fg |
否 |
SinkFGParameters object |
函数目标参数 |
sink_kafka |
否 |
SinkKafkaParameters object |
kafka目标参数 |
name |
否 |
String |
事件目标类型名称 枚举值:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
invoke_type |
否 |
String |
函数执行方式,同步/异步 枚举值:
|
urn |
否 |
String |
函数链接 最小长度:1 最大长度:512 |
agency |
否 |
String |
租户委托 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
topic |
是 |
String |
topic名称 |
keyTransform |
否 |
Array of TransForm objects |
key的转换规则 |
connectionId |
是 |
String |
目标连接id |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
转换规则类型 枚举值:
|
value |
否 |
String |
常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。 最大长度:1024 |
template |
否 |
String |
变量类型规则时,规则内容的模板定义,支持对已定义变量的引用。 最大长度:2048 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
thread_num |
是 |
Integer |
并发数 最小值:1 最大值:1000 |
batch_window |
否 |
BatchWindow object |
批量推送 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. |
参数 |
参数类型 |
描述 |
---|---|---|
eventStreamingID |
String |
事件流ID |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:128 |
error_msg |
String |
错误消息 最小长度:1 最大长度:512 |
error_details |
String |
具体错误消息 最小长度:1 最大长度:1024 |
request_id |
String |
请求处理ID 最小长度:1 最大长度:128 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:128 |
error_msg |
String |
错误消息 最小长度:1 最大长度:512 |
error_details |
String |
具体错误消息 最小长度:1 最大长度:1024 |
request_id |
String |
请求处理ID 最小长度:1 最大长度:128 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:128 |
error_msg |
String |
错误消息 最小长度:1 最大长度:512 |
error_details |
String |
具体错误消息 最小长度:1 最大长度:1024 |
request_id |
String |
请求处理ID 最小长度:1 最大长度:128 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:128 |
error_msg |
String |
错误消息 最小长度:1 最大长度:512 |
error_details |
String |
具体错误消息 最小长度:1 最大长度:1024 |
request_id |
String |
请求处理ID 最小长度:1 最大长度:128 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 最小长度:1 最大长度:128 |
error_msg |
String |
错误消息 最小长度:1 最大长度:512 |
error_details |
String |
具体错误消息 最小长度:1 最大长度:1024 |
request_id |
String |
请求处理ID 最小长度:1 最大长度:128 |
请求示例
无
响应示例
状态码: 400
{ "error_code" : "EG.00014000", "error_msg" : "Bad request" }
状态码: 401
{ "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed" }
状态码: 403
{ "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method" }
状态码: 404
{ "error_code" : "EG.00014040", "error_msg" : "Not request resource found" }
状态码: 500
{ "error_code" : "EG.00015000", "error_msg" : "Internal Server Error" }
状态码
状态码 |
描述 |
---|---|
200 |
更新事件流配置成功 |
400 |
非法请求 |
401 |
未授权 |
403 |
禁止访问 |
404 |
未找到资源 |
500 |
内部服务错误 |
错误码
请参见错误码。