All Products
Search
Document Center

EventBridge:CreateEventStreaming

Last Updated:Dec 19, 2025

Creates an event stream.

Operation description

Creates an event stream.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

EventStreamingName

string

Yes

The name of the event stream.

myeventstreaming

Description

string

No

The description of the event stream.

rocketmq2mns

FilterPattern

string

Yes

The event filtering rule. If you do not specify this parameter, all events are matched.

{ "source": [ { "prefix": "acs:mns" } ], "type": [ { "prefix": "mns:Queue" } ], "subject": [ { "prefix": "acs:mns:cn-hangzhou:123456789098****:queues/zeus" } ] }

Source

object

Yes

The event source. You must specify a source, and you can specify only one source.

SourceMNSParameters

object

No

The parameters for the MNS event source.

RegionId

string

No

The region ID.

cn-beijing

QueueName

string

No

The queue name.

queue_api_1642474203601

IsBase64Decode

boolean

No

Specifies whether to enable Base64 encoding. Default value: true.

true

SourceRabbitMQParameters

object

No

The RabbitMQ event source.

RegionId

string

No

The region ID.

cn-hangzhou

InstanceId

string

No

The ID of the ApsaraMQ for RabbitMQ instance.

gtm-cn-k2c2yfg****

VirtualHostName

string

No

The vhost name of the ApsaraMQ for RabbitMQ instance.

eb-connect

QueueName

string

No

The queue name of the ApsaraMQ for RabbitMQ instance.

demo

SourceKafkaParameters

object

No

The Kafka event source.

RegionId

string

No

The region ID.

cn-hangzhou

InstanceId

string

No

The instance ID.

r-8vb64581862c****

Topic

string

No

The topic name.

popvip_center_robot_order

ConsumerGroup

string

No

The ID of the consumer group that subscribes to the topic.

DEFAULT_GROUP

OffsetReset

string

No

The consumer offset.

latest

Network

string

No

The network type. Default value: Default. For a VPC, set the value to PublicNetwork.

Default

VpcId

string

No

The VPC ID.

vpc-8vblalsi0vbhizr77****

VSwitchIds

string

No

The vSwitch ID.

vsw-bp179l3llg3jjxwrq72****

SecurityGroupId

string

No

The security group ID.

sg-bp1iv19sp1msc7zot4****

ValueDataType

string

No

The encoding format of the message body.

  • JSON

  • Text

  • Binary

JSON

SourceRocketMQParameters

object

No

The ApsaraMQ for RocketMQ event source.

RegionId

string

No

The region ID.

cn-qingdao

InstanceId

string

No

The region of the Message Queue for Apache RocketMQ instance.

default_C56C36026****

Topic

string

No

The topic of the ApsaraMQ for RocketMQ instance.

Topic_publicRule_api_1667273421288

Tag

string

No

The message filter tag.

test

Offset

string

No

The consumer offset. Valid values:

  • CONSUME_FROM_LAST_OFFSET: Start consumption from the latest offset.

  • CONSUME_FROM_FIRST_OFFSET: Start consumption from the earliest offset.

  • CONSUME_FROM_TIMESTAMP: Start consumption from a specified timestamp.

Default value: CONSUME_FROM_LAST_OFFSET.

CONSUMEFROMLAST_OFFSET

GroupID

string

No

The group ID of the ApsaraMQ for RocketMQ instance.

GID_group1

Timestamp

integer

No

The timestamp. This parameter is valid only when you set Offset to CONSUME_FROM_TIMESTAMP.

1670656652009

InstanceType

string

No

The instance type. Valid values:

  • Cloud_4: Alibaba Cloud RocketMQ 4.0 instance (default)

  • Cloud_5: Alibaba Cloud RocketMQ 5.0 instance

  • SelfBuilt: Self-managed Apache RocketMQ cluster

Cloud_4

InstanceEndpoint

string

No

The instance endpoint.

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

InstanceUsername

string

No

The instance username.

admin

InstancePassword

string

No

The instance password.

admin

Network

string

No

The network type.

  • PublicNetwork

  • PrivateNetwork

Valid values:

  • PrivateNetwork :

    PrivateNetwork

  • PublicNetwork :

    PublicNetwork

