DocsICP FilingConsole
官方文档
首页

UpdateEventStreaming

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

Modifies an event stream, including its basic information, event source, event filtering pattern, or event target.

Operation description

Modifies an event stream, including its basic information, event source, event filtering pattern, or event target.

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

update

*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 you do not specify this parameter, all events are matched. For more information, see https://www.alibabacloud.com/help/en/eventbridge/user-guide/event-patterns.

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

object

Yes

The event source. You must select exactly one Source type.

SourceMNSParameters

object

No

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

RegionId

string

No

The region ID.

cn-hangzhou
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 parameters for ApsaraMQ for RabbitMQ as the event source.

RegionId

string

No

The region ID.

cn-hangzhou
InstanceId

string

No

The ID of the ApsaraMQ for RabbitMQ instance.

i-f8z9lqkldlb4oxsxwwub
VirtualHostName

string

No

The name of the vhost on the ApsaraMQ for RabbitMQ instance.

eb-connect

QueueName

string

No

The name of the queue on the ApsaraMQ for RabbitMQ instance.

demo
SourceKafkaParameters

object

No

The parameters for ApsaraMQ for Kafka as the event source.

RegionId

string

No

The region ID.

cn-zhangjiakou
InstanceId

string

No

The instance ID.

i-8vbh4a5b9yfhgkkzm****
Topic

string

No

The topic name.

topic_empower_1641539400786
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. Set this parameter to PublicNetwork for VPC networks.

Default
VpcId

string

No

The ID of the virtual private cloud (VPC).

vpc-2ze6p0o345nykmekxt****
VSwitchIds

string

No

The vSwitch ID.

vsw-wz9t1l1e8eu2om****
SecurityGroupId

string

No

The security group ID.

sg-uf6jcm3y5hcs7hkl****
ValueDataType

string

No

The encoding and decoding parameter. Valid values: a. Json: Bytes are decoded to a character string by using UTF-8 and then parsed as JSON. b. Text: Bytes are decoded to a character string by using UTF-8 and directly placed into the payload. c. Binary: Bytes are Base64-encoded to a character string and placed into the payload.

Text
SourceRocketMQParameters

object

No

The parameters for ApsaraMQ for RocketMQ as the event source.

RegionId

string

No

The region ID of the ApsaraMQ for RocketMQ instance.

cn-shanghai
InstanceId

string

No

The instance ID of the ApsaraMQ for RocketMQ instance.

i-f8z9a9mcgwri1c1id****
Topic

string

No

The topic name.

TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
Tag

string

No

The filter tag of the message.

test
Offset

string

No

The consumption offset of the message. Valid values:

  • CONSUMEFROMLASTOFFSET: Consumption starts from the latest offset.

  • CONSUMEFROMFIRSTOFFSET: Consumption starts from the earliest offset.

  • CONSUMEFROMTIMESTAMP: Consumption starts from the offset at a specified point in time.

Default value: CONSUMEFROMLAST_OFFSET.

CONSUMEFROMLASTOFFSET
GroupID

string

No

The Group ID of the ApsaraMQ for RocketMQ instance.

GID_test
Timestamp

integer

No

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

1670656652009
InstanceType

string

No

The instance type. Valid values:

  • Cloud_4 (default): Alibaba Cloud RocketMQ 4.0 instance

  • Cloud_5: Alibaba Cloud RocketMQ 5.0 instance

  • SelfBuilt: self-managed Apache RocketMQ instance.

Cloud_5
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
AuthType

string

No

The authentication type.

ACL
InstanceVpcId

string

No

The VPC information of the instance.

vpc-m5e3sv4b12345****
InstanceVSwitchIds

string

No

The vSwitch information of the instance.

vsw-m5ev8asdc6h12****
InstanceSecurityGroupId

string

No

The security group information of the instance.

sg-m5edtu24f12345****
InstanceNetwork

string

No

The network information of the instance. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PublicNetwork
BodyDataType

string

No

The message encoding format. Valid values:

  • Json

  • Text

  • Binary.

Json
FilterType

string

No

The message filter type.

Tag
FilterSql

string

No

The SQL filter statement.

index > 10
VpcId

string

No

The VPC ID of the instance.

vpc-m5e3sv4b12345****

VSwitchIds

string

No

The vSwitch ID.

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

No

The security group ID.

sg-m5edtu24f12345****

Network

string

No

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PublicNetwork

