DocsICP FilingConsole
官方文档
首页

CreateEventStreaming

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

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

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:CreateEventStreaming

create

*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.

myeventstreaming
Description

string

No

The description of the event stream.

rocketmq2mns
FilterPattern

string

Yes

The event filtering rule. If not specified, 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 provider. You must specify exactly one Source type.

SourceMNSParameters

object

No

The Source MNS parameters.

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 decoding. Default value: true.

true
SourceRabbitMQParameters

object

No

The Source RabbitMQ parameters.

RegionId

string

No

The region ID.

cn-hangzhou
InstanceId

string

No

The instance 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 Source Kafka parameters.

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 group ID of the consumer that subscribes to the topic.

DEFAULT_GROUP
OffsetReset

string

No

The offset.

latest
Network

string

No

The network configuration. Default value: Default. For VPC networks, use PublicNetwork.

Default
VpcId

string

No

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 and decoding format of the message body. Valid values:

  • JSON

  • Text

  • Binary.

JSON
SourceRocketMQParameters

object

No

The Source RocketMQ parameters.

RegionId

string

No

The region ID.

cn-qingdao
InstanceId

string

No

The region where the ApsaraMQ for RocketMQ instance resides.

default_C56C36026****
Topic

string

No

The topic of the message service.

Topic_publicRule_api_1667273421288
Tag

string

No

The filter tag of the message.

test
Offset

string

No

The consumption offset of the message. Valid values:

  • CONSUME_FROM_LAST_OFFSET: consumption starts from the latest offset.

  • CONSUME_FROM_FIRST_OFFSET: consumption starts from the earliest offset.

  • CONSUME_FROM_TIMESTAMP: consumption starts from the offset at a specified point in time.

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 the Offset parameter is set to CONSUME_FROM_TIMESTAMP.

1670656652009
InstanceType

string

No

The instance type. Valid values:

  • Cloud_4: ApsaraMQ for RocketMQ 4.0 instance (default)

  • Cloud_5: ApsaraMQ for 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. Valid values:

  • PublicNetwork

  • PrivateNetwork.

Valid values:

  • PrivateNetwork :

    PrivateNetwork

  • PublicNetwork :

    PublicNetwork

PrivateNetwork
FilterType

string

No

The message filter 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 IDs 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 instance network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PublicNetwork
BodyDataType

string

No

The message encoding format. Valid values:

  • JSON

  • Text

  • Binary.

JSON
SourceRocketMQCheckpointParameters

object

No

The Source RocketMQ Checkpoint parameters.

RegionId

string

No

The region ID.

InstanceType

string

No

The instance type.

InstanceId

string

No

The instance ID.

Topics

array

No

The message topic.

string

No

The message topic.

SourceApacheRocketMQCheckpointParameters

object

No

The Source RocketMQ Checkpoint parameters.

RegionId

string

No

The region ID.

Topics

array

No

The message topic.

string

No

The message topic.

InstanceEndpoint

string

No

The instance endpoint.

InstanceUsername

string

No

The instance username.

InstancePassword

string

No

The instance password.

NetworkType

string

No

The network type.

VpcId

string

No

VPC ID。

VSwitchId

string

No

The vSwitch ID.

SecurityGroupId

string

No

The security group ID.

SourceMQTTParameters

object

No

The Source MQTT parameters.

RegionId

string

No

The region ID.

cn-shenzhen
InstanceId

string

No

The instance ID.

r-bp1b5ncun5lqer****
Topic

string

No

The topic of the message.

CANAL_VICUTU_UAT
BodyDataType

string

No

The message encoding format. Valid values:

  • JSON

  • Text

  • Binary.

JSON
NetworkType

string

No

VpcId

string

No

VSwitchIds

string

No

SecurityGroupId

string

No

SourceDTSParameters

object

No

The Source DTS parameters.

TaskId

string

No

The task ID.

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

string

No

The network address and port number of the data subscription channel.

Topic

string

No

