文档

UpdateEventStreaming - 修改一个事件流

更新时间:

修改一个事件流的基础信息、事件源信息、事件过滤模式或事件目标信息。

接口说明

修改一个事件流的基础信息、事件源信息、事件过滤模式或事件目标信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
EventStreamingNamestring

事件流的名称。

myeventstreaming
Descriptionstring

事件流的描述。

rocketmq2mns
FilterPatternstring

事件过滤规则,如果不指定表示匹配全部事件。

Sourceobject

事件提供方。必须选择一种 Source,且最多只能选择一种 Source 进行填选。

SourceMNSParametersobject

Source MNS 参数

RegionIdstring

地域 ID。

cn-hangzhou
QueueNamestring

队列名称

queue_api_1642474203601
IsBase64Decodeboolean

是否开启 Base64 编码。默认为 true。

true
SourceRabbitMQParametersobject

Source RabbitMQ 源

RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

消息队列 RabbitMQ 版的实例的 ID。

i-f8z9lqkldlb4oxsxwwub
VirtualHostNamestring

消息队列 RabbitMQ 版实例的 Vhost 的名称。

eb-connect
QueueNamestring

消息队列 RabbitMQ 版实例的 Queue 的名称。

demo
SourceKafkaParametersobject

Source Kafka 源

RegionIdstring

地域 ID。

cn-zhangjiakou
InstanceIdstring

实例 ID。

i-8vbh4a5b9yfhgkkzm****
Topicstring

Topic 名称。

topic_empower_1641539400786
ConsumerGroupstring

订阅该 Topic 的消费者所对应的 Group ID。

DEFAULT_GROUP
OffsetResetstring

偏移量。

latest
Networkstring

网络配置 :默认值 Default,vpc 网络是 PublicNetwork

Default
VpcIdstring

专有网络 VPC 的 ID。

vpc-2ze6p0o345nykmekxt****
VSwitchIdsstring

交换机 ID。

vsw-wz9t1l1e8eu2om****
SecurityGroupIdstring

安全组 ID。

sg-uf6jcm3y5hcs7hkl****
SourceRocketMQParametersobject

Source RocketMQ 源

RegionIdstring

消息队列 RocketMQ 版的地域 ID。

cn-shanghai
InstanceIdstring

消息队列 RocketMQ 版的实例 ID。

i-f8z9a9mcgwri1c1id****
Topicstring

topic 名称。

TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
Tagstring

消息的过滤标签。

test
Offsetstring

消息的消费位点。取值说明如下:

  • CONSUMEFROMLASTOFFSET:从最新位点开始消费。
  • CONSUMEFROMFIRSTOFFSET:从最早位点开始消费。
  • CONSUMEFROMTIMESTAMP:从指定时间点的位点开始消费。

默认值:CONSUMEFROMLAST_OFFSET。

CONSUMEFROMLASTOFFSET
GroupIDstring

消息队列 RocketMQ 版的 Group ID。

GID_test
Timestamplong

时间戳。仅当参数 Offset 取值为 CONSUMEFROMTIMESTAMP 时,该参数有效。

1670656652009
InstanceTypestring

实例类型

2
InstanceEndpointstring

实例接入点

reg****-vpc.cn-zhangjiakou.aliyuncs.com
InstanceUsernamestring

实例用户名。

admin
InstancePasswordstring

实例密码。

admin
AuthTypestring

鉴权类型。

ACL
InstanceVpcIdstring

实例 VPC 信息。

vpc-m5e3sv4b12345****
InstanceVSwitchIdsstring

实例交换机信息。

vsw-m5ev8asdc6h12****
InstanceSecurityGroupIdstring

实例安全组信息。

sg-m5edtu24f12345****
InstanceNetworkstring

实例网络信息:

PublicNetwork PrivateNetwork

PublicNetwork
SourceMQTTParametersobject

Source MQTT 源

RegionIdstring

地域 ID。

cn-shanghai
InstanceIdstring

实例 ID。

i-bp1dsudbecqwt61j****
Topicstring

