Creates an event stream.
Operation description
Creates an event stream.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
eventbridge:CreateEventStreaming |
create |
*EventStreaming
|
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 |
No |
The event filtering rule. If you do not specify this parameter, all events are matched. |
{ "source": [ { "prefix": "acs:mns" } ], "type": [ { "prefix": "mns:Queue" } ], "subject": [ { "prefix": "acs:mns:cn-hangzhou:123456789098****:queues/zeus" } ] } |
| Source |
object |
No |
The event provider. You must specify one source type, and you can specify only 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 encoding. 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 name of the vhost of the ApsaraMQ for RabbitMQ instance. |
eb-connect |
| QueueName |
string |
No |
The name of the queue of the ApsaraMQ for RabbitMQ instance. |
demo |
| VpcId |
string |
No |
||
| VSwitchIds |
string |
No |
||
| SecurityGroupId |
string |
No |
||
| NetworkType |
string |
No |
||
| 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 |
| 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: |
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: |
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 |
| 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:
|
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 network information of the instance: |
PublicNetwork |
| BodyDataType |
string |
No |
The message encoding format. |
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: |
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 consumer 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 Simple Log Service (SLS) parameters. |
|
| Project |
string |
No |
The Log Service project. |
test |
| LogStore |
string |
No |
The Log Service Logstore. |
sas-log |
| ConsumePosition |
string |
No |
The starting consumer offset. You can select the earliest or latest offset, which corresponds to "begin" or "end" respectively. You can also start consuming from a specified time in seconds. |
end |
| RoleName |
string |
No |
The role that provides authorization for the event bus EventBridge to read SLS log content. To meet the requirements, when you create the role used by the service in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus". |
testRole |
| SourcePrometheusParameters |
object |
No |
The source Prometheus event source parameters. |
|
| 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 parameters. |
|
| InstanceId |
string |
No |
The instance ID of MSMQ for Apache Kafka. |
r-8vb64581862c**** |
| SourceCustomizedKafkaConnectorParameters |
object |
No |
The custom connector Apache Kafka event source parameters. |
|
| ConnectorPackageUrl |
string |
No |
The download URL of the OSS resource ZIP package. |
"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ" |
| WorkerParameters |
object |
No |
The Kafka instance configuration. |
{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" } |
| ConnectorParameters |
object |
No |
The connector parameters. |
|
| Name |
string |
No |
The connector name. |
test-name |
| Config |
object |
No |
The connector configuration. |
{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" } |
| SourceApacheKafkaParameters |
object |
No |
The open-source Kafka parameter settings. |
|
| Bootstraps |
string |
No |
The bootstrap servers endpoint. |
|
| Topic |
string |
No |
The topic name. |
|
| ConsumerGroup |
string |
No |
The consumer group name. |
|
| OffsetReset |
string |
No |
The consumer offset. |
|
| ValueDataType |
string |
No |
The data type. Valid values: |
|
| 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. |
|
| 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 authentication] The Kafka client certificate chain. 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, intermediate CA certificate next, root CA certificate optional). Note: Ensure that the beginning and end of each PEM file content are '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' respectively, then Base64-encode the concatenated content. |
|
| SslKeyPassword |
string |
No |
[Required for encrypted private key] The Kafka client private key password. Required when the client private key is encrypted with a password (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave empty if the private key is not encrypted. Note: This password is only used to decrypt the private key and is unrelated to Kafka authentication. |
|
| SslTruststoreCertificates |
string |
No |
[Required for SSL] The Kafka server trust certificate. Used to authenticate the legitimacy of the Kafka Broker SSL certificate and prevent man-in-the-middle attacks. Format: Base64 encoding of PEM format, typically containing the Kafka server CA certificate or the server certificate itself. Example: Base64-encode the PEM file content of the CA certificate (ensure the beginning and end are '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued the certificate. |
|
| SslKeystoreKey |
object |
No |
[Required for bidirectional authentication] The SSL private key configuration object. Required when the Kafka server enables bidirectional SSL authentication. Only KMS pattern is supported: specify the Key Management Service 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 |
[Required] The KMS resource ARN that stores the SSL private key. Used to locate the Key Management Service instance that stores the client private key. Format example: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. Obtain this value from the ARN information of the corresponding key in the KMS console. |
|
| KmsSecretValueKey |
string |
No |
[KMS KV mode] The key name in the KMS secret. When the KMS secret is stored in a key-value (KV) structure, specify this parameter to indicate the key corresponding to the SSL private key. Example: if the KMS secret is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', specify 'ssl_keystore_key'. Leave this parameter empty if the KMS secret is in plain text mode (directly stores the PEM content of the private key). |
|
| SourceOSSParameters |
object |
No |
The source OSS event source parameters. |
|
| RoleName |
string |
No |
The role name that provides authorization for 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 bucket name in Object Storage Service (OSS). |
bucket_abc |
| Prefix |
string |
No |
The file path prefix. |
fun/document/ |
| LoadMode |
string |
No |
The data loading mode. "single" indicates single-document loading, and "element" indicates chunked loading. Valid values:
|
single |
| LoadFormat |
string |
No |
The document loader. Valid values:
|
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 |
||
| SourceJDBCParameters | SourceJDBCParameters |
No |
||
| Metadata |
string |
No |
The generic JSON Configurations for the event source. This parameter is mutually exclusive with Source. |
|
| Sink |
object |
No |
The event target. You must select one Sink type, and you can select only one Sink type. |
|
| SinkMNSParameters |
object |
No |
The MNS event target. |
|
| QueueName |
object |
No |
The event target type is Message Service (MNS). |
|
| Value |
string |
No |
The queue name of Simple Message Queue (formerly MNS). |
MyQueue |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Body |
object |
No |
The message body. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. Valid values:
|
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| IsBase64Encode |
object |
No |
Specifies whether to enable Base64 encoding. |
|
| Value |
string |
No |
Specifies whether to enable Base64 encoding. |
true |
| Form |
string |
No |
The event transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
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 |
The column value extraction rule. |
|
| Value |
string |
No |
The extraction path, such as $.data.value.name. |
$.data.value |
| Form |
string |
No |
The transformation method, such as JSONPATH. |
JSONPATH |
| Template |
string |
No |
The template configuration. |
The value of ${key} is ${value}! |
| ColumnName |
string |
No |
The column name. |
age |
| ColumnType |
string |
No |
The column type. |
text |
| SinkRabbitMQParameters |
object |
No |
The parameters for the Sink RabbitMQ. |
|
| InstanceId |
object |
No |
The event target type is ApsaraMQ for RabbitMQ. |
|
| Value |
string |
No |
The instance ID of the ApsaraMQ for RabbitMQ instance. |
a5ff91ad4f3f24947887fe184fc2**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| VirtualHostName |
object |
No |
The vhost name of the ApsaraMQ for RabbitMQ instance. |
|
| Value |
string |
No |
The vhost name of the ApsaraMQ for RabbitMQ instance. |
rabbit-host |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
|
| TargetType |
object |
No |
The target type. |
|
| Value |
string |
No |
The target type. Valid values:
|
Exchange/Queue |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Exchange |
object |
No |
The Exchange mode. |
|
| Value |
string |
No |
The name of the exchange in the MSMQ for RabbitMQ instance. |
a_exchange |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| RoutingKey |
object |
No |
The routing rule of the message. |
|
| Value |
string |
No |
The routing rule of the message. |
housekeeping |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| QueueName |
object |
No |
The Queue mode. |
|
| Value |
string |
No |
The queue name of the instance. |
MyQueue |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Body |
object |
No |
The message body. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| MessageId |
object |
No |
The message ID. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Properties |
object |
No |
The filtering properties. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| 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 |
||
| SinkKafkaParameters |
object |
No |
The Sink Kafka parameters. |
|
| InstanceId |
object |
No |
The event target type is MSMQ for Apache Kafka. |
|
| Value |
string |
No |
The instance ID. |
Defaut_1283278472_s**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Topic |
object |
No |
The topic name. |
|
| Value |
string |
No |
The topic name. |
test |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| DynamicTopic |
object |
No |
Specifies the target topic routing policy for messages. If both the Topic and DynamicTopic parameters are specified, the value of the DynamicTopic parameter takes precedence. The following two configuration modes are supported: |
|
| Value |
string |
No |
The value. [_single.params.Sink.props.SinkKafkaParameters.D |
|
| Form |
string |
No |
The transformation type. CONSTANT: constant. JSONPATH: extracts content from upstream based on a path. |
|
| Template |
string |
No |
The template. |
|
| Acks |
object |
No |
The acknowledgment mode for writing to Kafka: |
|
| Value |
string |
No |
The acknowledgment mode for writing to Kafka:
|
1 |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Key |
object |
No |
The message key. |
|
| Value |
string |
No |
The message key. |
key |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Value |
object |
No |
The message body. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Headers |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| CompressionType |
string |
No |
||
| SinkApacheKafkaParameters |
object |
No |
The description. |
|
| Bootstraps |
string |
No |
The initial endpoint of the Kafka cluster. |
|
| DynamicTopic |
object |
No |
Specifies the target topic routing policy for messages. If both the Topic and DynamicTopic parameters are specified, the value of the DynamicTopic parameter takes precedence. The following two configuration modes are supported: |
|
| Value |
string |
No |
The value. [_single.params.Sink.props.SinkKafkaParameters.D |
|
| Form |
string |
No |
The transformation type. CONSTANT: constant. JSONPATH: extracts content from upstream based on a path. |
|
| Template |
string |
No |
The template. |
|
| 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 authentication] The Kafka client certificate chain. 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, intermediate CA certificate next, root CA certificate optional). Note: Ensure that the beginning and end of each PEM file content are '-----BEGIN CERTIFICATE-----' and '-----END CERTIFICATE-----' respectively, then Base64-encode the concatenated content. |
|
| SslKeyPassword |
string |
No |
[Required for encrypted private key] The Kafka client private key password. Required when the client private key is encrypted with a password (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave empty if the private key is not encrypted. Note: This password is only used to decrypt the private key and is unrelated to Kafka authentication. |
|
| SslTruststoreCertificates |
string |
No |
[Required for SSL] The Kafka server trust certificate. Used to authenticate the validity of the Kafka Broker SSL certificate 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 the content 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 bidirectional authentication] The SSL private key configuration object. When the Kafka server enables bidirectional SSL authentication, provide the client private key. Only KMS pattern is supported: specify the Key Management Service EPS resource that stores the private key by using KmsArn. The system retrieves the private key content from KMS only in memory, which provides higher security. Configuration example: {"KmsArn": "acs:kms:ap-southeast-1:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"} |
|
| KmsArn |
string |
No |
[Required] The KMS resource ARN that stores the SSL private key. Used to locate the Key Management Service instance that stores the client private key. Format example: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. Obtain this value from the ARN information of the corresponding key in the KMS console. |
|
| KmsSecretValueKey |
string |
No |
[KMS KV mode] The key name in the KMS secret. When the KMS secret is stored in a key-value (KV) structure, specify this parameter to indicate the key corresponding to the SSL private key. Example: if the KMS secret is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', specify 'ssl_keystore_key'. Leave this parameter empty if the KMS secret is in plain text mode (directly stores the PEM content of the private key). |
|
| CompressionType |
string |
No |
||
| VpcId |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| VSwitchIds |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SecurityGroupId |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| NetworkType |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SaslPassword |
string |
No |
||
| SinkFcParameters |
object |
No |
The function target. |
|
| ServiceName |
object |
No |
The service name. |
|
| Value |
string |
No |
The service name. |
myService |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| FunctionName |
object |
No |
The function name. |
|
| Value |
string |
No |
The function name. |
myFunction |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Concurrency |
object |
No |
The delivery concurrency. The minimum value is 1. |
|
| Value |
string |
No |
The delivery concurrency. The minimum value is 1. |
1 |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Qualifier |
object |
No |
The service version. |
|
| Value |
string |
No |
The service version. |
LATEST |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| InvocationType |
object |
No |
Specifies whether the invocation is synchronous or asynchronous. |
|
| Value |
string |
No |
The invocation type. Valid values:
Valid values:
|
Async |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Body |
object |
No |
The content body sent to the function. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. Valid values:
For more information, see Event transformation. Valid values:
|
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| DataFormat |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SinkRocketMQParameters |
object |
No |
Sink RocketMQ Parameters |
|
| InstanceId |
object |
No |
The event target type is ApsaraMQ for RocketMQ. |
|
| Value |
string |
No |
The instance ID of MSMQ for RocketMQ. |
MQ_INST_164901546557****_BAAN**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Topic |
object |
No |
The topic of the ApsaraMQ for RocketMQ instance. |
|
| Value |
string |
No |
The topic name of the MSMQ for RocketMQ instance. |
Mytopic |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Body |
object |
No |
The message body. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Properties |
object |
No |
The filtering properties. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Keys |
object |
No |
The filtering properties. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| Tags |
object |
No |
The filtering properties. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| InstanceType |
object |
No |
The instance type. |
|
| Value |
string |
No |
The instance type. Valid values:
|
Cloud_4 |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| InstanceEndpoint |
object |
No |
The instance endpoint. |
|
| Value |
string |
No |
The instance endpoint. |
vbr-8vbsvkkbpf3vb0zef**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| InstanceUsername |
object |
No |
The instance username. |
|
| Value |
string |
No |
The instance username. |
admin |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| InstancePassword |
object |
No |
The instance password. |
|
| Value |
string |
No |
The instance password. |
admin |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| VpcId |
object |
No |
The ID of the VPC. |
|
| Value |
string |
No |
The VPC ID. |
vbr-8vb835n3zf9shwlvb**** |
| Form |
string |
No |
The event transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| VSwitchIds |
object |
No |
The vSwitch ID. |
|
| Value |
string |
No |
The vSwitch ID. |
vbr-8vb835n3zf9shwl****mp |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| SecurityGroupId |
object |
No |
The security group ID. |
|
| Value |
string |
No |
The security group ID. |
b4bf375515f6440f942e3a20c33d**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| Network |
object |
No |
The network type: |
|
| Value |
string |
No |
The network type. Valid values:
|
PublicNetwork |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| DeliveryOrderType |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| ShardingKey |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SinkDorisParameters |
object |
No |
The event source type. |
|
| QueryEndpoint |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| FeHttpEndpoint |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| BeHttpEndpoint |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| UserName |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Password |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Database |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Table |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Body |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| NetworkType |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| VpcId |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| VSwitchIds |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SecurityGroupId |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SinkRocketMQCheckpointParameters |
object |
No |
The event source type. |
|
| InstanceType |
string |
No |
||
| InstanceId |
string |
No |
||
| Topic |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| ConsumeTimestamp |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Group |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| SinkApacheRocketMQCheckpointParameters |
object |
No |
The event source type. |
|
| Topic |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| ConsumeTimestamp |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| Group |
object |
No |
||
| Value |
string |
No |
||
| Form |
string |
No |
||
| Template |
string |
No |
||
| InstanceEndpoint |
string |
No |
||
| InstanceUsername |
string |
No |
||
| InstancePassword |
string |
No |
||
| NetworkType |
string |
No |
||
| VpcId |
string |
No |
||
| VSwitchId |
string |
No |
||
| SecurityGroupId |
string |
No |
||
| SinkSLSParameters |
object |
No |
Sink SLS Parameters |
|
| Project |
object |
No |
The Log Service project. |
|
| Value |
string |
No |
The project of Simple Log Service. |
test-project |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| LogStore |
object |
No |
The Log Service Logstore. |
|
| Value |
string |
No |
The Logstore of Simple Log Service. |
test-logstore |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| Topic |
object |
No |
The topic of the log, which corresponds to the SLS reserved field "topic". |
|
| Value |
string |
No |
The topic where the log resides, corresponding to the Simple Log Service reserved field "topic". |
testTopic |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| Body |
object |
No |
The content sent to SLS. |
|
| Value |
string |
No |
The value before transformation. |
{ "key": "value" } |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
The value of ${key} is ${value}! |
| RoleName |
object |
No |
The role that provides authorization for the event bus EventBridge to read SLS log content. The following conditions must be met: when you create the role used by the service in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus". |
|
| Value |
string |
No |
To grant authorization to the event bus EventBridge to use this role to read Simple Log Service log content, the following conditions must be met: when creating the role used by the service in the Resource Access Management (RAM) console, select "Alibaba Cloud Service", and set "Trusted Service" to "event bus". |
testRole |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| ContentType |
object |
No |
The SLS data format. You can select the default format or configure a specified key-value pair. |
|
| Value |
string |
No |
The value before transformation. |
JSON |
| Form |
string |
No |
The transformation format. |
CONSTANT |
| Template |
string |
No |
The template style. |
|
| 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 |
The value before transformation. |
{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}} |
| Form |
string |
No |
The template style. |
CONSTANT |
| Template |
string |
No |
The template style. |
|
| SinkDataHubParameters |
object |
No |
The Sink DataHub parameters. |
|
| Project |
object |
No |
The DataHub project name. |
|
| Value |
string |
No |
The DataHub project name. |
demo-project |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| Topic |
object |
No |
The DataHub topic name. |
|
| Value |
string |
No |
The DataHub topic name. |
demo-topic |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| TopicType |
object |
No |
The topic type: |
|
| Value |
string |
No |
The topic type. Valid values:
|
TUPLE |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| TopicSchema |
object |
No |
The topic content schema for the TUPLE type. |
|
| Value |
string |
No |
The topic content schema for the TUPLE type. |
{"k1":"value1","k2":"value2"} |
| Form |
string |
No |
The transformation format. |
TEMPLATE |
| Template |
string |
No |
The template style. |
{"k1":"${k1}","k2":"${k2}"} |
| Body |
object |
No |
The Record content template for the BLOB type. |
|
| Value |
string |
No |
The Record content template for the BLOB type. |
|
| Form |
string |
No |
The transformation format. |
ORIGINAL |
| Template |
string |
No |
None. |
|
| RoleName |
object |
No |
The task role name. |
|
| Value |
string |
No |
The task role name. |
test-role |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| SinkFnfParameters |
object |
No |
The Sink Fnf parameters. |
|
| FlowName |
object |
No |
The flow name. |
|
| Value |
string |
No |
The flow name. |
test-streaming-fnf |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
|
| ExecutionName |
object |
No |
The execution name. |
|
| Value |
string |
No |
The execution name. |
123 |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
For more information, see Event transformation. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
|
| Input |
object |
No |
The execution input information. |
|
| Value |
string |
No |
The execution input information. |
123 |
| Form |
string |
No |
The transformation format. Valid values:
For more information, see Event transformation. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
|
| RoleName |
object |
No |
The role configuration. |
|
| Value |
string |
No |
The role configuration. |
Al****FNF-x**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. |
|
| SinkPrometheusParameters |
object |
No |
The Sink Prometheus parameters. |
|
| URL |
object |
No |
The Prometheus Remote Write URL. |
|
| Value |
string |
No |
The Prometheus Remote Write URL address. |
https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275****/c5b7faeb2e8994641*****d5c559f/cn-hangzhou/api/v3/write |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
The template style. This parameter is empty when Form is set to CONSTANT. |
|
| HeaderParameters |
object |
No |
The data structure of the request header parameters. |
|
| Value |
string |
No |
Note: The Value field cannot exceed 10240 characters. |
name |
| Form |
string |
No |
The transformation format. Valid values:
|
TEMPLATE |
| Template |
string |
No |
The HTTP request header template style. Specify this parameter when Form is set to TEMPLATE. The result after event content transformation must be in JSON format. |
{ "user_name":"${name}" } |
| AuthorizationType |
object |
No |
The authentication method. |
|
| Value |
string |
No |
The authentication method. Valid values:
|
BASIC_AUTH |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| Username |
object |
No |
The username. |
|
| Value |
string |
No |
The username. |
****admin |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. |
CONSTANT |
| Template |
string |
No |
None. |
|
| Password |
object |
No |
The password. |
|
| Value |
string |
No |
The password. |
***** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| Data |
object |
No |
The metric content. |
|
| Value |
string |
No |
The metric content. |
$.data |
| Form |
string |
No |
The transformation format. Default value: JSONPATH. |
JSAONPATH |
| Template |
string |
No |
The template style. |
|
| NetworkType |
object |
No |
The network type. |
|
| Value |
string |
No |
The network type. Valid values:
|
PrivateNetwork |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| VpcId |
object |
No |
The ID of the VPC. |
|
| Value |
string |
No |
The VPC ID. |
i-2ze7u5i17mbqtx1p**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| VSwitchId |
object |
No |
The vSwitch ID. |
|
| Value |
string |
No |
The vSwitch ID. |
vsw-dwaafds**** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| SecurityGroupId |
object |
No |
The security group ID. |
|
| Value |
string |
No |
The security group ID. |
sg-mw43***** |
| Form |
string |
No |
The transformation format. Default value: CONSTANT. Valid values:
|
CONSTANT |
| Template |
string |
No |
None. |
|
| SinkCustomizedKafkaParameters |
object |
No |
The Sink Kafka parameters. |
|
| InstanceId |
string |
No |
The instance ID of ApsaraMQ for Kafka. |
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 |
The connector name. |
mongo-sink |
| Config |
object |
No |
The connector configuration. |
{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" } |
| WorkerParameters |
object |
No |
The instance configuration. |
{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" } |
| SinkDashVectorParameters |
object |
No |
The 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:
|
Upsert |
| Network |
string |
No |
The network type. Valid values:
|
PublicNetwork |
| PrimaryKeyId |
object |
No |
The primary key ID used when inserting or deleting records. |
|
| Form |
string |
No |
The transformation format. Valid values:
|
JSONPATH |
| Value |
string |
No |
Note
The Value field cannot exceed 10240 characters. |
$.data.requestId |
| Template |
string |
No |
The primary key ID template. Specify this parameter only when Form is set to TEMPLATE. |
${ID} |
| Partition |
object |
No |
The partition. Default value: default. |
|
| Form |
string |
No |
The transformation format. Valid values:
|
CONSTANT |
| Value |
string |
No |
Note
The Value field cannot exceed 10240 characters. |
default |
| Template |
string |
No |
None. |
${partition} |
| Vector |
object |
No |
The vector of the DashVector record to insert. |
|
| Form |
string |
No |
The transformation format. Valid values:
|
JSONPATH |
| Value |
string |
No |
The JSONPath-extracted content. Note
The Value field cannot exceed 10240 characters. |
$.data.messageBody |
| Template |
string |
No |
None. |
${vector} |
| DashVectorSchemaParameters |
array<object> |
No |
The schema field definition of the table entry when inserting into DashVector. The result after event content transformation must be in JSON format. |
|
|
array<object> |
No |
The attribute column. |
||
| Name |
object |
No |
The property name. |
|
| Form |
string |
No |
Form |
CONSTANT |
| Value |
string |
No |
Value |
content |
| Template |
string |
No |
Template |
|
| Type |
object |
No |
The DashVector property type. |
|
| Form |
string |
No |
Form |
CONSTANT |
| Value |
string |
No |
Value |
STRING |
| Template |
string |
No |
Template |
|
| Value |
object |
No |
The property value. |
|
| 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 |
||
| RunOptions |
object |
No |
The runtime environment parameters. |
|
| MaximumTasks |
integer |
No |
The concurrency. |
2 |
| ErrorsTolerance |
string |
No |
The error tolerance policy: |
ALL |
| RetryStrategy |
object |
No |
The retry strategy when event pushing fails. |
|
| PushRetryStrategy |
string |
No |
The retry strategy: |
BACKOFF_RETRY |
| MaximumEventAgeInSeconds |
integer |
No |
The maximum retry time. |
512 |
| MaximumRetryAttempts |
integer |
No |
The maximum number of retry attempts. |
2 |
| DeadLetterQueue |
object |
No |
Specifies whether to enable the dead-letter queue. The dead-letter queue is disabled by default. Messages that exceed the retry policy are discarded. |
|
| Arn |
string |
No |
The ARN of the dead-letter queue. |
acs:ram::131733464781****:role/rdstoecsassumekms |
| Network |
string |
No |
||
| VpcId |
string |
No |
||
| VSwitchIds |
string |
No |
||
| SecurityGroupId |
string |
No |
||
| BatchWindow |
object |
No |
The batch window. |
|
| CountBasedWindow |
integer |
No |
The maximum number of events that the window can contain. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, data is pushed when any window meets the threshold. |
100 |
| TimeBasedWindow |
integer |
No |
The maximum time range (in seconds) of events that the window can contain. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, data is pushed when any window meets the threshold. |
10 |
| BusinessOption |
object |
No |
||
| BusinessMode |
string |
No |
||
| MinCapacityUnitCount |
integer |
No |
||
| MaxCapacityUnitCount |
integer |
No |
||
| Throttling |
integer |
No |
||
| Transforms |
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 tag list, containing up to 20 items. |
|
|
object |
No |
|||
| Key |
string |
No |
The tag key. |
|
| Value |
string |
No |
The tag value. |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The request parameters. |
||
| Message |
string |
The error message. |
The name [xxxx] of event streaming in request is already exist! |
| RequestId |
string |
The request ID. |
B896B484-F16D-59DE-9E23-DD0E5C36**** |
| Data |
object |
The returned data. |
|
| EventStreamingARN |
string |
The Alibaba Cloud Resource Name (ARN) of the event stream. |
acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming |
| Code |
string |
The response code: |
Success |
| Success |
boolean |
Returns true if the operation is successful. |
true |
Examples
Success response
JSON format
{
"Message": "The name [xxxx] of event streaming in request is already exist!",
"RequestId": "B896B484-F16D-59DE-9E23-DD0E5C36****",
"Data": {
"EventStreamingARN": "acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming"
},
"Code": "Success",
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.