文档

CreateEventStreaming - 创建一个事件流

更新时间:

创建一个事件流。

接口说明

创建一个事件流。

调试

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

授权信息

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

请求参数

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

事件流的名称。

myeventstreaming
Descriptionstring

事件流的描述。

rocketmq2mns
FilterPatternstring

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

Sourceobject

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

SourceMNSParametersobject

Source MNS 参数

RegionIdstring

地域 id。

cn-beijing
QueueNamestring

队列名称

queue_api_1642474203601
IsBase64Decodeboolean

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

true
SourceRabbitMQParametersobject

Source RabbitmQ 源

RegionIdstring

地域 id,您可以调用 describeregions 查询。

cn-hangzhou
InstanceIdstring

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

gtm-cn-k2c2yfg****
VirtualHostNamestring

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

eb-connect
QueueNamestring

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

demo
SourceKafkaParametersobject

Source Kafka 源

RegionIdstring

地域 ID。

cn-hangzhou
InstanceIdstring

实例 ID。

r-8vb64581862c****
Topicstring

Topic 名称。

popvip_center_robot_order
ConsumerGroupstring

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

DEFAULT_GROUP
OffsetResetstring

偏移量。

latest
Networkstring

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

Default
VpcIdstring

VPC ID。

vpc-8vblalsi0vbhizr77****
VSwitchIdsstring

虚拟交换机 ID。

vsw-bp179l3llg3jjxwrq72****
SecurityGroupIdstring

安全组 ID。

sg-bp1iv19sp1msc7zot4****
SourceRocketMQParametersobject

Source RocketMQ 源

RegionIdstring

地域 ID。

cn-qingdao
InstanceIdstring

消息队列 RocketMQ 版的实例所属地域。

default_C56C36026****
Topicstring

消息服务的主题。

Topic_publicRule_api_1667273421288
Tagstring

消息的过滤标签。

test
Offsetstring

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

  • CONSUME_FROM_LAST_OFFSET:从最新位点开始消费。
  • CONSUME_FROM_FIRST_OFFSET:从最早位点开始消费。
  • CONSUME_FROM_TIMESTAMP:从指定时间点的位点开始消费。

默认值:CONSUME_FROM_LAST_OFFSET。

CONSUMEFROMLAST_OFFSET
GroupIDstring

消息队列 RocketMQ 版的 Group ID。

GID_group1
Timestamplong

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

1670656652009
InstanceTypestring

实例类型。

2
InstanceEndpointstring

实例接入点。

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

实例用户名。

admin
InstancePasswordstring

实例密码。

admin
Networkstring

网络类型:PublicNetwork,PrivateNetwork。

PrivateNetwork
FilterTypestring

消息过滤类型。

Tag
FilterSqlstring

sql 过滤语句。

index > 10
AuthTypestring

鉴权类型。

ACL
VpcIdstring

跨境任务 VPC ID。

vpc-m5e3sv4b12345****
VSwitchIdsstring

跨境任务 VSwitchIds。

vsw-m5ev8asdc6h12345****
SecurityGroupIdstring

跨境任务安全组。

sg-m5edtu24f12345****
InstanceVpcIdstring

实例 VPC 信息。

vpc-m5e3sv4b12345****
InstanceVSwitchIdsstring

实例交换机信息。

vsw-m5ev8asdc6h123456****
InstanceSecurityGroupIdstring

实例安全组信息。

sg-m5edtu24f12345****
InstanceNetworkstring

实例网络信息:

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
SourceMQTTParametersobject

Source MQTT 源

RegionIdstring

地域 ID。

cn-shenzhen
InstanceIdstring

实例 ID。

r-bp1b5ncun5lqer****
Topicstring

消息的 Topic。

CANAL_VICUTU_UAT
SourceDTSParametersobject

Source DTS 源

TaskIdstring

任务 id。

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

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

Topicstring

数据订阅通道的订阅 Topic。

LTC_CACHE_PRD
Sidstring

消费组 ID。

HD3
Usernamestring

消费组的账号。

admin
Passwordstring

消费组的账号密码。

admin
InitCheckPointlong

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

1620962769
SourceSLSParametersobject

Source SLS 源

Projectstring

日志服务 SLS 的日志项目。

test
LogStorestring

日志服务 SLS 的日志库。

sas-log
ConsumePositionstring

起始消费位点,可以选择最早或最新位点,分别对应“begin”,“end”,也可以从指定时间开始消费,以秒为单位。

end
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

模板样式。

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

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

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

是否开启 Base64 编码。

Valuestring

开启 Base64 编码。

true
Formstring

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

CONSTANT
Templatestring

模板样式。

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

Sink Rabbitmq 的参数

InstanceIdobject

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

Valuestring

消息队列 RabbitMQ 版的实例 ID。

a5ff91ad4f3f24947887fe184fc2****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring

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

rabbit-host
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

目标类型。

Valuestring

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

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

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring

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

a_exchange
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring

消息的路由规则。

housekeeping
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring

实例的 Queue 的名称。

MyQueue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

The value of ${key} is ${value}!
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

模板样式。

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

主题名称。

Valuestring

主题的名称。

test
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

The value of ${key} is ${value}!
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

模板样式。

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

消息键。

Valuestring

消息键。

key
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

消息体。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

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

函数目标。

ServiceNameobject

服务名。

Valuestring

服务名。

myService
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

函数名。

Valuestring

函数名。

myFunction
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

投递并发度,最小 1。

Valuestring

投递并发度,最小 1。

1
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

服务版本。

Valuestring

服务版本。

LATEST
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

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

Valuestring

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

Async
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

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

发送给函数的内容体。

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

模板样式。

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

消息队列 RocketMQ 版实例的 Topic。

Valuestring

消息队列 RocketMQ 版实例的 Topic 名称。

Mytopic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式

The value of ${key} is ${value}!
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}!
InstanceTypeobject

实例类型。

Valuestring

实例类型。

2
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstanceEndpointobject

实例接入点。

Valuestring

实例接入点。

vbr-8vbsvkkbpf3vb0zef****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstanceUsernameobject

实例用户名。

Valuestring

实例用户名。

admin
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstancePasswordobject

实例密码。

Valuestring

实例密码。

admin
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VpcIdobject

VPC 的 ID。

Valuestring

VPC 的 ID。

vbr-8vb835n3zf9shwlvb****
Formstring

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

CONSTANT
Templatestring

VSwitchIdsobject

交换机 ID。