Topic 名称。

topic_empower_1642400400779
SourceDTSParametersobject

Source DTS 源

TaskIdstring

任务 ID。

f86e5814-b223-482c-b768-3b873297****
BrokerUrlstring

数据订阅通道的网络地址及端口号信息。

Topicstring

数据订阅通道的订阅 Topic。

LTC_CACHE_PRD
Sidstring

消费组 ID。

hkprdb
Usernamestring

消费组的账号。

admin
Passwordstring

消费组的账号密码。

admin
InitCheckPointlong

消费位点,即 SDK 客户端消费第一条数据的时间戳,格式为 Unix 时间戳。

1620962769
SourceSLSParametersobject

Source SLS 源

RoleNamestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
SourcePrometheusParametersobject

Source Prometheus 事件源

ClusterIdstring

集群 id

c83555068b6******ad213f565f209
DataTypestring

数据类型

json
Labelsstring

标签

__name__=.*
Sinkobject

事件目标。必须选择一种 Sink,且最多只能选择一种 Sink 进行填选。

SinkMNSParametersobject

MNS 事件目标

QueueNameobject

目标服务类型为消息服务 MNS。

Valuestring

消息服务 MNS 的 Queue 的名称。

MyQueue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
IsBase64Encodeobject

是否开启 Base64 编码。

Valuestring

开启 Base64 编码。

true
Formstring

事件转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkFcParametersobject

函数目标。

ServiceNameobject

服务的名称。

Valuestring

服务的名称。

myService
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

FunctionNameobject

函数名称。

Valuestring

函数名称。

mFunction
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Concurrencyobject

投递并发度,最小 1。

Valuestring

投递并发度,最小 1。

1
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Qualifierobject

函数所属服务的别名。

Valuestring

函数所属服务的别名。

LATEST
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InvocationTypeobject

同步或则异步。 Sync:同步。 Async:异步。

Valuestring

调用类型。

Async
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

发送给函数的内容体。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkRabbitMQParametersobject

Sink Rabbitmq 的参数。

InstanceIdobject

目标服务类型为消息队列 RabbitMQ 版。

Valuestring

消息队列 RabbitMQ 版的实例 ID。

amqp-cn-2r42e73o****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VirtualHostNameobject

消息队列 RabbitMQ 版实例的 Vhost 的名称。

Valuestring

消息队列 RabbitMQ 版实例的 Vhost 的名称。

rabbit-host
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

TargetTypeobject

目标类型。

Valuestring

目标类型。取值说明如下:

  • Exchange:Exchange 模式。
  • Queue:Queue 模式。
Exchange/Queue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Exchangeobject

Exchange 模式。 仅当参数 TargetType 配置为 Exchange 时,需配置此参数。

Valuestring

消息队列 RabbitMQ 版实例的 Exchange 的名称。

a_exchange
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

RoutingKeyobject

消息的路由规则。 仅当参数 TargetType 配置为 Exchange 时,需配置此参数。

Valuestring

消息的路由规则。

housekeeping
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

QueueNameobject

Queue 模式。 仅当参数 TargetType 配置为 Queue 时,需配置此参数。

Valuestring

实例的 Queue 的名称。

MyQueue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
MessageIdobject

消息 ID。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkKafkaParametersobject

Sink kafak 参数

InstanceIdobject

目标服务类型为消息队列 Kafka 版。

Valuestring

实例 ID。

Defaut_1283278472_s****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

主题名称。

Valuestring

主题名称。

test
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Acksobject

写入 Kafka 确认模式:

  • acks=0:无需服务端的 Response、性能较高、丢数据风险较大。
  • acks=1:服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失;
  • acks=all:服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
Valuestring

写入 Kafka 确认模式:

  • acks=0:无需服务端的 Response、性能较高、丢数据风险较大。
  • acks=1:服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失;
  • acks=all:服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
1
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Keyobject

消息的标识。

Valuestring

消息的标识。

key
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Valueobject

消息体内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkRocketMQParametersobject

Sink RocketMQ Parameters