PrivateNetwork

FilterType

string

No

The message filtering type.

Tag

FilterSql

string

No

The SQL filter statement.

index > 10

AuthType

string

No

The authentication type.

ACL

VpcId

string

No

The VPC ID for cross-border tasks.

vpc-m5e3sv4b12345****

VSwitchIds

string

No

The vSwitch ID for cross-border tasks.

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

No

The security group for cross-border tasks.

sg-m5edtu24f12345****

InstanceVpcId

string

No

The VPC information of the instance.

vpc-m5e3sv4b12345****

InstanceVSwitchIds

string

No

The vSwitch information of the instance.

vsw-m5ev8asdc6h123456****

InstanceSecurityGroupId

string

No

The security group information of the instance.

sg-m5edtu24f12345****

InstanceNetwork

string

No

The network information of the instance.

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

BodyDataType

string

No

The message encoding format.

  • JSON

  • Text

  • Binary

JSON

SourceRocketMQCheckpointParameters

object

No

The ApsaraMQ for RocketMQ Checkpoint source.

RegionId

string

No

InstanceType

string

No

InstanceId

string

No

Topics

array

No

string

No

SourceApacheRocketMQCheckpointParameters

object

No

The Apache RocketMQ Checkpoint source.

RegionId

string

No

Topics

array

No

string

No

InstanceEndpoint

string

No

InstanceUsername

string

No

InstancePassword

string

No

NetworkType

string

No

VpcId

string

No

VSwitchId

string

No

SecurityGroupId

string

No

SourceMQTTParameters

object

No

The MQTT event source.

RegionId

string

No

The region ID.

cn-shenzhen

InstanceId

string

No

The instance ID.

r-bp1b5ncun5lqer****

Topic

string

No

The message topic.

CANAL_VICUTU_UAT

BodyDataType

string

No

The message encoding format.

  • JSON

  • Text

  • Binary

JSON

SourceDTSParameters

object

No

The DTS event source.

TaskId

string

No

The task ID.

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

BrokerUrl

string

No

The network address and port number of the change tracking channel.

Topic

string

No

The subscribed topic of the change tracking channel.

LTC_CACHE_PRD

Sid

string

No

The consumer group ID.

HD3

Username

string

No

The account of the consumer group.

admin

Password

string

No

The password of the consumer group account.

admin

InitCheckPoint

integer

No

The consumer offset, which is the UNIX timestamp when the SDK client consumes the first data record.

1620962769

SourceSLSParameters

object

No

The Simple Log Service (SLS) event source.

Project

string

No

The project in Simple Log Service (SLS).

test

LogStore

string

No

The Logstore in SLS.

sas-log

ConsumePosition

string

No

The start consumer offset. You can set this to `begin` or `end` to specify the earliest or latest offset. You can also specify a timestamp in seconds.

end

RoleName

string

No

The RAM role used to grant EventBridge the permissions to read logs from SLS. When you create this role in the RAM console, select Alibaba Cloud Service for Trusted entity type and EventBridge for Select Trusted Service.

testRole

SourcePrometheusParameters

object

No

The Prometheus event source.

RegionId

string

No

The region ID.

cn-hangzhou

ClusterId

string

No

The cluster ID.

c83555068b6******ad213f565f209

DataType

string

No

The data type.

JSON

Labels

string

No

The labels.

__name__=.*

RoleName

string

No

ExternalLabels

string

No

SourceCustomizedKafkaParameters

object

No

The custom Kafka event source.

InstanceId

string

No

The ID of the ApsaraMQ for Kafka instance.

r-8vb64581862c****

SourceCustomizedKafkaConnectorParameters

object

No

The custom Apache Kafka connector event source.

ConnectorPackageUrl

string

No

The download URL of the OSS resource ZIP package.

"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ"

WorkerParameters

object

No

The Kafka instance configuration.

{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }

ConnectorParameters

object

No

The connector parameters.

Name

string

No

The connector name.

test-name

Config

object

No

The connector configuration.

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }

SourceApacheKafkaParameters

object

No

The parameters for the open source Kafka.

Bootstraps