The subscription topic of the data subscription 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 consumption offset, which is the timestamp when the SDK client consumes the first data record. The value is a UNIX timestamp.

1620962769
SourceSLSParameters

object

No

The Source SLS parameters.

Project

string

No

The Simple Log Service project.

test
LogStore

string

No

The Simple Log Service Logstore.

sas-log
ConsumePosition

string

No

The starting consumption offset. You can select the earliest or latest offset, which corresponds to "begin" or "end" respectively. You can also start consumption from a specified time in seconds.

end
RoleName

string

No

The role that grants authorization to the event bus EventBridge to read SLS log content. When you create the role in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "EventBridge".

testRole
SourcePrometheusParameters

object

No

The Source 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 instance ID of the ApsaraMQ for Kafka instance.

r-8vb64581862c****

SourceCustomizedKafkaConnectorParameters

object

No

The custom connector Apache Kafka 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

开源 Kafka 参数配置

Bootstraps

string

No

The bootstrap server address.

Topic

string

No

The topic name.

ConsumerGroup

string

No

The consumer group name.

OffsetReset

string

No

The consumption offset. latest: the system reads data from the latest offset. earliest: the system reads data from the earliest offset. This configuration is supported only for the initial initialization of an unused 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 of the Kafka source.

SecurityGroupId

string

No

The security group ID of the Kafka source.

NetworkType

string

No

The Kafka network type.

SecurityProtocol

string

No

The Kafka security protocol type. Valid values: SASL_SSL PLAINTEXT SASL_PLAINTEXT.

SaslMechanism

string

No

The Kafka SASL authentication mechanism.

SaslUser

string

No

The Kafka SASL authentication username.

SaslPassword

string

No

The Kafka SASL authentication password.

SslKeystoreCertificateChain

string

No

Required for mutual TLS authentication. The Kafka client certificate chain. This parameter is required when the Kafka server enables mutual SSL authentication (ssl.client.auth=required). Format: Base64-encoded PEM format, containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Ensure that each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', and then Base64-encode the concatenated content.

SslKeyPassword

string

No

Required for encrypted private keys. The Kafka client private key password. This parameter is required when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is unrelated to Kafka authentication.

SslTruststoreCertificates

string

No