SourceRocketMQCheckpointParameters

object

No

The parameters for ApsaraMQ for RocketMQ checkpoint as the event source.

RegionId

string

No

The region ID.

cn-hangzhou
InstanceType

string

No

The type of the ApsaraMQ for RocketMQ instance.

Cloud_5
InstanceId

string

No

The instance ID of the ApsaraMQ for RocketMQ instance.

rmq-cn-jte3w******
Topics

array

No

The topic of the ApsaraMQ for RocketMQ instance.

string

No

The topic of the ApsaraMQ for RocketMQ instance.

myTopic
SourceApacheRocketMQCheckpointParameters

object

No

The parameters for ApsaraMQ for RocketMQ checkpoint as the event source.

RegionId

string

No

The region ID.

cn-hangzhou
Topics

array

No

The topic of the Apache RocketMQ instance.

string

No

The topic of the Apache RocketMQ instance.

myTopic
InstanceEndpoint

string

No

The endpoint of the Apache RocketMQ instance.

192.168.1.1:9876
InstanceUsername

string

No

The username of the Apache RocketMQ instance.

admin
InstancePassword

string

No

The password of the Apache RocketMQ instance.

****
NetworkType

string

No

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PrivateNetwork
VpcId

string

No

VPC ID。

vpc-adw1awdw*****
VSwitchId

string

No

The vSwitch ID.

vsw-dwaafds****
SecurityGroupId

string

No

The security group ID.

sg-mw43*****
SourceMQTTParameters

object

No

The parameters for ApsaraMQ for MQTT as the event source.

RegionId

string

No

The region ID.

cn-shanghai
InstanceId

string

No

The instance ID.

i-bp1dsudbecqwt61j****
Topic

string

No

The topic name.

topic_empower_1642400400779
BodyDataType

string

No

The message encoding format. Valid values:

  • JSON

  • Text

  • Binary.

JSON
NetworkType

string

No

The network type.

VpcId

string

No

VPC ID。

VSwitchIds

string

No

The vSwitch ID.

SecurityGroupId

string

No

The security group ID.

SourceDTSParameters

object

No

The parameters for Data Transmission Service (DTS) as the event source.

TaskId

string

No

The task ID.

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

string

No

The network address and port 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.

hkprdb
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 checkpoint, which is the timestamp when the SDK client consumes the first data record. The value is a UNIX timestamp.

1620962769
SourceSLSParameters

object

No

The parameters for Simple Log Service as the event source.

RoleName

string

No

The role name that grants authorization to the event bus EventBridge to read Simple Log Service log content. When you create the role in the Resource Access Management (RAM) console, select Alibaba Cloud Service as the trusted entity and select event bus as the trusted service.

testRole

SourcePrometheusParameters

object

No

The parameters for Prometheus as the event source.

RegionId

string

No

The region ID of the instance.

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

The task role name.

test-role

ExternalLabels

string

No

The external labels appended to the event stream.

{"env":"test"}
SourceCustomizedKafkaParameters

object

No

The parameters for a custom Kafka event source.

InstanceId

string

No

The instance ID of the ApsaraMQ for Kafka instance.

r-8vb64581862c****

SourceCustomizedKafkaConnectorParameters

object

No

The parameters for a custom connector-based 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"
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" }
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" }
SourceApacheKafkaParameters

object

No

Bootstraps

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 password for the Kafka client private key. 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 trusted certificate for the Kafka server. This certificate is used to authenticate the legitimacy of the Kafka broker SSL certificate and prevents 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-signing certificate, provide the CA certificate that issued the certificate.

SslKeystoreKey

object

No

Required for bidirectional TLS authentication. The SSL private key configuration object. When the Kafka server enables bidirectional SSL authentication, the client private key is required. Only KMS pattern is supported: specify the Key Management Service (KMS) EPS 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:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}.

KmsArn

string

No

KmsSecretValueKey

string

No

Topic

string

No

ConsumerGroup

string

No

OffsetReset

string

No

ValueDataType

string

No

VpcId

string

No

VSwitchIds

string

No

SecurityGroupId

string

No

NetworkType

string

No

SecurityProtocol

string

No

SaslMechanism

string

No

SaslUser

string

No

SaslPassword

string

No

SourceOSSParameters

object

No

The parameters for Object Storage Service (OSS) as the 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. Valid values: single (single document loading) and element (chunked loading). Default value: single.