string

No

The endpoint.

Topic

string

No

The topic name.

ConsumerGroup

string

No

The consumer name.

OffsetReset

string

No

The consumer offset. `latest`: The system starts reading data from the latest offset. `earliest`: The system starts reading data from the earliest offset. This setting is valid only for the initial consumption of a new group.

ValueDataType

string

No

The data type. Valid values: Text Binary Json

VpcId

string

No

The VPC ID of the Kafka source.

VSwitchIds

string

No

The list of vSwitch IDs for the Kafka source.

SecurityGroupId

string

No

The security group ID of the Kafka source.

NetworkType

string

No

The network type of the Kafka cluster.

SecurityProtocol

string

No

The security protocol of the Kafka cluster. SASL_SSL PLAINTEXT SASL_PLAINTEXT

SaslMechanism

string

No

The SASL authentication mechanism of the Kafka cluster.

SaslUser

string

No

The SASL username for the Kafka cluster.

SaslPassword

string

No

The SASL password for the Kafka cluster.

SslTruststoreCertificates

string

No

SourceOSSParameters

object

No

The OSS event source.

RoleName

string

No

The name of the RAM role that grants EventBridge the permissions to read files from OSS. This role must have at least the read-only permissions on OSS.

eventbridge_oss_role

BucketName

string

No

The name of the bucket in Object Storage Service (OSS).

bucket_abc

Prefix

string

No

The file path prefix.

fun/document/

LoadMode

string

No

The data loading mode. `single` indicates that a file is loaded as a single document. `element` indicates that a file is loaded in chunks. Valid values: single/element Default value: single

Valid values:

  • single :

    single

  • element :

    element

single

LoadFormat

string

No

The document loader.

Valid values:

  • TextLoader :

    TextLoader

TextLoader

Delimiter

string

No

The separator. In chunk loading mode, this separator is used as the chunk identifier for the text. The default separator is the line feed `\n`.

\n

SourceOpenSourceRabbitMQParameters

object

No

Endpoint

string

No

VirtualHostName

string

No

QueueName

string

No

BodyDataType

string

No

Username

string

No

Password

string

No

VpcId

string

No

VSwitchIds

string

No

SecurityGroupId

string

No

NetworkType

string

No

AuthType

string

No

SourceEventBusParameters

object

No

EventBusName

string

No

EventRuleName

string

No

SourceMySQLParameters SourceMySQLParameters

No

SourcePostgreSQLParameters SourcePostgreSQLParameters

No

SourceRabbitMQMetaParameters SourceRabbitMQMetaParameters

No

SourceRabbitMQMsgSyncParameters SourceRabbitMQMsgSyncParameters

No

Sink

object

Yes

The event target. You must specify a sink, and you can specify only one sink.

SinkMNSParameters

object

No

The MNS event target.

QueueName

object

No

The target service is Message Service (MNS).

Value

string

No

The name of the queue in MNS.

MyQueue

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

Body

object

No

The message body.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

TEMPLATE

Template

string

No

The template style.

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

IsBase64Encode

object

No

Specifies whether to enable Base64 encoding.

Value

string

No

Enable Base64 encoding.

true

Form

string

No

The format of the event transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

SinkRabbitMQParameters

object

No

The parameters for the RabbitMQ sink.

InstanceId

object

No

The target service is ApsaraMQ for RabbitMQ.

Value

string

No

The ID of the ApsaraMQ for RabbitMQ instance.

a5ff91ad4f3f24947887fe184fc2****

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

VirtualHostName

object

No

The vhost name of the ApsaraMQ for RabbitMQ instance.

Value

string

No

The vhost name of the ApsaraMQ for RabbitMQ instance.

rabbit-host

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

TargetType

object

No

The target type.

Value

string

No

The target type. Valid values:

  • Exchange: Exchange mode.

  • Queue: Queue mode.

Exchange/Queue

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Exchange

object

No

The exchange mode. This parameter is required only when you set TargetType to Exchange.

Value

string

No

The exchange name of the ApsaraMQ for RabbitMQ instance.

a_exchange

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

RoutingKey

object

No

The routing rule for the message. This parameter is required only when you set TargetType to Exchange.