InstanceIdobject

目标服务类型为消息队列 RocketMQ 版。

Valuestring

消息队列 RocketMQ 版的实例 ID。

MQ_INST_164901546557****_BAAN****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

消息队列 RocketMQ 版实例的 Topic。

Valuestring

消息队列 RocketMQ 版实例的 Topic。

Mytopic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Keysobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Tagsobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkSLSParametersobject

Sink SLS Parameters

Projectobject

日志服务 SLS 的日志项目。

Valuestring

日志服务 SLS 的日志项目。

test-project
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

LogStoreobject

日志服务 SLS 的日志库。

Valuestring

日志服务 SLS 的日志库。

test-logstore
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

日志所在的 topic,对应 SLS 保留字段“topic”。

Valuestring

日志所在的 topic,对应 SLS 保留字段“topic”。

testTopic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

发送给 SLS 的内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
RoleNameobject

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

Valuestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkFnfParametersobject

Sink Fnf 参数

FlowNameobject

流程名称

Valuestring

流程名称

test-streaming-fnf
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

ExecutionNameobject

执行名称

Valuestring

执行名称

123
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

Inputobject

执行输入信息

Valuestring

执行输入信息

123
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

RoleNameobject

角色配置

Valuestring

角色配置

Al****FNF-x****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

SinkPrometheusParametersobject

Sink Prometheus 参数

URLobject

Prometheus Remote Write URL 地址

Valuestring

Prometheus Remote Write URL 地址

https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275****/c5b7faeb2e8994641*****d5c559f/cn-hangzhou/api/v3/write
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

AuthorizationTypeobject

鉴权方式

Valuestring

鉴权方式

BASIC_AUTH
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Usernameobject

用户名

Valuestring

用户名

***admin
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Passwordobject

密码

Valuestring

密码

abc
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Dataobject

指标内容

Valuestring

指标内容

$.data
Formstring

转换的格式。默认为 JSONPATH。

JSONPATH
Templatestring

NetworkTypeobject

网络类型

Valuestring

网络类型

PrivateNetwork
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VpcIdobject

VPC ID。

Valuestring

VPC ID。

vpc-adw1awdw*****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VSwitchIdobject

交换机 Id

Valuestring

交换机 Id

vsw-dwaafds****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SecurityGroupIdobject

安全组 ID。

Valuestring

安全组 ID。

sg-mw43*****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

RunOptionsobject

运行环境参数。

MaximumTaskslong

并发数。

2
ErrorsTolerancestring

异常容忍策略:NONE(不容忍异常)、ALL(容忍所有异常)。

ALL
RetryStrategyobject

事件推送失败时的重试策略。

PushRetryStrategystring

重试策略:BACKOFF_RETRY(退避重试)和 EXPONENTIAL_DECAY_RETRY(指数衰减重试)。

BACKOFF_RETRY
MaximumEventAgeInSecondslong

最大重试时间。

512
MaximumRetryAttemptslong

最大重试次数。

2
DeadLetterQueueobject

是否启用死信队列。默认不启用死信队列,超过重试策略后的消息将被丢弃。

Arnstring

死信队列 ARN。

acs:ram::131733464781****:role/rdstoecsassumekms
BatchWindowobject

攒批窗口。

CountBasedWindowinteger

窗口中最大可容纳的事件数量。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

100
TimeBasedWindowinteger

窗口中最大可容纳的时间范围内的事件(单位秒)。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

10
Transformsobject []

Transform 相关配置

Arnstring

云产品的 ARN,比如函数计算中函数的 ARN

acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func

返回参数

名称类型描述示例值
object
Messagestring

错误信息。

The name [xxxx] of event streaming in request is already exist!
RequestIdstring

阿里云为该请求生成的唯一标识符。

0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5
Codestring

接口返回码:Success:表示成功。 其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回 true。

true

示例

正常返回示例

JSON格式

{
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5",
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code错误码错误信息
403ServiceNotEnableService not enable

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-21OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2024-01-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2023-12-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
2023-11-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403