single

LoadFormat

string

No

The document loader.

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
SourceEventBusParameters

object

No

The parameters for an event bus as the event source.

EventBusName

string

No

The name of the event bus.

my-event-bus
EventRuleName

string

No

The name of the event rule.

my-event-rule
SourceOpenSourceRabbitMQParameters

object

No

The parameters for open source RabbitMQ as the event source.

Endpoint

string

No

The instance endpoint.

192.168.1.1:9876
VirtualHostName

string

No

The virtual host name of the open source RabbitMQ instance.

Vhost1
QueueName

string

No

The queue name of the open source RabbitMQ instance.

demo
BodyDataType

string

No

The message body data type.

Json
Username

string

No

The username used to connect to the open source RabbitMQ instance.

admin
Password

string

No

The password used to connect to the open source RabbitMQ instance.

****
VpcId

string

No

VPC ID。

vpc-m5e3sv4b12345****
VSwitchIds

string

No

The vSwitch ID.

vsw-m5ev8asdc6h12345****
SecurityGroupId

string

No

The security group ID.

sg-m5edtu24f12345****
NetworkType

string

No

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PrivateNetwork
AuthType

string

No

The authentication type.

ACL
SourceMySQLParameters SourceMySQLParameters

No

The parameters for MySQL as the event source.

SourcePostgreSQLParameters SourcePostgreSQLParameters

No

SourceRabbitMQMetaParameters SourceRabbitMQMetaParameters

No

SourceRabbitMQMsgSyncParameters SourceRabbitMQMsgSyncParameters

No

SourceFeiShuDocsParameters SourceFeiShuDocsParameters

No

Sink

object

No

RunOptions

object

No

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

SinkMNSParameters

object

No

The parameters for Simple Message Queue (formerly MNS) as the event target.

QueueName

object

No

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

Value

string

No

轻量消息队列（原 MNS）的 Queue 的名称。

MyQueue
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Body

object

No

The message content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

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。

CONSTANT
Template

string

No

无

SinkEventHouseParameters

object

No

The event target name.

CatalogName

string

No

The catalog name.

demo
NamespaceName

string

No

The namespace of the target table.

name1
EventTableName

string

No

The name of the target 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
SinkFcParameters

object

No

The parameters for Function Compute as the event target.

ServiceName

object

No

The name of the service.

Value

string

No

服务的名称。

myService
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

FunctionName

object

No

The function name.

Value

string

No

函数名称。

mFunction
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Concurrency

object

No

The delivery concurrency. Minimum value: 1.

Value

string

No

投递并发度，最小 1。

1
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Qualifier

object

No

The alias of the service to which the function belongs.

Value

string

No

函数所属服务的别名。

LATEST
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

InvocationType

object

No

The invocation type. Valid values:

  • Sync: synchronous.

  • Async: asynchronous.

Value

string

No

调用类型。

Async
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Body

object

No

The content body sent to the function.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

DataFormat

object

No

The format conversion rule for event content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

JSONPATH
Template

string

No

模板样式。

$.data.key

SinkRabbitMQParameters

object

No

The parameters for ApsaraMQ for RabbitMQ as the event target.

InstanceId

object

No

The target service type is ApsaraMQ for RabbitMQ.

Value

string

No

消息队列 RabbitMQ 版的实例 ID。

amqp-cn-2r42e73o****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

VirtualHostName

object

No

The name of the vhost on the ApsaraMQ for RabbitMQ instance.

Value

string

No

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

rabbit-host

Form

string

No

转换的格式。默认为 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

无

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

无

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

无

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

无

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 parameters for ApsaraMQ for Kafka as the event target.

InstanceId

object

No

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

Value

string

No

实例 ID。

Defaut_1283278472_s****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

CompressionType

string

No

Topic

object

No

The topic name.

Value

string

No

主题名称。

test
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

DynamicTopic

object

No

Specifies the target topic strategy for message routing. If both the Topic parameter and the DynamicTopic parameter are specified, the DynamicTopic parameter takes precedence. Two configuration modes are supported: 1. Static constant mode: Directly 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 target topic name.

Value

string

No

值

Form

string

No

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

Template

string

No

模板

Headers

object

No

The additional metadata of the Kafka message.

Value

string

No

转换前的值。

{ "key": "value" }

Form

string

No

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

CONSTANT
Template

string

No

模板样式。

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

object

No