Value

string

No

The routing rule for the message.

housekeeping

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

QueueName

object

No

The queue mode. This parameter is required only when you set TargetType to Queue.

Value

string

No

The queue name of the instance.

MyQueue

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Body

object

No

The message body.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

MessageId

object

No

The message ID.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

Properties

object

No

The filter properties.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

SinkKafkaParameters

object

No

The parameters for the Kafka sink.

InstanceId

object

No

The target service is ApsaraMQ for Kafka.

Value

string

No

The instance ID.

Defaut_1283278472_s****

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Topic

object

No

The topic name.

Value

string

No

The topic name.

test

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Acks

object

No

The confirmation mode for writing to Kafka.

  • acks=0: No response from the server is required. This mode offers high performance but carries a high risk of data loss.

  • acks=1: A response is returned after the primary node successfully writes the data. This mode offers medium performance and a medium risk of data loss. Data may be lost if the primary node breaks down.

  • acks=all: A response is returned only after the primary node and all secondary nodes successfully write and sync the data. This mode offers low performance but ensures high data security. Data is lost only if both the primary and secondary nodes break down.

Value

string

No

The confirmation mode for writing to Kafka.

  • acks=0: No response from the server is required. This mode offers high performance but carries a high risk of data loss.

  • acks=1: A response is returned after the primary node successfully writes the data. This mode offers medium performance and a medium risk of data loss. Data may be lost if the primary node breaks down.

  • acks=all: A response is returned only after the primary node and all secondary nodes successfully write and sync the data. This mode offers low performance but ensures high data security. Data is lost only if both the primary and secondary nodes break down.

1

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Key

object

No

The message key.

Value

string

No

The message key.

key

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Value

object

No

The message body.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

Headers

object

No

Value

string

No

Form

string

No

Template

string

No

CompressionType

string

No

SinkApacheKafkaParameters

object

No

Description

Bootstraps

string

No

The initial connection address of the Kafka cluster.

Topic

string

No

Acks

string

No

Key

object

No

Value

string

No

Form

string

No

Template

string

No

Value

object

No

Value

string

No

Form

string

No

Template

string

No

Headers

object

No

Value

string

No

Form

string

No

Template

string

No

SecurityProtocol

string

No

SaslMechanism

string

No

SaslUser

string

No

SslTruststoreCertificates

string

No

CompressionType

string

No

VpcId

object

No

Value

string

No

Form

string

No

Template

string

No

VSwitchIds

object

No

Value

string

No

Form

string

No

Template

string

No

SecurityGroupId

object

No

Value

string

No

Form

string

No

Template

string

No

NetworkType

object

No

Value

string

No

Form

string

No

Template

string

No

SaslPassword

string

No

SinkFcParameters

object

No

The function target.

ServiceName

object

No

The service name.

Value

string

No

The service name.

myService

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

FunctionName

object

No

The function name.

Value

string

No

The function name.

myFunction

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

Concurrency

object

No

The delivery concurrency. Minimum value: 1.

Value

string

No

The delivery concurrency. Minimum value: 1.

1

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

Qualifier

object

No

The service version.

Value

string

No

The service version.

LATEST

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

InvocationType

object

No

The invocation type. Sync: synchronous. Async: asynchronous.

Value

string

No

The invocation type. Sync: synchronous. Async: asynchronous.

Valid values:

  • Async :

    Async

  • Sync :

    Sync

Async

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

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

Body

object

No

The content sent to the function.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

  • ORIGINAL: complete event

  • JSONPATH: partial event

  • CONSTANT: constant

  • TEMPLATE: template

For more information, see https://www.alibabacloud.com/help/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • ORIGINAL :

    ORIGINAL

  • TEMPLATE :

    TEMPLATE

TEMPLATE

Template

string

No

The template style.

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

DataFormat

object

No

Value

string

No

Form

string

No

Template

string

No

SinkRocketMQParameters

object

No

The parameters for the ApsaraMQ for RocketMQ sink.

InstanceId

object

No

The target service is ApsaraMQ for RocketMQ.

Value

string

No

The ID of the ApsaraMQ for RocketMQ instance.