Required for SSL scenarios. The Kafka server trust certificate. Used to authenticate the SSL certificate of the Kafka broker and prevent man-in-the-middle attacks. Format: Base64-encoded PEM format, typically containing the CA certificate or the server certificate of the Kafka server. Example: Base64-encode the PEM file content of the CA certificate (ensure it starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued the certificate.

SslKeystoreKey

object

No

【双向认证必填】SSL 私钥配置对象。当 Kafka 服务端开启双向 SSL 认证时，需提供客户端私钥。密钥仅支持 KMS 模式：通过 KmsArn 指定存储私钥的密钥管理服务资源，系统只在内存态从 KMS 获取私钥内容，安全性更高；配置示例：{"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}\n"

KmsArn

string

No

[Required] The ARN of the KMS resource storing the SSL private key. This is used to locate the KMS instance where the client's private key is stored. Example format: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. To obtain this, view the ARN information for the corresponding key in the KMS console.

KmsSecretValueKey

string

No

[KMS KV mode] The key name in the KMS credential. When the KMS credential is a key-value (KV) structure, fill in this parameter to specify the key corresponding to the SSL private key. Example: If the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', then fill in 'ssl_keystore_key'. If the KMS credential is in plain text mode (directly storing the PEM content of the private key), leave this parameter blank.

SourceOSSParameters

object

No

The Source OSS event source.

RoleName

string

No

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

eventbridge_oss_role
BucketName

string

No

The name of the OSS bucket.

bucket_abc
Prefix

string

No

The file path prefix.

fun/document/
LoadMode

string

No

The data loading mode. single indicates single-document loading, and element indicates chunked loading. 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 delimiter. In chunked loading mode, this delimiter is used as the text chunking identifier. The default delimiter is the newline character \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

SourceFeiShuDocsParameters SourceFeiShuDocsParameters

No

Sink

object

No

RunOptions

object

No

The event target. You must specify exactly one Sink type.

SinkMNSParameters

object

No

The MNS event target.

QueueName

object

No

The target service type is Message Service MNS.

Value

string

No

消息服务 MNS 的 Queue 的名称。

MyQueue
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

Body

object

No

The message content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

TEMPLATE
Template

string

No

模板样式。

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

object

No

Specifies whether to enable Base64 encoding.

Value

string

No

开启 Base64 编码。

true
Form

string

No

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

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

SinkEventHouseParameters

object

No

The event target name.

CatalogName

string

No

The catalog name.

demo
NamespaceName

string

No

The namespace of the destination table.

name1
EventTableName

string

No

The name of the destination table.

demo-table
MappingRules

array<object>

No

The field mapping rules.

array<object>

No

The field mapping rules.

ColumnValue

object

No

列值的提取规则

Value

string

No

提取路径，如$.data.value.name

$.data.value
Form

string

No

转换的方式，如 JSONPATH

JSONPATH
Template

string

No

模板配置

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

string

No

列名称

age
ColumnType

string

No

列的类型

text
SinkRabbitMQParameters

object

No

The Sink RabbitMQ parameters.

InstanceId

object

No

The target service type is ApsaraMQ for RabbitMQ.

Value

string

No

消息队列 RabbitMQ 版的实例 ID。

a5ff91ad4f3f24947887fe184fc2****
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

VirtualHostName

object

No

The vhost name of the ApsaraMQ for RabbitMQ instance.

Value

string

No

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

rabbit-host
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

TargetType

object

No

The target type.

Value

string

No

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

  • Exchange：Exchange 模式。

  • Queue：Queue 模式。

Exchange/Queue
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Exchange

object

No

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

Value

string

No

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

a_exchange
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

RoutingKey

object

No

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

Value

string

No

消息的路由规则。

housekeeping
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

QueueName

object

No

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

Value

string

No

实例的 Queue 的名称。

MyQueue
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Body

object

No

The message content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The message ID.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The filter properties.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The Sink Kafka parameters.

InstanceId

object

No

The target service type is ApsaraMQ for Kafka.

Value

string

No

实例 ID。

Defaut_1283278472_s****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Topic

object

No

The topic name.

Value

string

No

主题的名称。

test
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

DynamicTopic

object

No

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

Value

string

No

值

Form

string

No

转换的类型 CONSTANT：固定值 JSONPATH：根据路径从上游提取

Template

string

No

模板

Acks

object

No

The write acknowledgment mode for Kafka. Valid values:

  • acks=0: no response is required from the server. Higher performance but higher risk of data loss.

  • acks=1: a response is returned after the primary node writes successfully. Moderate performance and moderate risk of data loss. Data may be lost if the primary node goes down.

  • acks=all: a response is returned after the primary node writes successfully and the secondary nodes complete synchronization. Lower performance but higher data safety. Data is lost only if both the primary and secondary nodes go down.

Value

string

No

写入 Kafka 确认模式：

  • acks=0：无需服务端的 Response、性能较高、丢数据风险较大。

  • acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失；

  • acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。

1
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Key

object

No

The message key.

Value

string

No

消息键。

key
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Value

object

No

The message body.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

Headers

object

No

Value

string

No

Form

string

No

Template

string

No

CompressionType

string

No

SinkApacheKafkaParameters

object

No

The description.

Bootstraps

string

No

The initial connection address of the Kafka cluster.

DynamicTopic

object

No

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

Value

string

No

值

Form

string

No

转换的类型 CONSTANT：固定值 JSONPATH：根据路径从上游提取

Template

string

No

模板

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

SslKeystoreCertificateChain

string

No

Required for mutual TLS authentication. The Kafka client certificate chain. This parameter is required when the Kafka server enables mutual SSL authentication (ssl.client.auth=required). Format: Base64-encoded PEM format, containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Ensure that each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', and then Base64-encode the concatenated content.

SslKeyPassword

string

No

Required for encrypted private keys. The Kafka client private key password. This parameter is required when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is unrelated to Kafka authentication.

SslTruststoreCertificates

string

No

Required for SSL scenarios. The Kafka server trust certificate. Used to authenticate the SSL certificate of the Kafka broker and prevent man-in-the-middle attacks. Format: Base64-encoded PEM format, typically containing the CA certificate or the server certificate of the Kafka server. Example: Base64-encode the PEM file content of the CA certificate (ensure it starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued the certificate.

SslKeystoreKey

object

No

Required for mutual TLS authentication. The SSL private key configuration object. When the Kafka server enables mutual SSL authentication, provide the client private key. Only KMS mode is supported: specify the Key Management Service resource that stores the private key through KmsArn. The system retrieves the private key content from KMS only in memory, providing higher security. Configuration example: {"KmsArn": "acs:kms:ap-southeast-1:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}.

KmsArn

string

No

【必填】存储 SSL 私钥的 KMS 资源 ARN。用于定位存放客户端私钥的密钥管理服务实例。格式示例： 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'。获取方式：在 KMS 控制台查看对应密钥的 ARN 信息。

KmsSecretValueKey

string

No

【kms KV 模式】KMS 凭据中的密钥键名。当 KMS 存储的凭据为键值对（KV）结构时，填写此参数以指定 SSL 私钥对应的 key。示例：若 KMS 凭据为 '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}'，则填写 'ssl_keystore_key'。若 KMS 凭据为纯文本模式（直接存储私钥的 PEM 内容），则留空此参数

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

服务名。

myService
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

FunctionName

object

No

The function name.

Value

string

No

函数名。

myFunction
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

Concurrency

object

No

The delivery concurrency. Minimum value: 1.

Value

string

No

投递并发度，最小 1。

1
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

Qualifier

object

No

The service version.

Value

string

No

服务版本。

LATEST
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

InvocationType

object

No

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

Value

string

No

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

Valid values:

  • Async :

    Async

  • Sync :

    Sync

Async
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

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

Body

object

No

The content body sent to the function.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

详细参考：https://help.aliyun.com/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • ORIGINAL :

    ORIGINAL

  • TEMPLATE :

    TEMPLATE

TEMPLATE
Template

string

No

模板样式。

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

DataFormat

object

No

Value

string

No

Form

string

No

Template

string

No

SinkRocketMQParameters

object

No

Sink RocketMQ Parameters

InstanceId

object

No

The target service type is ApsaraMQ for RocketMQ.

Value

string

No

消息队列 RocketMQ 版的实例 ID。

MQ_INST_164901546557****_BAAN****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Topic

object

No

The topic of the ApsaraMQ for RocketMQ instance.

Value

string

No

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

Mytopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

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

Body

object

No

The message content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The filter properties.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The filter properties.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The filter properties.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The instance type.

Value

string

No

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项）

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

  • SelfBuilt：自建 Apache RocketMQ 集群

Cloud_4
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

InstanceEndpoint

object

No

The instance endpoint.

Value

string

No

实例接入点。

vbr-8vbsvkkbpf3vb0zef****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

InstanceUsername

object

No

The instance username.

Value

string

No

实例用户名。

admin

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

InstancePassword

object

No

The instance password.

Value

string

No

实例密码。

admin
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

VpcId

object

No

The VPC ID.

Value

string

No

VPC 的 ID。

vbr-8vb835n3zf9shwlvb****
Form

string

No

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

CONSTANT
Template

string

No

无

VSwitchIds

object

No

The vSwitch ID.

Value

string

No

交换机 ID。

vbr-8vb835n3zf9shwl****mp

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

SecurityGroupId

object

No

The security group ID.

Value

string

No

安全组 ID。

b4bf375515f6440f942e3a20c33d****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Network

object

No

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

Value

string

No

网络类型：

  • PublicNetwork

  • PrivateNetwork

PublicNetwork
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

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

Sink SLS Parameters

Project

object

No

The Simple Log Service project.

Value

string

No

日志服务 SLS 的日志项目。

test-project
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

LogStore

object

No

The Simple Log Service Logstore.

Value

string

No

日志服务 SLS 的日志库。

test-logstore
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Topic

object

No

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

Value

string

No

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

testTopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Body

object

No

The content sent to SLS.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

RoleName

object

No

The role that authorizes the event bus EventBridge to read SLS log content. When you create the role in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "EventBridge".

Value

string

No

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

testRole
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

ContentType

object

No

The SLS data format. You can select the default format or configure specific key-value pairs. Valid values:

  • JSON

  • KeyValue.

Value

string

No

转换前的值。

JSON
Form

string

No

转换的格式。

CONSTANT
Template

string

No

模板样式。

ContentSchema

object

No

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

Value

string

No

转换前的值。

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

string

No

模板样式。

CONSTANT
Template

string

No

模板样式。

SinkDataHubParameters

object

No

The Sink DataHub parameters.

Project

object

No

The DataHub project name.

Value

string

No

DataHub 项目名。

demo-project
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Topic

object

No

The DataHub topic name.

Value

string

No

DataHub Topic 名称。

demo-topic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

TopicType

object

No

The topic type. Valid values:

  • TUPLE

  • BLOB.

Value

string

No

topic 类型：

  • TUPLE

  • BLOB

TUPLE
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

TopicSchema

object

No

The topic content schema for the TUPLE type.

Value

string

No

TUBLE 类型，topic 内容模式。

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

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

The record content template for the BLOB type.

Value

string

No

BLOB 类型，Record 内容模板。

Form

string

No

转换的格式。

ORIGINAL
Template

string

No

无

RoleName

object

No

The task role name.

Value

string

No

任务角色名称。

test-role
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

SinkFnfParameters

object

No

The Sink Fnf parameters.

FlowName

object

No

The flow name.

Value

string

No

流程名称。

test-streaming-fnf
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

ExecutionName

object

No

The execution name.

Value

string

No

执行名称。

123
Form

string

No

转换的格式。默认为 CONSTANT

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

详细参考：https://help.aliyun.com/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

CONSTANT
Template

string

No

模板样式。

Input

object

No

The execution input information.

Value

string

No

执行输入信息。

123
Form

string

No

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

详细参考：https://help.aliyun.com/zh/eventbridge/user-guide/event-transformation

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • ORIGINAL :

    ORIGINAL

  • TEMPLATE :

    TEMPLATE

CONSTANT
Template

string

No

模板样式。

RoleName

object

No

The role configuration.

Value

string

No

角色配置。

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

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式。

SinkPrometheusParameters

object

No

The Sink Prometheus parameters.

URL

object

No

The Prometheus Remote Write URL.

Value

string

No

Prometheus Remote Write URL 地址。

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

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

模板样式（Form 为 CONSTANT 时为空）。

HeaderParameters

object

No

The data structure of the request header parameters.

Value

string

No

  • Form 为 CONSTANT：常量值

  • Form 为 JSONPATH：JSONPath 提取内容

  • Form 为 TEMPLATE：模板变量

注：Value 字段不允许超过 10240 个字符

name
Form

string

No

转换的格式。

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

  • TEMPLATE :

    TEMPLATE

TEMPLATE
Template

string

No

HTTP 请求头模板样式，当 Form 是 TEMPLATE 时填写，事件内容转换后结果必须是 JSON 格式。

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

object

No

The authentication type.

Value

string

No

鉴权方式。

Valid values:

  • BASIC_AUTH :

    BASIC_AUTH

BASIC_AUTH
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

Username

object

No

The username.

Value

string

No

用户名。

****admin
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Password

object

No

The password.

Value

string

No

密码。

*****
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

Data

object

No

The metric content.

Value

string

No

指标内容。

$.data
Form

string

No

转换的格式。默认为 JSAONPATH。

JSAONPATH
Template

string

No

模板样式。

NetworkType

object

No

The network type.

Value

string

No

网络类型。

Valid values:

  • PrivateNetwork :

    PrivateNetwork

  • PublicNetwork :

    PublicNetwork

PrivateNetwork
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

VpcId

object

No

The VPC ID.

Value

string

No

VPC 的 ID。

i-2ze7u5i17mbqtx1p****
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

VSwitchId

object

No

The vSwitch ID.

Value

string

No

交换机 ID。

vsw-dwaafds****
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

SecurityGroupId

object

No

The security group ID.

Value

string

No

安全组 ID。

sg-mw43*****
Form

string

No

转换的格式。默认为 CONSTANT。

Valid values:

  • CONSTANT :

    CONSTANT

CONSTANT
Template

string

No

无

SinkCustomizedKafkaParameters

object

No

The Sink Kafka parameters.

InstanceId

string

No

The instance ID of the ApsaraMQ for Kafka instance.

90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkCustomizedKafkaConnectorParameters

object

No

The Sink Kafka connector parameters.

ConnectorPackageUrl

string

No

The OSS file download URL.

"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

连接器名称。

mongo-sink
Config

object

No

连接器配置。

{ "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 Sink DashVector parameters.

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 DashVector database operation type.

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 this field is not specified, a random primary key ID is used.

Form

string

No

转换的格式。

Valid values:

  • JSONPATH :

    JSONPATH

  • TEMPLATE :

    TEMPLATE

JSONPATH
Value

string

No

  • Form 为 JSONPATH：JSONPath 提取内容

  • Form 为 TEMPLATE：模板变量

Note

Value 字段不允许超过 10240 个字符。

$.data.requestId
Template

string

No

主键 ID 模板，仅当 Form 是 TEMPLATE 时需要填写。

${ID}
Partition

object

No

The partition. Default value: default.

Form

string

No

转换的格式。

Valid values:

  • JSONPATH :

    JSONPATH

  • CONSTANT :

    CONSTANT

CONSTANT
Value

string

No

  • Form 为 CONSTANT：常量值

  • Form 为 JSONPATH：JSONPath 提取内容

Note

Value 字段不允许超过 10240 个字符。

default
Template

string

No

无

${partition}
Vector

object

No

The vector of the record to insert into DashVector.

Form

string

No

转换的格式。

Valid values:

  • JSONPATH :

    JSONPATH

JSONPATH
Value

string

No

JSONPath 提取内容。

Note

Value 字段不允许超过 10240 个字符。

$.data.messageBody
Template

string

No

无

${vector}
DashVectorSchemaParameters

array<object>

No

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

array<object>

No

The attribute columns.

Name

object

No

属性名

Form

string

No

Form

CONSTANT
Value

string

No

Value

content
Template

string

No

Template

Type

object

No

DashVector 属性类型

Form

string

No

Form

CONSTANT
Value

string

No

Value

STRING
Template

string

No

Template

Value

object

No

属性值

Form

string

No

Form

JSONPATH
Value

string

No

Value

$.data.content
Template

string

No

Template

${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

SinkMQTTParameters SinkMQTTParameters

No

SinkAgentRunParameters SinkAgentRunParameters

No

Transforms

array

No

The runtime environment parameters.

Tags

array<object>

No

The Transform-related configurations.

object

No

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

Arn

string

No

The Alibaba Cloud Resource Name (ARN) of the 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. A maximum of 20 tags are supported.

object

No

Key

string

No

The tag key.

Value

string

No

The tag value.

Response elements

Element

Type

Description

Example

object

The response 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 response code. Valid values:

  • Success: the operation is successful.

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

Success
Success

boolean

Indicates whether the operation is successful. The value true is returned 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.