The acknowledgment mode for writing to Kafka. Valid values:

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

  • acks=1: A response is returned after the primary node writes successfully. This mode provides moderate performance and a moderate risk of data loss. Data loss may occur if the primary node goes down.

  • acks=all: A response is returned after the primary node writes successfully and the secondary nodes complete synchronization. This mode provides lower performance but higher data safety. Data loss occurs 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

无

Key

object

No

The identifier of the message.

Value

string

No

消息的标识。

key
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Value

object

No

The message body content.

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

SinkApacheKafkaParameters

object

No

The description.

Bootstraps

string

No

Topic

string

No

DynamicTopic

object

No

Specifies the target topic strategy for message routing. If both the Topic parameter and the DynamicTopic parameter are specified, the DynamicTopic parameter takes precedence. Two configuration modes are supported: 1. Static constant mode: Directly 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 target topic name.

Value

string

No

值

Form

string

No

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

Template

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

CompressionType

string

No

SecurityProtocol

string

No

SaslMechanism

string

No

SaslUser

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

Headers

object

No

Value

string

No

Form

string

No

Template

string

No

SaslPassword

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 password for the Kafka client private key. 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

【SSL 场景必填】Kafka 服务端信任证书。用于验证 Kafka Broker 的 SSL 证书合法性，防止中间人攻击。格式要求：Base64 编码的 PEM 格式，通常包含 Kafka 服务端的 CA 证书或服务端证书本身。示例：将 CA 证书的 PEM 文件内容（确保开头和结尾分别是 '-----BEGIN CERTIFICATE-----' 和 '-----END CERTIFICATE-----' ），进行 Base64 编码。若 Kafka 使用自签名证书，需提供签发该证书的 CA 证书

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

【必填】存储 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 内容），则留空此参数

SinkRocketMQParameters

object

No

Sink RocketMQ Parameters

InstanceId

object

No

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

Value

string

No

消息队列 RocketMQ 版的实例 ID。

MQ_INST_164901546557****_BAAN****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Topic

object

No

消息队列 RocketMQ 版实例的 Topic。

Value

string

No

消息队列 RocketMQ 版实例的 Topic。

Mytopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

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

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

Value

string

No

投递顺序类型。

  • Orderly： 顺序投递

  • Concurrently： 并发投递

Concurrently
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

ShardingKey

object

No

The sharding key of the message.

Note

When DeliveryOrderType is set to Orderly, this parameter specifies the event content transformation rule for the ShardingKey property when writing messages downstream. When Source is RocketMQ, ShardingKey can be empty. In this case, the upstream BrokerName and QueueId are concatenated to generate the message ShardingKey.

Value

string

No

分片健值。

order_id
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
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

Body

object

No

Value

string

No

Form

string

No

Template

string

No

Table

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

Sink RocketMQ Checkpoint Parameters

InstanceType

string

No

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

No

The instance ID.

MQ_INST_164901546557****_BAAN****
Topic

object

No

消息队列 RocketMQ 版实例的 Topic。

Value

string

No

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

Mytopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

ConsumeTimestamp

object

No

The timestamp of message consumption.

Value

string

No

时间戳。

1570761026400
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

Group

object

No

The Group ID of the consumer group.

Value

string

No

Group ID

GID_EVENTBRIDGE_1736234******
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

SinkApacheRocketMQCheckpointParameters

object

No

Sink Apache RocketMQ Checkpoint Parameters

Topic

object

No

The topic of the RocketMQ instance.

Value

string

No

RocketMQ 实例的 Topic 的名称。

Mytopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

ConsumeTimestamp

object

No

The timestamp of message consumption.

Value

string

No

时间戳。

1570761026400
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

Group

object

No

The Group ID of the consumer group.

Value

string

No

Group ID

GID_EVENTBRIDGE_1736234******
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

InstanceEndpoint

string

No

The instance endpoint.

192.168.1.1:9876
InstanceUsername

string

No

The username required for authentication.

admin
InstancePassword

string

No