MQ_INST_164901546557****_BAAN****

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Topic

object

No

The topic of the ApsaraMQ for RocketMQ instance.

Value

string

No

The topic name of the ApsaraMQ for RocketMQ instance.

Mytopic

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

The template style.

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

Body

object

No

The message body.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

Properties

object

No

The filter properties.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

Keys

object

No

The filter properties.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

Tags

object

No

The filter properties.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

InstanceType

object

No

The instance type.

Value

string

No

The instance type. Valid values:

  • Cloud_4: Alibaba Cloud RocketMQ 4.0 instance (default)

  • Cloud_5: Alibaba Cloud RocketMQ 5.0 instance

  • SelfBuilt: Self-managed Apache RocketMQ cluster

Cloud_4

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

InstanceEndpoint

object

No

The instance endpoint.

Value

string

No

The instance endpoint.

vbr-8vbsvkkbpf3vb0zef****

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

InstanceUsername

object

No

The instance username.

Value

string

No

The instance username.

admin

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

InstancePassword

object

No

The instance password.

Value

string

No

The instance password.

admin

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

VpcId

object

No

The VPC ID.

Value

string

No

The VPC ID.

vbr-8vb835n3zf9shwlvb****

Form

string

No

The format of the event transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

VSwitchIds

object

No

The vSwitch ID.

Value

string

No

The vSwitch ID.

vbr-8vb835n3zf9shwl****mp

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

SecurityGroupId

object

No

The security group ID.

Value

string

No

The security group ID.

b4bf375515f6440f942e3a20c33d****

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

Network

object

No

The network type.

  • PublicNetwork

  • PrivateNetwork

Value

string

No

The network type.

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

DeliveryOrderType

object

No

Value

string

No

Form

string

No

Template

string

No

ShardingKey

object

No

Value

string

No

Form

string

No

Template

string

No

SinkDorisParameters

object

No

The event source type.

QueryEndpoint

object

No

Value

string

No

Form

string

No

Template

string

No

FeHttpEndpoint

object

No

Value

string

No

Form

string

No

Template

string

No

BeHttpEndpoint

object

No

Value

string

No

Form

string

No

Template

string

No

UserName

object

No

Value

string

No

Form

string

No

Template

string

No

Password

object

No

Value

string

No

Form

string

No

Template

string

No

Database

object

No

Value

string

No

Form

string

No

Template

string

No

Table

object

No

Value

string

No

Form

string

No

Template

string

No

Body

object

No

Value

string

No

Form

string

No

Template

string

No

NetworkType

object

No

Value

string

No

Form

string

No

Template

string

No

VpcId

object

No

Value

string

No

Form

string

No

Template

string

No

VSwitchIds

object

No

Value

string

No

Form

string

No

Template

string

No

SecurityGroupId

object

No

Value

string

No

Form

string

No

Template

string

No

SinkRocketMQCheckpointParameters

object

No

The event source type.

InstanceType

string

No

InstanceId

string

No

Topic

object

No

Value

string

No

Form

string

No

Template

string

No

ConsumeTimestamp

object

No

Value

string

No

Form

string

No

Template

string

No

Group

object

No

Value

string

No

Form

string

No

Template

string

No

SinkApacheRocketMQCheckpointParameters

object

No

The event source type.

Topic

object

No

Value

string

No

Form

string

No

Template

string

No

ConsumeTimestamp

object

No

Value

string

No

Form

string

No

Template

string

No

Group

object

No

Value

string

No

Form

string

No

Template

string

No

InstanceEndpoint

string

No

InstanceUsername

string

No

InstancePassword

string

No

NetworkType

string

No

VpcId

string

No

VSwitchId

string

No

SecurityGroupId

string

No

SinkSLSParameters

object

No

The parameters for the SLS sink.

Project

object

No

The project in SLS.

Value

string

No

The project in SLS.

test-project

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

LogStore

object

No

The Logstore in SLS.

Value

string

No

The Logstore in SLS.

test-logstore

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

Topic

object

No

The topic of the log. This corresponds to the `topic` reserved field in SLS.

Value

string

No

The topic of the log. This corresponds to the `topic` reserved field in SLS.

