DocsICP FilingConsole
官方文档
首页

GetEventStreaming

更新时间：
复制 MD 格式
产品详情
我的收藏

Retrieves the details of an event stream.

Operation description

Retrieves the details of 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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:GetEventStreaming

get

*EventStreaming

acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/{#EventStreamingName}

 None None

Request parameters

Parameter

Type

Required

Description

Example
EventStreamingName

string

Yes

The name of the event stream to query.

myeventstreaming

Response elements

Element

Type

Description

Example

object

The response parameters.

Message

string

The error message.

The event streaming [xxxx] not existed!
RequestId

string

The request ID generated by Alibaba Cloud for this request.

7892F480-58C9-5067-AB35-8A7BEF****
Data

object

The returned data.

EventStreamingName

string

The name of the event stream.

rocketmq-sync
Description

string

The description of the event stream.

RocketMQ-to-RocketMQ
Source

object

The event source.

SourceMNSParameters

object

The parameters of the Simple Message Queue (formerly MNS) event source.

RegionId

string

The region ID.

cn-hangzhou
QueueName

string

The name of the queue in Simple Message Queue (formerly MNS).

demo
IsBase64Decode

boolean

Indicates whether Base64 encoding is enabled.

true
SourceRabbitMQParameters

object

The RabbitMQ event source.

RegionId

string

The region ID.

cn-hangzhou
InstanceId

string

The ID of the RabbitMQ instance.

i-f8z9a9mcgwri1c1i****
VirtualHostName

string

The name of the vhost in the RabbitMQ instance.

eb-connect
QueueName

string

The name of the queue in the RabbitMQ instance.

comp
SourceRocketMQParameters

object

The RocketMQ event source.

RegionId

string

The region ID of the RocketMQ instance.

cn-hangzhou
InstanceId

string

The ID of the RocketMQ instance.

i-f8zbher64dlm58pl****
Topic

string

The message topic.

topic_add_anima
Tag

string

The message filtering tag.

v1
Offset

string

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 the offset at a specified point in time.

CONSUMEFROMLASTOFFSET
GroupID

string

The group ID of the RocketMQ instance.

GID_group1
Timestamp

integer

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

1636597951964
InstanceType

string

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

The instance endpoint.

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

AuthType

string

The authentication type.

ACL
InstanceUsername

string

The instance username.

xxxa
InstancePassword

string

The instance password.

xxxa
InstanceVpcId

string

The VPC information of the instance.

vpc-m5e3sv4b12345****

InstanceVSwitchIds

string

The vSwitch information of the instance.

vsw-m5ev8asdc6h12****

InstanceSecurityGroupId

string

The security group information of the instance.

sg-m5edtu24f12345****

InstanceNetwork

string

The network information of the instance:

  • PublicNetwork

  • PrivateNetwork

PublicNetwork
BodyDataType

string

The message encoding format:

  • Json

  • Text

  • Binary

Json
FilterType

string

The message filtering type.

Tag

FilterSql

string

The SQL filter statement.

index > 10
VpcId

string

The VPC ID.

vpc-m5e3sv4b12345****

VSwitchIds

string

The vSwitch ID.

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

The security group ID.

sg-m5edtu24f12345****

Network

string

The network type.

  • PublicNetwork

  • PrivateNetwork

PublicNetwork
SourceRocketMQCheckpointParameters

object

The RocketMQ checkpoint source.

RegionId

string

The region ID.

cn-hangzhou
InstanceType

string

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
InstanceId

string

The instance ID.

rmp-cn-jte3w******

Topics

array

The message topic.

string

The message topic.

opic_add_anima
SourceApacheRocketMQCheckpointParameters

object

The Apache RocketMQ checkpoint source.

RegionId

string

The region ID.

cn-hangzhou

InstanceId

string

The RocketMQ instance ID.

MQ_INST_164901546557****_BAAN****
Topics

array

The list of topics.

string

The list of topics to consume.

["Topic_1","Topic_2"]
InstanceEndpoint

string

The instance endpoint.

registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsername

string

The instance username.

admin
InstancePassword

string

The instance password.

123456
NetworkType

string

The network type.

PrivateNetwork
VpcId

string

The VPC ID.

vpc-adw1awdw*****
VSwitchId

string

The vSwitch ID.

vsw-dwaafds****
SecurityGroupId

string

The security group ID.

sg-mw43*****
SourceKafkaParameters

object

The Kafka event source.

RegionId

string

The region ID of the instance.

cn-hangzhou
InstanceId

string

The instance ID.

i-bp1fbtrnqmjvgq66****
Topic

string

The topic name.

topic_empower_1642473600414
ConsumerGroup

string

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

GID_TEST
OffsetReset

string

The offset.

latest
Network

string

The network configuration. The default value is Default. For a VPC, the value is PublicNetwork.

Default
VpcId

string

The VPC ID.

vpc-2zehizpoendb3****
VSwitchIds

string

The vSwitch ID.

vsw-wz9qqeovkwjxlu9uc****
SecurityGroupId

string

The security group ID.

sg-2vcgdxz7o1n9zapp****
ValueDataType

string

The encoding and decoding parameter. Valid values:

  1. JSON: The system decodes the bytes into a string based on UTF-8 and then parses the string as a JSON object.

  2. Text: The system decodes the bytes into a string based on UTF-8 and places the string in the payload.

  3. Binary: The system encodes the bytes into a Base64 string and places the string in the payload.

Text
SourceMQTTParameters

object

The MQTT event source.

RegionId

string

The region ID.

cn-shanghai
InstanceId

string

The instance ID.

i-2ze06wqdwk0uq14k****
Topic

string

The topic name.

TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
BodyDataType

string

The message encoding format:

  • JSON

  • Text

  • Binary

JSON
NetworkType

string

The network type.

VpcId

string

The VPC ID.

VSwitchIds

string

The vSwitch ID.

SecurityGroupId

string

The security group ID.

SourceDTSParameters

object

The DTS event source.

TaskId

string

The task ID.

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

string

The network address and port of the change tracking channel.

Topic

string

The subscribed topic of the change tracking channel.

TP_TEST_UNDERWRITE_ISSUE
Sid

string

The consumer group ID.

HD1
Username

string

The account of the consumer group.

admin
Password

string

The password of the consumer group account.

admin****
InitCheckPoint

string

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

1620962769
SourceSLSParameters

object

The Simple Log Service event source.

Project

string

The project in Simple Log Service.

dmmzk
LogStore

string

The Logstore in Simple Log Service.

waf-logstore
ConsumerGroup

string

The consumer group.

ConsumePosition

string

The start consumer offset. You can start consumption from the earliest offset (begin), the latest offset (end), or a specified point in time (in seconds).

begin
RoleName

string

The RAM role that is used to read log content from Simple Log Service. When you create this role in the RAM console, you must select Alibaba Cloud Service for Trusted Entity and EventBridge for Select Trusted Service.

testRole
SourcePrometheusParameters

object

The Prometheus event source.

RegionId

string

The region ID.

cn-hangzhou
ClusterId

string

The cluster ID.

c83555068b6******ad213f565f209

DataType

string

The data type.

Json
Labels

string

The labels.

__name__=.*

RoleName

string

The task role name.

test-role
ExternalLabels

string

The external labels attached to the event stream.

{"env":"test"}
SourceCustomizedKafkaParameters

object

The custom Kafka event source.

InstanceId

string

The ID of the Kafka instance.

r-8vb64581862c****

SourceCustomizedKafkaConnectorParameters

object

The custom Apache Kafka connector event source.

ConnectorPackageUrl

string

The download URL of the ZIP package from OSS.

"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

The connector parameters.

Name

string

The connector name.

test-name

Config

object

The connector configuration.

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

object

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" }
SourceApacheKafkaParameters

object

Bootstraps

string

Topic

string

ConsumerGroup

string

OffsetReset

string

ValueDataType

string

VpcId

string

VSwitchIds

string

SecurityGroupId

string

NetworkType

string

SecurityProtocol

string

SaslMechanism

string

SaslUser

string

SaslPassword

string

SslTruststoreCertificates

string

[Required for SSL scenarios] The trusted certificate for the Kafka server. This is used to verify the validity of the Kafka broker's SSL certificate and prevent man-in-the-middle attacks. Format requirement: A Base64-encoded PEM file. It usually contains the CA certificate of the Kafka server or the server certificate itself. Example: Base64-encode the content of the CA certificate's PEM file, ensuring it starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'. If Kafka uses a self-signed certificate, provide the CA certificate that issued it.

SslKeystoreCertificateChain

string

[Required for mutual authentication] The Kafka client certificate chain. This parameter is required when the Kafka server has mutual SSL authentication (ssl.client.auth=required) enabled. Format requirement: A Base64-encoded PEM file containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Note: Ensure that the content of each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'. Concatenate them before Base64 encoding.

SslKeyPassword

string

[Required for encrypted private keys] The password for the Kafka client's private key. This is required if the client's private key is password-protected (i.e., the PEM file contains 'Proc-Type: 4,ENCRYPTED' or an 'ENCRYPTED' tag). Leave this empty if the private key is not encrypted. Note: This password is only for decrypting the private key and is not related to Kafka authentication.

SslKeystoreKey

object

[Required for mutual authentication] The SSL private key configuration object. This is required when the Kafka server has mutual SSL authentication enabled. Only KMS mode is supported for the key. Use KmsArn to specify the KMS resource that stores the private key. The system retrieves the private key content from KMS only in memory, which enhances security. Example configuration: {"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"} "

KmsArn

string

[Required] The ARN of the KMS resource that stores the SSL private key. This is used to locate the KMS instance where the client private key is stored. Example format: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can find the ARN in the KMS console.

KmsSecretValueKey

string

[KMS KV mode] The key name in the KMS credential. If the credential stored in KMS is a key-value pair, specify this parameter to identify the key for the SSL private key. Example: If the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', set this parameter to 'ssl_keystore_key'. If the KMS credential is in plain text mode (storing the PEM content of the private key directly), leave this parameter empty.

SourceOSSParameters

object

The OSS event source.

RoleName

string

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

eventbridge_oss_role

BucketName

string

The name of the bucket in OSS.

bucket_abc

Prefix

string

The file path prefix.

fun/document/

LoadMode

string

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

single

LoadFormat

string

The document loader.

TextLoader

Delimiter

string

The separator. In chunk loading mode, this separator is used as the identifier for text chunks. The default separator is the line feed character ( ).

\n

SourceOpenSourceRabbitMQParameters

object

The open source RabbitMQ event source.

Endpoint

string

The endpoint of the open source RabbitMQ instance.

192.168.1.100:5672
VirtualHostName

string

The name of the vhost in the open source RabbitMQ instance.

eb-connect
QueueName

string

The name of the queue in the open source RabbitMQ instance.

demo
BodyDataType

string

The message encoding format:

  • JSON

  • Text

  • Binary

Json
Username

string

The username.

admin
Password

string

The password.

******
VpcId

string

The VPC ID.

vpc-bp1vllc1lnw1v657******
VSwitchIds

string

The vSwitch ID.

vsw-uf65zhil5oukof5******
SecurityGroupId

string

The security group ID.

sg-2ze65razphjfz3******
NetworkType

string

The network type:

  • PublicNetwork: public network

  • PrivateNetwork: VPC

PrivateNetwork

AuthType

string

The authentication type.

ACL
SourceEventBusParameters

object

The event bus source.

EventBusName

string

The name of the event bus.

demo
EventRuleName

string

The name of the event rule.

test
SourceMySQLParameters SourceMySQLParameters

The MySQL event source.

SourcePostgreSQLParameters SourcePostgreSQLParameters

SourceRabbitMQMetaParameters SourceRabbitMQMetaParameters

SourceRabbitMQMsgSyncParameters SourceRabbitMQMsgSyncParameters

SourceFeiShuDocsParameters SourceFeiShuDocsParameters

Metadata

string

FilterPattern

string

The event filtering rule. If not specified, all events are matched.

Transforms

array<object>

The event transformer configuration.

object

The Alibaba Cloud Resource Name (ARN) of the cloud service, such as the ARN of a function in Function Compute.

Arn

string

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

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

DashScopeTransformParameters

DashScopeTransformParameters

BaiLianAgentTransformParameters

BaiLianAgentTransformParameters

Sink

object

The event target.

SinkMNSParameters

object

The Simple Message Queue (formerly MNS) event target.

QueueName

object

The target service is Simple Message Queue (formerly MNS).

Value

string

The name of the queue in Simple Message Queue (formerly MNS).

MyQueue
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

Body

object

The message body.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

Indicates whether Base64 encoding is enabled.

Value

string

Enable Base64 encoding.

true
Form

string

The format of the event transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

SinkRabbitMQParameters

object

The parameters of the RabbitMQ sink.

InstanceId

object

The target service is RabbitMQ.

Value

string

The ID of the RabbitMQ instance.

e5c9b727-e06c-4d7e-84d5-f8ce644e****
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

VirtualHostName

object

The name of the vhost in the RabbitMQ instance.

Value

string

The name of the vhost in the RabbitMQ instance.

rabbit-host

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

TargetType

object

The target type.

Value

string

The target type. Valid values:

  • Exchange: Exchange mode.

  • Queue: Queue mode.

Exchange/Queue
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Exchange

object

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

Value

string

The name of the exchange in the RabbitMQ instance.

a_exchange
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

RoutingKey

object

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

Value

string

The message routing rule.

housekeeping
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

QueueName

object

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

Value

string

The name of the queue in the instance.

MyQueue
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Body

object

The message body.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

The message ID.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

The filtering properties.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

SinkFcParameters

object

The function target.

ServiceName

object

The service name.

Value

string

The service name.

myService
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

FunctionName

object

The function name.

Value

string

The function name.

mFunction
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Concurrency

object

The delivery concurrency. The minimum value is 1.

Value

string

The delivery concurrency. The minimum value is 1.

1
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Qualifier

object

The service edition.

Value

string

The service edition.

LATEST
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

InvocationType

object

Sync or async.

  • Sync: sync.

  • Async: asynchronous.

Value

string

Sync or async.

  • Sync: sync.

  • Async: asynchronous.

Async
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Body

object

The body of the content sent to the function.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform:

  • ORIGINAL: complete event

  • JSONPATH: partial event

  • CONSTANT: static field

  • TEMPLATE: template

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

TEMPLATE
Template

string

The template style.

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

DataFormat

object

The format conversion rule for the event content.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform:

  • ORIGINAL: complete event

  • JSONPATH: partial event

  • CONSTANT: static field

  • TEMPLATE: template

JSONPATH
Template

string

The template style.

$.data.key
SinkKafkaParameters

object

The Kafka sink parameters.

InstanceId

object

The target service is Kafka.

Value

string

The instance ID.

Defaut_1283278472_s****
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

DynamicTopic

object

The policy for routing messages to the target topic. If both the `topic` and `DynamicTopic` parameters are specified, the value of the `DynamicTopic` parameter takes precedence. The following two configuration modes are supported: 1. Static constant mode: Enter a fixed topic name string (for example, "order_created"). All messages are sent to this topic. 2. Dynamic extraction mode: Enter a standard JSONPath expression (for example, "$.user.id" or "$.metadata.category"). The system parses the upstream message body and extracts the value of the matching field as the target topic name.

Value

string

The value.

Form

string

The type of transform. CONSTANT: static field JSONPATH: extract from the upstream based on the path

Template

string

The template.

Topic

object

The topic name.

Value

string

The topic name.

test
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

CompressionType

string

Acks

object

The Kafka write acknowledgment mode:

  • acks=0: No response from the server is required. Performance is high, but the risk of data loss is high.

  • acks=1: The server returns a response after the primary node successfully writes the data. Performance is moderate, and the risk of data loss is moderate. Data may be lost if the primary node goes down.

  • acks=all: The server returns a response only after the primary node successfully writes the data and the secondary nodes have synced it. Performance is low, but data is more secure. Data is lost only if both the primary and secondary nodes go down.

Value

string

The Kafka write acknowledgment mode:

  • acks=0: No response from the server is required. Performance is high, but the risk of data loss is high.

  • acks=1: The server returns a response after the primary node successfully writes the data. Performance is moderate, and the risk of data loss is moderate. Data may be lost if the primary node goes down.

  • acks=all: The server returns a response only after the primary node successfully writes the data and the secondary nodes have synced it. Performance is low, but data is more secure. Data is lost only if both the primary and secondary nodes go down.

1
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Key

object

The message key.

Value

string

The message key.

key
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Headers

object

The additional metadata of the Kafka message.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The format of the transform:

  • ORIGINAL: complete event

  • JSONPATH: partial event

  • CONSTANT: static field

  • TEMPLATE: template

CONSTANT
Template

string

The template style.

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

Value

object

The message body.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

SinkApacheKafkaParameters

object

Description

Bootstraps

string

Topic

string

DynamicTopic

object

The policy for routing messages to the target topic. If both the `topic` and `DynamicTopic` parameters are specified, the value of the `DynamicTopic` parameter takes precedence. The following two configuration modes are supported: 1. Static constant mode: Enter a fixed topic name string (for example, "order_created"). All messages are sent to this topic. 2. Dynamic extraction mode: Enter a standard JSONPath expression (for example, "$.user.id" or "$.metadata.category"). The system parses the upstream message body and extracts the value of the matching field as the target topic name.

Value

string

The value.

Form

string

The type of transform. CONSTANT: static field JSONPATH: extract from the upstream based on the path

Template

string

The template.

Acks

string

CompressionType

string

Key

object

Value

string

Form

string

Template

string

Headers

object

Value

string

Form

string

Template

string

Value

object

Value

string

Form

string

Template

string

SecurityProtocol

string

SaslMechanism

string

SaslUser

string

VpcId

object

Value

string

Form

string

Template

string

VSwitchIds

object

Value

string

Form

string

Template

string

SecurityGroupId

object

Value

string

Form

string

Template

string

NetworkType

object

Value

string

Form

string

Template

string

SaslPassword

string

SslTruststoreCertificates

string

[Required for SSL scenarios] The trusted certificate for the Kafka server. This is used to verify the validity of the Kafka broker's SSL certificate and prevent man-in-the-middle attacks. Format requirement: A Base64-encoded PEM file. It usually contains the CA certificate of the Kafka server or the server certificate itself. Example: Base64-encode the content of the CA certificate's PEM file, ensuring it starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'. If Kafka uses a self-signed certificate, provide the CA certificate that issued it.

SslKeystoreCertificateChain

string

[Required for mutual authentication] The Kafka client certificate chain. This parameter is required when the Kafka server has mutual SSL authentication (ssl.client.auth=required) enabled. Format requirement: A Base64-encoded PEM file containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Note: Ensure that the content of each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'. Concatenate them before Base64 encoding.

SslKeyPassword

string

[Required for encrypted private keys] The password for the Kafka client's private key. This is required if the client's private key is password-protected (i.e., the PEM file contains 'Proc-Type: 4,ENCRYPTED' or an 'ENCRYPTED' tag). Leave this empty if the private key is not encrypted. Note: This password is only for decrypting the private key and is not related to Kafka authentication.

SslKeystoreKey

object

[Required for mutual authentication] The SSL private key configuration object. This is required when the Kafka server has mutual SSL authentication enabled. Only KMS mode is supported for the key. Use KmsArn to specify the KMS resource that stores the private key. The system retrieves the private key content from KMS only in memory, which enhances security. Example configuration: {"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"} "

KmsArn

string

[Required] The ARN of the KMS resource that stores the SSL private key. This is used to locate the KMS instance where the client private key is stored. Example format: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can find the ARN in the KMS console.

KmsSecretValueKey

string

[KMS KV mode] The key name in the KMS credential. If the credential stored in KMS is a key-value pair, specify this parameter to identify the key for the SSL private key. Example: If the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', set this parameter to 'ssl_keystore_key'. If the KMS credential is in plain text mode (storing the PEM content of the private key directly), leave this parameter empty.

SinkRocketMQParameters

object

Sink RocketMQ Parameters

InstanceId

object

The target service is RocketMQ.

Value

string

The ID of the RocketMQ instance.

MQ_INST_164901546557****_BAAN****
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Topic

object

The topic of the RocketMQ instance.

Value

string

The name of the topic in the RocketMQ instance.

Mytopic
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

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

Body

object

The message body.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

Properties

object

The filtering properties.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

Keys

object

The filtering properties.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

The filtering properties.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

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

Value

string

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

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

None

InstanceEndpoint

object

The instance endpoint.

Value

string

The instance endpoint.

vbr-8vbsvkkbpf3vb0zef****

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

InstanceUsername

object

The instance username.

Value

string

The instance username.

admin

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

InstancePassword

object

The instance password.

Value

string

The instance password.

admin****

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

VpcId

object

The VPC ID.

Value

string

The VPC ID.

vbr-8vb835n3zf9shwlvb****

Form

string

The format of the event transform. The default value is CONSTANT.

CONSTANT

Template

string

None

VSwitchIds

object

The vSwitch ID.

Value

string

The vSwitch ID.

vbr-8vb835n3zf9shwl****mp

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

SecurityGroupId

object

The security group ID.

Value

string

The security group ID.

b4bf375515f6440f942e3a20c33d****

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

Network

object

The network type.

  • PublicNetwork

  • PrivateNetwork

Value

string

The network type.

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

DeliveryOrderType

object

The delivery order type of the message. This parameter is optional. The default value is concurrent delivery.

Value

string

The delivery order type.

  • Orderly: sequential delivery

  • Concurrently: concurrent delivery

Concurrently
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

ShardingKey

object

The sharding key of the message.

Note

  • If DeliveryOrderType is set to Orderly, ShardingKey is required.

  • If the source is RocketMQ, ShardingKey can be empty. In this case, the upstream BrokerName and QueueId are concatenated to form the message's sharding key.

Value

string

The sharding key value.

order_id
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

SinkDorisParameters

object

QueryEndpoint

object

Value

string

Form

string

Template

string

FeHttpEndpoint

object

Value

string

Form

string

Template

string

BeHttpEndpoint

object

Value

string

Form

string

Template

string

UserName

object

Value

string

Form

string

Template

string

Password

object

Value

string

Form

string

Template

string

Database

object

Value

string

Form

string

Template

string

Table

object

Value

string

Form

string

Template

string

Body

object

Value

string

Form

string

Template

string

NetworkType

object

Value

string

Form

string

Template

string

VpcId

object

Value

string

Form

string

Template

string

VSwitchIds

object

Value

string

Form

string

Template

string

SecurityGroupId

object

Value

string

Form

string

Template

string

SinkRocketMQCheckpointParameters

object

Sink RocketMQ Checkpoint Parameters

InstanceType

string

The instance type. Valid values:

  • Cloud_4: Alibaba Cloud RocketMQ 4.0 instance

  • Cloud_5: Alibaba Cloud RocketMQ 5.0 instance

Cloud_4
InstanceId

string

The instance ID.

MQ_INST_164901546557****_BAAN****
Topic

object

The topic of the RocketMQ instance.

Value

string

The name of the topic in the RocketMQ instance.

Mytopic
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

Group

object

The group ID of the consumer group.

Value

string

Group ID

GID_EVENTBRIDGE_1736234******
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

ConsumeTimestamp

object

The timestamp of message consumption.

Value

string

The timestamp.

1570761026400
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

SinkApacheRocketMQCheckpointParameters

object

Sink Apache RocketMQ Checkpoint Parameters

Topic

object

The topic of the RocketMQ instance.

Value

string

The name of the topic in the RabbitMQ instance.

Mytopic
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

Group

object

The group ID of the consumer group.

Value

string

Group ID

GID_EVENTBRIDGE_1736234******

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

ConsumeTimestamp

object

The timestamp of message consumption.

Value

string

The timestamp.

1570761026400
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

InstanceEndpoint

string

The instance endpoint.

192.168.1.1:9876
InstanceUsername

string

The username required for authentication.

admin
InstancePassword

string

The password for the username.

****
NetworkType

string

The network type.

PrivateNetwork
VpcId

string

The ID of the VPC.

vpc-2zeccak5pb0j3ay******
VSwitchId

string

The vSwitch ID.

vsw-uf62oqt1twuevrt******
SecurityGroupId

string

The security group ID.

sg-2ze5bmpw6adn0q******
SinkSLSParameters

object

Sink SLS Parameters

Project

object

The project in Simple Log Service.

Value

string

The project in Simple Log Service.

test-project

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

LogStore

object

The Logstore in Simple Log Service.

Value

string

The Logstore in Simple Log Service.

test-logstore
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

Topic

object

The topic where the log is located, corresponding to the SLS reserved field "topic".

Value

string

The topic where the log is located, corresponding to the SLS reserved field "topic".

testTopic
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

Body

object

The content sent to SLS.

Value

string

The value before the transform.

{ "key": "value" }
Form

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

RoleName

object

The RAM role that is used to read log content from Simple Log Service. When you create this role in the RAM console, you must select Alibaba Cloud Service for Trusted Entity and EventBridge for Select Trusted Service.

Value

string

The RAM role that is used to read log content from Simple Log Service. When you create this role in the RAM console, you must select Alibaba Cloud Service for Trusted Entity and EventBridge for Select Trusted Service.

testRole
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

ContentType

object

The SLS data format. You can use the default or configure a custom key-value pair.

  • JSON

  • KeyValue

Value

string

The value before the transform.

JSON

Form

string

The format of the transform.

CONSTANT

Template

string

The template style.

ContentSchema

object

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

Value

string

The value before the transform.

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

string

The template style.

CONSTANT

Template

string

The template style.

SinkFnfParameters

object

The Fnf sink parameters.

FlowName

object

The flow name.

Value

string

The flow name.

test-streaming-fnf
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

ExecutionName

object

The execution name.

Value

string

The execution name.

123
Form

string

The format of the transform. The default value is CONSTANT:

  • JSONPATH: partial event.

  • CONSTANT: static field.

  • TEMPLATE: template.

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

CONSTANT
Template

string

The template style.

Input

object

The execution input information.

Value

string

The execution input information.

123
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

RoleName

object

The role configuration.

Value

string

The role configuration.

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

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

The template style.

SinkDataHubParameters

object

The DataHub sink parameters.

Project

object

The DataHub project name.

Value

string

The DataHub project name.

demo-project

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT

Template

string

None

Topic

object

The DataHub topic name.

Value

string

The DataHub topic name.

demo-topic

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

None

TopicType

object

The type of the topic. Valid values are:

  • TUPLE

  • BLOB

Value

string

The topic type.

  • TUPLE

  • BLOB

TUPLE

Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

None

TopicSchema

object

For TUPLE type, the topic content model.

Value

string

For TUPLE type, the topic content model.

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

string

The format of the transform.

TEMPLATE
Template

string

The template style.

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

object

For BLOB type, the record content template.

Value

string

For BLOB type, the record content template.

Form

string

The format of the transform.

ORIGINAL
Template

string

None

RoleName

object

The task role name.

Value

string

The task role name.

test-role
Form

string

The format of the transform. The default value is CONSTANT.

CONSTANT
Template

string

None

SinkCustomizedKafkaParameters

object

The Kafka sink parameters.

InstanceId

string

The ID of the Kafka instance.

90be1f96-4229-4535-bb76-34b4f6fb****
SinkCustomizedKafkaConnectorParameters

object

The Kafka connector sink parameters.

ConnectorPackageUrl

string

The download URL of the file from OSS.

"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=rb8q3OpV******"
ConnectorParameters

object

Parses the properties file in the current ZIP package.

Name

string

The connector name.

mongo-sink
Config

object

The connector configuration.

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

object

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

The DashVector sink parameters.

InstanceId

string

The instance ID.

vrs-cn-lbj3ru1***
Collection

string

The collection name.

collection1
ApiKey

string

The API key created in the DashVector console.

Q34nExQH7sQ****
Operation

string

The DashVector database operation type.

Upsert
Network

string

The network type.

PublicNetwork
PrimaryKeyId

object

The primary key ID for inserting/deleting records. If not specified, a random primary key ID is used.

Form

string

The format of the transform.

JSONPATH
Value

string

  • If Form is JSONPATH: JSONPath extracted content.

  • If Form is TEMPLATE: template variable.

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

$.data.requestId
Template

string

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

${ID}
Partition

object

The partition. The default value is the default partition.

Form

string

The format of the transform.

CONSTANT
Value

string

  • If Form is CONSTANT: a constant value.

  • If Form is JSONPATH: JSONPath extracted content.

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

default
Template

string

None

Vector

object

The vector of the record to be inserted into DashVector.

Form

string

The format of the transform.

JSONPATH
Value

string

JSONPath extracted content.

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

$.data.messageBody
Template

string

None

DashVectorSchemaParameters

array<object>

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

array<object>

Name

object

Form

string

Value

string

Template

string

Type

object

Form

string

Value

string

Template

string

Value

object

Form

string

Value

string

Template

string

SinkOpenSourceRabbitMQParameters

object

Sink Open Source RabbitMQ Parameters

Endpoint

string

The endpoint.

192.168.1.1:9876
VirtualHostName

string

The name of the virtual host in RabbitMQ.

vhost1
TargetType

string

The target type for message delivery. This is valid only when TargetType is set to Exchange.

Exchange
Exchange

string

The name of the exchange in RabbitMQ.

my-exchange
QueueName

string

The name of the queue in RabbitMQ. This is valid only when TargetType is set to Queue.

my-queue
Username

string

The username to access the RabbitMQ instance.

admin
Password

string

The password to access the RabbitMQ instance.

****
VpcId

string

The VPC ID.

vpc-uf6of9452b2pba82c ****
VSwitchIds

string

The vSwitch ID.

vsw-uf6of9452b2pba82c ****
SecurityGroupId

string

The security group ID.

sg-uf6of9452b2pba82c ****
NetworkType

string

The network type.

PublicNetwork

AuthType

string

The authentication type.

ACL
RoutingKey

object

The message routing key.

Form

string

The transform format. The default is CONSTANT.

CONSTANT
Value

string

The routing key value.

{"Form": "CONSTANT", "Value": "my-routing-key"}

Template

string

The template style.

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

object

The message body content.

Form

string

The transform format. The default is CONSTANT.

CONSTANT
Value

string

The raw data value.

{"key": "value"}
Template

string

The template style.

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

object

The unique identifier of the message.

Form

string

The transform format. The default is CONSTANT.

CONSTANT
Value

string

The message ID value.

12345
Template

string

The template style.

Properties

object

Additional properties of the message.

Form

string

The transform format. The default is CONSTANT.

CONSTANT
Value

string

The property content.

{"env": "prod"}
Template

string

The template style.

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

SinkBaiLianParameters SinkBaiLianParameters

Sink BaiLian Parameters

SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

SinkHttpsParameters

SinkHttpsParameters

HTTPS target parameters

SinkApiDestinationParameters SinkApiDestinationParameters

API destination target parameters

SinkOSSParameters SinkOSSParameters

SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

SinkMQTTParameters SinkMQTTParameters

SinkAgentRunParameters SinkAgentRunParameters

RunOptions

object

运行环境参数。

MaximumTasks

integer

The concurrency.

2
RetryStrategy

object

The retry policy for failed event pushes.

PushRetryStrategy

string

The retry policy: BACKOFF_RETRY (backoff retry) and EXPONENTIALDECAY_RETRY (exponential decay retry).

BACKOFF_RETRY
MaximumEventAgeInSeconds

number

The maximum retry time.

512
MaximumRetryAttempts

number

The maximum number of retries.

2
ErrorsTolerance

string

The error tolerance policy: NONE (no tolerance for errors) and ALL (tolerance for all errors).

ALL
DeadLetterQueue

object

Indicates whether to enable the dead-letter queue. By default, the dead-letter queue is disabled, and messages that exceed the retry policy are discarded.

Arn

string

The ARN of the dead-letter queue.

acs:ram::155020394332****:role/edskmstoecs
Network

string

The network type of the dead-letter queue.

PrivateNetwork
VpcId

string

The VPC ID where the dead-letter queue is located.

vpc-2zehizpoendb3****
VSwitchIds

string

The vSwitch ID where the dead-letter queue is located.

vsw-m5ev8asdc6h12345****
SecurityGroupId

string

The security group ID of the instance where the dead-letter queue is located.

sg-2vcgdxz7o1n9zapp****
BatchWindow

object

The batch window.

CountBasedWindow

integer

The maximum number of events that a window can hold. When this threshold is reached, the data in the window is pushed downstream. If there are multiple windows, the trigger occurs when any one of them is met.

100
TimeBasedWindow

integer

The maximum time range of events that a window can hold (in seconds). When this threshold is reached, the data in the window is pushed downstream. If there are multiple windows, the trigger occurs when any one of them is met.

10
BusinessOption

object

BusinessMode

string

MinCapacityUnitCount

integer

MaxCapacityUnitCount

integer

Throttling

integer

Status

string

获取到的事件流的状态。

RUNNING
DetailedStatus

object

详细状态。

TPS

number

The number of transactions processed per second.

5
DelayTime

integer

The delay time.

3
DiffOffset

integer

The offset difference.

0
Extensions

object

The extended properties.

{ "test": "test", "test2": 1 }
Code

string

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

Success
Success

boolean

操作成功返回 true。

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.