The password for the username. [_single.

****
NetworkType

string

No

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork.

PrivateNetwork
VpcId

string

No

专有网络的 ID。

vpc-2zeccak5pb0j3ay******
VSwitchId

string

No

The vSwitch ID.

vsw-uf62oqt1twuevrt******
SecurityGroupId

string

No

The security group ID.

sg-2ze5bmpw6adn0q******
SinkSLSParameters

object

No

Sink SLS Parameters

Project

object

No

日志服务 SLS 的日志项目。

Value

string

No

日志服务 SLS 的日志项目。

test-project

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

LogStore

object

No

日志服务 SLS 的日志库。

Value

string

No

日志服务 SLS 的日志库。

test-logstore

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Topic

object

No

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

Value

string

No

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

testTopic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Body

object

No

发送给 SLS 的内容。

Value

string

No

转换前的值。

{ "key": "value" }
Form

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

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

Value

string

No

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

testRole
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

ContentType

object

No

SLS 数据格式。可选择默认或者配置制定的键值：

  • JSON

  • KeyValue

Value

string

No

SLS 数据格式。

JSON
Form

string

No

转换的格式。

CONSTANT

Template

string

No

模板样式。

ContentSchema

object

No

自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n，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

模板样式。

SinkFnfParameters

object

No

Sink Fnf 参数

FlowName

object

No

流程名称

Value

string

No

流程名称

test-streaming-fnf

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

ExecutionName

object

No

执行名称

Value

string

No

执行名称

123
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

Input

object

No

执行输入信息

Value

string

No

执行输入信息

123
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

RoleName

object

No

角色配置

Value

string

No

角色配置

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

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

模板样式。

SinkPrometheusParameters

object

No

Sink Prometheus 参数

URL

object

No

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。

CONSTANT
Template

string

No

无

HeaderParameters

object

No

请求头的参数数据结构。

Value

string

No

  • Form 为 CONSTANT：常量值

  • Form 为 JSONPATH：JSONPath 提取内容

  • Form 为 TEMPLATE：模板变量

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

name
Form

string

No

转换的格式。

枚举值：

  • JSONPATH：JSONPATH。

  • CONSTANT：CONSTANT。

  • TEMPLATE：TEMPLATE。

TEMPLATE
Template

string

No

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

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

object

No

鉴权方式

Value

string

No

鉴权方式

BASIC_AUTH
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Username

object

No

用户名

Value

string

No

用户名

***admin
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Password

object

No

密码

Value

string

No

密码

abc
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Data

object

No

指标内容

Value

string

No

指标内容

$.data
Form

string

No

转换的格式。默认为 JSONPATH。

JSONPATH
Template

string

No

无

NetworkType

object

No

网络类型

Value

string

No

网络类型：

  • PublicNetwork

  • PrivateNetwork

PrivateNetwork
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

VpcId

object

No

VPC ID。

Value

string

No

VPC ID。

vpc-adw1awdw*****
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

VSwitchId

object

No

交换机 Id

Value

string

No

交换机 Id

vsw-dwaafds****

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

SecurityGroupId

object

No

The security group ID.

Value

string

No

安全组 ID。

sg-mw43*****

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

SinkDataHubParameters

object

No

Sink DataHub 参数。

Project

object

No

DataHub 项目名。

Value

string

No

DataHub 项目名。

demo-project

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

Topic

object

No

DataHub Topic 名称。

Value

string

No

DataHub Topic 名称。

demo-topic
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

TopicType

object

No

topic 类型。

  • TUPLE

  • BLOB

Value

string

No

topic 类型。

  • TUPLE

  • BLOB

TUPLE
Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

No

无

TopicSchema

object

No

TUBLE 类型，topic 内容模式。

Value

string

No

TUBLE 类型，topic 内容模式。

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

string

No

转换的格式。

TEMPLATE
Template

string

No

模板样式。

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

object

No

BLOB 类型，Record 内容模板。

Value

string

No

BLOB 类型，Record 内容模板。

Form

string

No

转换的格式。

ORIGINAL
Template

string

No

无

RoleName

object

No

任务角色名。

Value

string

No

任务角色名称。

test-role

Form

string

No

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

No

无

ContentType

object

No

数据格式。可选择默认或者配置制定的键值：

  • JSON

  • KeyValue

Value

string

No

转换前的值。

JSON
Form

string

No

转换的格式。

CONSTANT
Template

string

No

模板样式。

ContentSchema

object

No

自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n, 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

模板样式。

SinkCustomizedKafkaParameters

object

No

Sink Kafka 参数。

InstanceId

string

No

消息队列 Kafka 版的实例 ID。

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

object

No

Sink Kafka 连接器参数。

ConnectorPackageUrl

string

No

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

No

解析当前 ZIP 包下的 properties 文件。

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

Sink DashVector 参数。

InstanceId

string

No

The instance ID.

vrs-cn-lbj3ru1***
Collection

string

No

Collection（集合）名称。

collection1
ApiKey

string

No

DashVecotor 控制台创建的 API Key。

Q34nExQH7sQ****
Operation

string

No

DashVector 数据库操作类型。

  • Delete

  • Upsert

Upsert
Network

string

No

网络类型。

  • PrivateNetwork

  • PublicNetwork

PublicNetwork
PrimaryKeyId

object

No

插入/删除记录时的主键 ID 不填写此字段时，使用随机主键 ID。

Form

string

No

转换的格式：

  • JSONPATH

  • 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

Partition（分区），默认值为 default 分区。

Form

string

No

转换的格式：

  • JSONPATH

  • CONSTANT

CONSTANT

Value

string

No

  • Form 为 CONSTANT：常量值

  • Form 为 JSONPATH：JSONPath 提取内容

Note

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

default
Template

string

No

无

Vector

object

No

插入 DashVector 记录的向量。

Form

string

No

转换的格式。

JSONPATH
Value

string

No

JSONPath 提取内容。

Note

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

$.data.messageBody
Template

string

No

无

DashVectorSchemaParameters

array<object>

No

插入 DashVector 时表项的 Schema 字段定义，事件内容转换后结果必须是 Json 格式。

array<object>

No

Name

object

No

Form

string

No

Value

string

No

Template

string

No

Type

object

No

Form

string

No

Value

string

No

Template

string

No

Value

object

No

Form

string

No

Value

string

No

Template

string

No

SinkOpenSourceRabbitMQParameters

object

No

Sink Open Source RabbitMQ Parameters

Endpoint

string

No

接入点。

192.168.1.1:9876
VirtualHostName

string

No

RabbitMQ 的虚拟主机名称。

Vhost1
TargetType

string

No

消息投递的目标类型。

  • Exchange： 消息通过交换机进行路由。

  • Queue： 消息直接投递到指定队列。

Exchange
Exchange

string

No

RabbitMQ 中的 Exchange 名称，当 TargetType 设置为 Exchange 时生效。

my-exchange
QueueName

string

No

RabbitMQ 中的队列名称，仅当 TargetType 设置为 Queue 时生效。

my-queue
Username

string

No

访问 RabbitMQ 实例的用户名。

admin
Password

string

No

访问 RabbitMQ 实例的密码。

****
VpcId

string

No

专有网络 ID。

vpc-uf6of9452b2pba82c ****
VSwitchIds

string

No

The vSwitch ID.

vsw-uf6of9452b2pba82c ****
SecurityGroupId

string

No

The security group ID.

sg-uf6of9452b2pba82c ****
NetworkType

string

No

网络类型。

  • PrivateNetwork

  • PublicNetwork

PublicNetwork

AuthType

string

No

认证类型：

  • ACL

  • 无需配置

ACL
RoutingKey

object

No

消息路由键。

Form

string

No

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

No

路由键值。

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

string

No

模板样式。

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

object

No

The message body content.

Form

string

No

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

No

原始数据值。

{"key": "value"}
Template

string

No

模板样式。

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

object

No

消息的唯一标识符。

Form

string

No

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

No

消息 ID 值。

12345
Template

string

No

模板样式。

Properties

object

No

消息的附加属性。

Form

string

No

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

No

属性内容。

{"env": "prod"}
Template

string

No

模板样式。

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

No

Sink BaiLian Parameters

SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

No

SinkHttpsParameters

SinkHttpsParameters

No

Https 目标参数

SinkApiDestinationParameters SinkApiDestinationParameters

No

ApiDestination 目标参数

SinkOSSParameters SinkOSSParameters

No

SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

No

SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

No

SinkMQTTParameters SinkMQTTParameters

No

SinkAgentRunParameters SinkAgentRunParameters

No

Transforms

array

No

运行环境参数。

Transforms

array<object>

No

Transform 相关配置

object

No

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

Arn

string

No

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

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

DashScopeTransformParameters

No

BaiLianAgentTransformParameters

BaiLianAgentTransformParameters

No

Response elements

Element

Type

Description

Example

object

返回信息。

Message

string

错误信息。

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

string

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

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

string

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

Success
Success

boolean

操作成功返回 true。

true

Examples

Success response

JSON format

{
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5",
  "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.