testTopic

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

Body

object

No

The content sent to SLS.

Value

string

No

The value before the transform.

{ "key": "value" }

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

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

RoleName

object

No

The RAM role used to grant EventBridge the permissions to read logs from SLS. When you create this role in the RAM console, select Alibaba Cloud Service for Trusted entity type and EventBridge for Select Trusted Service.

Value

string

No

The RAM role used to grant EventBridge the permissions to read logs from SLS. When you create this role in the RAM console, select Alibaba Cloud Service for Trusted entity type and EventBridge for Select Trusted Service.

testRole

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

ContentType

object

No

The data format for SLS. You can use the default format or specify key-value pairs.

  • JSON

  • KeyValue

Value

string

No

The value before the transform.

JSON

Form

string

No

The format of the transform.

CONSTANT

Template

string

No

The template style.

ContentSchema

object

No

The custom key-value pairs for the log. This parameter is valid only when you set ContentType to KeyValue. Each key-value pair is represented by Key_n and Value_n.

Value

string

No

The value before the transform.

{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}

Form

string

No

The template style.

CONSTANT

Template

string

No

The template style.

SinkDataHubParameters

object

No

The parameters for the DataHub sink.

Project

object

No

The DataHub project name.

Value

string

No

The DataHub project name.

demo-project

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

Topic

object

No

The DataHub topic name.

Value

string

No

The DataHub topic name.

demo-topic

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

TopicType

object

No

The topic type.

  • TUPLE

  • BLOB

Value

string

No

The topic type.

  • TUPLE

  • BLOB

TUPLE

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

TopicSchema

object

No

The content schema of the topic. This parameter is valid only when you set TopicType to TUPLE.

Value

string

No

The content schema of the topic. This parameter is valid only when you set TopicType to TUPLE.

{"k1":"value1","k2":"value2"}

Form

string

No

The format of the transform.

TEMPLATE

Template

string

No

The template style.

{"k1":"${k1}","k2":"${k2}"}

Body

object

No

The content template for the record. This parameter is valid only when you set TopicType to BLOB.

Value

string

No

The content template for the record. This parameter is valid only when you set TopicType to BLOB.

Form

string

No

The format of the transform.

ORIGINAL

Template

string

No

None

RoleName

object

No

The name of the task role.

Value

string

No

The name of the task role.

test-role

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

SinkFnfParameters

object

No

The parameters for the Fnf sink.

FlowName

object

No

The flow name.

Value

string

No

The flow name.

test-streaming-fnf

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

ExecutionName

object

No

The execution name.

Value

string

No

The execution name.

123

Form

string

No

The format of the transform. Default value: CONSTANT

  • JSONPATH: partial event

  • CONSTANT: constant

  • TEMPLATE: template

For more information, see https://www.alibabacloud.com/help/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

CONSTANT

Template

string

No

The template style.

Input

object

No

The execution input.

Value

string

No

The execution input.

123

Form

string

No

The format of the transform.

  • ORIGINAL: complete event

  • JSONPATH: partial event

  • CONSTANT: constant

  • TEMPLATE: template

For more information, see https://www.alibabacloud.com/help/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • ORIGINAL :

    ORIGINAL

  • TEMPLATE :

    TEMPLATE

CONSTANT

Template

string

No

The template style.

RoleName

object

No

The role configuration.

Value

string

No

The role configuration.

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

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style.

SinkPrometheusParameters

object

No

The parameters for the Prometheus sink.

URL

object

No

The Prometheus Remote Write URL.

Value

string

No

The Prometheus Remote Write URL.

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

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

The template style. This parameter is empty when Form is set to CONSTANT.

HeaderParameters

object

No

The data structure of the request header parameters.

Value

string

No

  • If Form is set to CONSTANT: constant value

  • If Form is set to JSONPATH: JSONPath expression

  • If Form is set to TEMPLATE: template variable

Note: The Value field cannot exceed 10,240 characters.

示例1(Form为CONSTANT) name 示例2(Form为JSONPATH) $.data.name 示例3(Form为TEMPLATE) { "name":"$.data.name" }

Form

string

No

The format of the transform.

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

TEMPLATE

Template

string

No

The HTTP request header template style. This parameter is required when Form is set to TEMPLATE. The result of the event content transformation must be in JSON format.

{ "user_name":"${name}" }

AuthorizationType

object

No

The authentication method.

Value

string

No

The authentication method.

Valid values:

  • BASIC_AUTH :

    BASIC_AUTH

BASIC_AUTH

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

Username

object

No

The username.

Value

string

No

The username.

****admin

Form

string

No

The format of the transform. Default value: CONSTANT.

CONSTANT

Template

string

No

None

Password

object

No

The password.

Value

string

No

The password.

*****

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

Data

object

No

The metric content.

Value

string

No

The metric content.

$.data

Form

string

No

The format of the transform. Default value: JSAONPATH.

JSAONPATH

Template

string

No

The template style.

NetworkType

object

No

The network type.

Value

string

No

The network type.

Valid values:

  • PrivateNetwork :

    PrivateNetwork

  • PublicNetwork :

    PublicNetwork

PrivateNetwork

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

VpcId

object

No

The VPC ID.

Value

string

No

The VPC ID.

i-2ze7u5i17mbqtx1p****

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

VSwitchId

object

No

The vSwitch ID.

Value

string

No

The vSwitch ID.

vsw-dwaafds****

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

SecurityGroupId

object

No

The security group ID.

Value

string

No

The security group ID.

sg-mw43*****

Form

string

No

The format of the transform. Default value: CONSTANT.

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT

Template

string

No

None

SinkCustomizedKafkaParameters

object

No

The parameters for the Kafka sink.

InstanceId

string

No

The ID of the ApsaraMQ for Kafka instance.

90be1f96-4229-4535-bb76-34b4f6fb2b71

SinkCustomizedKafkaConnectorParameters

object

No

The parameters for the Kafka connector sink.

ConnectorPackageUrl

string

No

The download URL of the OSS file.

"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ"

ConnectorParameters

object

No

Parses the properties file in the current ZIP package.

Name

string

No

The name of the connector.

mongo-sink

Config

object

No

The connector configuration.

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }

WorkerParameters

object

No

The instance configuration.

{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }

SinkDashVectorParameters

object

No

The parameters for the DashVector sink.

InstanceId

string

No

The instance ID.

vrs-cn-lbj3ru1***

Collection

string

No

The collection name.

collection1

ApiKey

string

No

The API key created in the DashVector console.

Q34nExQH7sQ****

Operation

string

No

The operation type for the DashVector database.

Valid values:

  • Delete :

    Delete

  • Upsert :

    Upsert

Upsert

Network

string

No

The network type.

Valid values:

  • PrivateNetwork :

    PrivateNetwork

  • PublicNetwork :

    PublicNetwork

PublicNetwork

PrimaryKeyId

object

No

The primary key ID for inserting or deleting records.

Note

If you do not specify this parameter, a random primary key ID is used.

Form

string

No

The format of the transform.

Valid values:

  • JSONPATH :

    JSONPATH

  • TEMPLATE :

    TEMPLATE

JSONPATH

Value

string

No

  • If Form is set to JSONPATH: JSONPath expression

  • If Form is set to TEMPLATE: template variable

Note

The Value field cannot exceed 10,240 characters.

$.data.requestId

Template

string

No

The primary key ID template. This parameter is required only when Form is set to TEMPLATE.

${ID}

Partition

object

No

The partition. The default value is the `default` partition.

Form

string

No

The format of the transform.

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

CONSTANT

Value

string

No

  • If Form is set to CONSTANT: constant value

  • If Form is set to JSONPATH: JSONPath expression

Note

The Value field cannot exceed 10,240 characters.

default

Template

string

No

None

Vector

object

No

The vector for the record to be inserted into DashVector.

Form

string

No

The format of the transform.

Valid values:

  • JSONPATH :

    JSONPATH

JSONPATH

Value

string

No

The JSONPath expression.

Note

The Value field cannot exceed 10,240 characters.

$.data.messageBody

Template

string

No

None

DashVectorSchemaParameters

array<object>

No

The schema field definitions for the table entry when inserting into DashVector. The result of the event content transformation must be in JSON format.

array<object>

No

Name

object

No

Form

string

No

CONSTANT

Value

string

No

content

Template

string

No

Type

object

No

Form

string

No

CONSTANT

Value

string

No

STRING

Template

string

No

Value

object

No

Form

string

No

JSONPATH

Value

string

No

$.data.content

Template

string

No

${content}

SinkOpenSourceRabbitMQParameters

object

No

Endpoint

string

No

VirtualHostName

string

No

TargetType

string

No

Exchange

string

No

QueueName

string

No

Username

string

No

Password

string

No

VpcId

string

No

VSwitchIds

string

No

SecurityGroupId

string

No

NetworkType

string

No

AuthType

string

No

RoutingKey

object

No

Form

string

No

Value

string

No

Template

string

No

Body

object

No

Form

string

No

Value

string

No

Template

string

No

MessageId

object

No

Form

string

No

Value

string

No

Template

string

No

Properties

object

No

Form

string

No

Value

string

No

Template

string

No

SinkBaiLianParameters SinkBaiLianParameters

No

SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

No

SinkHttpsParameters

SinkHttpsParameters

No

SinkApiDestinationParameters

SinkApiDestinationParameters

No

SinkOSSParameters SinkOSSParameters

No

SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

No

SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

No

RunOptions

object

No

The runtime environment parameters.

MaximumTasks

integer

No

The number of concurrent tasks.

2

ErrorsTolerance

string

No

The fault tolerance policy.

  • NONE: No exceptions are tolerated.

  • ALL: All exceptions are tolerated.

ALL

RetryStrategy

object

No

The retry policy for failed event pushes.

PushRetryStrategy

string

No

The retry policy.

  • BACKOFF_RETRY: Backoff retry.

  • EXPONENTIAL_DECAY_RETRY: Exponential decay retry.

BACKOFF_RETRY

MaximumEventAgeInSeconds

integer

No

The maximum retry time.

512

MaximumRetryAttempts

integer

No

The maximum number of retries.

2

DeadLetterQueue

object

No

Specifies whether to enable the dead-letter queue. By default, the dead-letter queue is disabled. Messages that fail to be delivered after the retry policy is exhausted are discarded.

Arn

string

No

The ARN of the dead-letter queue.

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

Network

string

No

VpcId

string

No

VSwitchIds

string

No

SecurityGroupId

string

No

BatchWindow

object

No

The batch window.

CountBasedWindow

integer

No

The maximum number of events that can be contained in the window. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, the push is triggered when any one of them meets the condition.

100

TimeBasedWindow

integer

No

The maximum time range for events in the window, in seconds. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, the push is triggered when any one of them meets the condition.

10

BusinessOption

object

No

BusinessMode

string

No

MinCapacityUnitCount

integer

No

MaxCapacityUnitCount

integer

No

Throttling

integer

No

Transforms

array<object>

No

The transform configurations.

object

No

The ARN of the Alibaba Cloud service, such as the ARN of a function in Function Compute.

Arn

string

No

The ARN of the Alibaba Cloud service, such as the ARN of a function in Function Compute.

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

DashScopeTransformParameters

DashScopeTransformParameters

No

BaiLianAgentTransformParameters

BaiLianAgentTransformParameters

No

EmbeddingTransformParameters

EmbeddingTransformParameters

No

Tags

array<object>

No

The list of tags. You can add up to 20 tags.

object

No

Key

string

No

The tag key.

Value

string

No

The tag value.

Response elements

Element

Type

Description

Example

object

The request parameters.

Message

string

The error message.

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

RequestId

string

The request ID.

B896B484-F16D-59DE-9E23-DD0E5C36****

Data

object

The returned data.

EventStreamingARN

string

The Alibaba Cloud Resource Name (ARN) of the event stream.

acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming

Code

string

The return code of the API.

  • Success: The operation was successful.

  • Other: An error code. For more information, see Error codes.

Success

Success

boolean

Returns true if the operation is successful.

true

Examples

Success response

JSON format

{
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C36****",
  "Data": {
    "EventStreamingARN": "acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming"
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

403 ServiceNotEnable Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.