All Products
Search

This Product

    EventBridge:UpdateEventStreaming

    Document Center

    EventBridge:UpdateEventStreaming

    Last Updated:Dec 10, 2025

    Updates the basic information, event source, event filtering pattern, or event target for an event stream.

    Operation description

    Updates the basic information, event source, event filtering pattern, or event target for an event stream.

    Try it now

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

    Test

    RAM authorization

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

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EventStreamingName

    string

    Yes

    The name of the event stream.

    myeventstreaming
    Description

    string

    No

    The description of the event stream.

    rocketmq2mns
    FilterPattern

    string

    Yes

    The event filtering rule. If you do not specify this parameter, all events are matched. For more information, see Event patterns.

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

    object

    Yes

    The event provider. Select one and only one of the following sources.

    SourceMNSParameters

    object

    No

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

    RegionId

    string

    No

    The region ID.

    cn-hangzhou
    QueueName

    string

    No

    The queue name.

    queue_api_1642474203601
    IsBase64Decode

    boolean

    No

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

    true
    SourceRabbitMQParameters

    object

    No

    The ApsaraMQ for RabbitMQ 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 vhost name of the ApsaraMQ for RabbitMQ instance.

    eb-connect

    QueueName

    string

    No

    The queue name of the ApsaraMQ for RabbitMQ instance.

    demo
    SourceKafkaParameters

    object

    No

    The Kafka event source.

    RegionId

    string

    No

    The region ID.

    cn-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 type. Default value: Default.

    Default
    VpcId

    string

    No

    The ID of the 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 method. Valid values: a. `Json`: Decodes the bytes as a UTF-8 string and then parses it as a JSON object. b. `Text`: Decodes the bytes as a UTF-8 string and places it directly into the payload. c. `Binary`: Encodes the bytes as a Base64 string and places it into the payload.

    Text
    SourceRocketMQParameters

    object

    No

    The ApsaraMQ for RocketMQ event source.

    RegionId

    string

    No

    The region ID of the ApsaraMQ for RocketMQ instance.

    cn-shanghai
    InstanceId

    string

    No

    The 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 message filter tag.

    test
    Offset

    string

    No

    The consumer offset. Valid values:

    • CONSUMEFROMLASTOFFSET: Consumes messages from the latest offset.

    • CONSUMEFROMFIRSTOFFSET: Consumes messages from the earliest offset.

    • CONSUMEFROMTIMESTAMP: Consumes messages from a specified timestamp.

    Default value: CONSUMEFROMLASTOFFSET.

    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 `Offset` is set to `CONSUMEFROMTIMESTAMP`.

    1670656652009
    InstanceType

    string

    No

    The instance type.

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

    PublicNetwork PrivateNetwork

    PublicNetwork
    BodyDataType

    string

    No

    The message encoding format:

    • Json

    • Text

    • Binary

    Json
    FilterType

    string

    No

    The message filtering 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.

    • PublicNetwork

    • PrivateNetwork

    PublicNetwork

    SourceRocketMQCheckpointParameters

    object

    No

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

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

    array

    No

    The topics of the ApsaraMQ for RocketMQ instance.

    string

    No

    The topic of the ApsaraMQ for RocketMQ instance.

    myTopic
    SourceApacheRocketMQCheckpointParameters

    object

    No

    The Apache RocketMQ checkpoint source.

    RegionId

    string

    No

    The region ID.

    cn-hangzhou
    Topics

    array

    No

    The topics 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 for the Apache RocketMQ instance.

    admin
    InstancePassword

    string

    No

    The password for the Apache RocketMQ instance.

    ****
    NetworkType

    string

    No

    The network type.

    • PublicNetwork

    • PrivateNetwork

    PrivateNetwork
    VpcId

    string

    No

    The 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 MQTT 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:

    • JSON

    • Text

    • Binary

    JSON
    SourceDTSParameters

    object

    No

    The DTS event source.

    TaskId

    string

    No

    The task ID.

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

    string

    No

    The network address and port of the change tracking channel.

    无
    Topic

    string

    No

    The subscription topic of the change tracking channel.

    LTC_CACHE_PRD
    Sid

    string

    No

    The consumer group ID.

    hkprdb
    Username

    string

    No

    The username of the consumer group.

    admin
    Password

    string

    No

    The password for the consumer group account.

    admin
    InitCheckPoint

    integer

    No

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

    1620962769
    SourceSLSParameters

    object

    No

    The Simple Log Service (SLS) event source.

    RoleName

    string

    No

    The RAM role used by EventBridge to read logs from SLS. When you create the role in the RAM console, select `Alibaba Cloud Service` for the trusted entity and `EventBridge` for the trusted service.

    testRole

    SourcePrometheusParameters

    object

    No

    The Prometheus 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 name of the task role.

    test-role

    ExternalLabels

    string

    No

    The external labels to be added to the event stream.

    {"env":"test"}
    SourceCustomizedKafkaParameters

    object

    No

    The custom Kafka event source.

    InstanceId

    string

    No

    The ID of the Kafka instance.

    r-8vb64581862c****

    SourceCustomizedKafkaConnectorParameters

    object

    No

    The custom Apache Kafka connector event source.

    ConnectorPackageUrl

    string

    No

    The download URL of the OSS resource ZIP package.

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

    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

    SslTruststoreCertificates

    string

    No

    SourceOSSParameters

    object

    No

    The OSS event source.

    RoleName

    string

    No

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

    eventbridge_oss_role

    BucketName

    string

    No

    The name of the bucket in OSS.

    bucket_abc

    Prefix

    string

    No

    The file path prefix.

    fun/document/

    LoadMode

    string

    No

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

    single

    LoadFormat

    string

    No

    The document loader.

    TextLoader
    Delimiter

    string

    No

    The separator used to identify text chunks in chunk loading mode. The default separator is the line feed `\n`.

    \n
    SourceEventBusParameters

    object

    No

    The EventBus event source.

    EventBusName

    string

    No

    The event bus name.

    my-event-bus
    EventRuleName

    string

    No

    The event rule name.

    my-event-rule
    SourceOpenSourceRabbitMQParameters

    object

    No

    The open source RabbitMQ 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

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

    • PublicNetwork

    • PrivateNetwork

    PrivateNetwork
    AuthType

    string

    No

    The authentication type.

    ACL
    SourceMySQLParameters SourceMySQLParameters

    No

    The MySQL event source.

    SourcePostgreSQLParameters SourcePostgreSQLParameters

    No

    SourceRabbitMQMetaParameters SourceRabbitMQMetaParameters

    No

    SourceRabbitMQMsgSyncParameters SourceRabbitMQMsgSyncParameters

    No

    Sink

    object

    Yes

    The event target. Select one and only one of the following targets.

    SinkMNSParameters

    object

    No

    The Simple Message Queue (formerly MNS) event target.

    QueueName

    object

    No

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

    Value

    string

    No

    The name of the MNS queue.

    MyQueue
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    Body

    object

    No

    The message body.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    IsBase64Encode

    object

    No

    Specifies whether to enable Base64 encoding.

    Value

    string

    No

    Enable Base64 encoding.

    true
    Form

    string

    No

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

    CONSTANT
    Template

    string

    No

    无
    SinkFcParameters

    object

    No

    The Function Compute target.

    ServiceName

    object

    No

    The service name.

    Value

    string

    No

    The service name.

    myService
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    FunctionName

    object

    No

    The function name.

    Value

    string

    No

    The function name.

    mFunction
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not used.

    无
    Concurrency

    object

    No

    The delivery concurrency. Minimum value: 1.

    Value

    string

    No

    The delivery concurrency. Minimum value: 1.

    1
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Qualifier

    object

    No

    The alias of the service to which the function belongs.

    Value

    string

    No

    The alias of the service to which the function belongs.

    LATEST
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    InvocationType

    object

    No

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

    Value

    string

    No

    The invocation type.

    Async
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Body

    object

    No

    The content body to send to the function.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    DataFormat

    object

    No

    The format conversion rule for the event content.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation:

    • ORIGINAL: The complete event.

    • JSONPATH: A partial event.

    • CONSTANT: A constant.

    • TEMPLATE: A template.

    JSONPATH
    Template

    string

    No

    The template style.

    $.data.key

    SinkRabbitMQParameters

    object

    No

    The parameters for the ApsaraMQ for RabbitMQ sink.

    InstanceId

    object

    No

    The target service type is ApsaraMQ for RabbitMQ.

    Value

    string

    No

    The ID of the ApsaraMQ for RabbitMQ instance.

    amqp-cn-2r42e73o****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    VirtualHostName

    object

    No

    The vhost name of the ApsaraMQ for RabbitMQ instance.

    Value

    string

    No

    The vhost name of the ApsaraMQ for RabbitMQ instance.

    rabbit-host

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    TargetType

    object

    No

    The target type.

    Value

    string

    No

    The target type. Valid values:

    • Exchange: The Exchange mode.

    • Queue: The Queue mode.

    Exchange/Queue
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    Exchange

    object

    No

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

    Value

    string

    No

    The name of the exchange in the ApsaraMQ for RabbitMQ instance.

    a_exchange
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    RoutingKey

    object

    No

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

    Value

    string

    No

    The routing rule for the message.

    housekeeping
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    QueueName

    object

    No

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

    Value

    string

    No

    The name of the queue in the instance.

    MyQueue
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Body

    object

    No

    The message body.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    MessageId

    object

    No

    The message ID.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    Properties

    object

    No

    The filter properties.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    SinkKafkaParameters

    object

    No

    The parameters for the Kafka sink.

    InstanceId

    object

    No

    The target service type is Kafka.

    Value

    string

    No

    The instance ID.

    Defaut_1283278472_s****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    CompressionType

    string

    No

    Topic

    object

    No

    The topic name.

    Value

    string

    No

    The topic name.

    test
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    Headers

    object

    No

    The additional metadata for the Kafka message.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }

    Form

    string

    No

    The format of the transformation:

    • ORIGINAL: The complete event.

    • JSONPATH: A partial event.

    • CONSTANT: A constant.

    • TEMPLATE: A template.

    CONSTANT
    Template

    string

    No

    The template style.

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

    object

    No

    The acknowledgment mode for writing to Kafka:

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

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

    • acks=all: A response is returned only after the primary node successfully writes the data and the secondary nodes have synchronized it. This mode offers lower performance but higher data security. Data is lost only if both the primary and secondary nodes go down.

    Value

    string

    No

    The acknowledgment mode for writing to Kafka:

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

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

    • acks=all: A response is returned only after the primary node successfully writes the data and the secondary nodes have synchronized it. This mode offers lower performance but higher data security. Data is lost only if both the primary and secondary nodes go down.

    1
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    Key

    object

    No

    The message identifier.

    Value

    string

    No

    The message identifier.

    key
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    Value

    object

    No

    The message body content.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    SinkApacheKafkaParameters

    object

    No

    The parameters for the Apache Kafka sink.

    Bootstraps

    string

    No

    Topic

    string

    No

    Acks

    string

    No

    Key

    object

    No

    Value

    string

    No

    Form

    string

    No

    Template

    string

    No

    Value

    object

    No

    Value

    string

    No

    Form

    string

    No

    Template

    string

    No

    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

    SslTruststoreCertificates

    string

    No

    SinkRocketMQParameters

    object

    No

    The parameters for the ApsaraMQ for RocketMQ sink.

    InstanceId

    object

    No

    The target service type is ApsaraMQ for RocketMQ.

    Value

    string

    No

    The ID of the ApsaraMQ for RocketMQ instance.

    MQ_INST_164901546557****_BAAN****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Topic

    object

    No

    The topic of the ApsaraMQ for RocketMQ instance.

    Value

    string

    No

    The topic of the ApsaraMQ for RocketMQ instance.

    Mytopic
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Body

    object

    No

    The message body.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    Properties

    object

    No

    The filter properties.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    Keys

    object

    No

    The filter properties.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    object

    No

    The filter properties.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    InstanceType

    object

    No

    The instance type.

    Value

    string

    No

    The instance type. Valid values:

    • Cloud_4: Alibaba Cloud RocketMQ 4.0 instance (default)

    • Cloud_5: Alibaba Cloud RocketMQ 5.0 instance

    • SelfBuilt: Self-managed Apache RocketMQ cluster

    Cloud_4

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not applicable.

    无
    InstanceEndpoint

    object

    No

    The instance endpoint.

    Value

    string

    No

    The instance endpoint.

    vbr-8vbsvkkbpf3vb0zef****

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not used.

    无
    InstanceUsername

    object

    No

    The instance username.

    Value

    string

    No

    The instance username.

    admin
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    InstancePassword

    object

    No

    The instance password.

    Value

    string

    No

    The instance password.

    admin****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    VpcId

    object

    No

    The VPC ID.

    Value

    string

    No

    The VPC ID.

    vbr-8vb835n3zf9shwlvb****
    Form

    string

    No

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

    CONSTANT
    Template

    string

    No

    无
    VSwitchIds

    object

    No

    The vSwitch ID.

    Value

    string

    No

    The vSwitch ID.

    vbr-8vb835n3zf9shwl****mp
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    SecurityGroupId

    object

    No

    The security group ID.

    Value

    string

    No

    The security group ID.

    b4bf375515f6440f942e3a20c33d****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not used.

    无
    Network

    object

    No

    The network type.

    • PublicNetwork

    • PrivateNetwork

    Value

    string

    No

    The network type.

    • PublicNetwork

    • PrivateNetwork

    PublicNetwork
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    DeliveryOrderType

    object

    No

    The delivery order type for messages. This is an optional parameter. The default is concurrent delivery.

    Value

    string

    No

    The delivery order type.

    • Orderly: Sequential delivery

    • Concurrently: Concurrent delivery

    Concurrently
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    ShardingKey

    object

    No

    The sharding key for the message.

    Note

    When DeliveryOrderType is set to Orderly, this is the event content conversion rule for the ShardingKey property when writing messages downstream. If the source is RocketMQ, ShardingKey can be left empty. In this case, the upstream BrokerName and QueueId are concatenated to form the message's ShardingKey.

    Value

    string

    No

    The sharding key value.

    order_id
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    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

    The parameters for the ApsaraMQ for RocketMQ checkpoint sink.

    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

    The topic of the ApsaraMQ for RocketMQ instance.

    Value

    string

    No

    The name of the topic in the ApsaraMQ for RocketMQ instance.

    Mytopic
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    ConsumeTimestamp

    object

    No

    The timestamp when the message is consumed.

    Value

    string

    No

    The timestamp.

    1570761026400
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    Group

    object

    No

    The group ID of the consumer group.

    Value

    string

    No

    The group ID.

    GID_EVENTBRIDGE_1736234******
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    SinkApacheRocketMQCheckpointParameters

    object

    No

    The parameters for the Apache RocketMQ checkpoint sink.

    Topic

    object

    No

    The topic of the RocketMQ instance.

    Value

    string

    No

    The name of the topic in the RocketMQ instance.

    Mytopic
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    ConsumeTimestamp

    object

    No

    The timestamp when the message is consumed.

    Value

    string

    No

    The timestamp.

    1570761026400
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    Group

    object

    No

    The group ID of the consumer group.

    Value

    string

    No

    The group ID.

    GID_EVENTBRIDGE_1736234******
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

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

    ****
    NetworkType

    string

    No

    The network type.

    • PublicNetwork

    • PrivateNetwork

    PrivateNetwork
    VpcId

    string

    No

    The ID of the VPC.

    vpc-2zeccak5pb0j3ay******
    VSwitchId

    string

    No

    The vSwitch ID.

    vsw-uf62oqt1twuevrt******
    SecurityGroupId

    string

    No

    The security group ID.

    sg-2ze5bmpw6adn0q******
    SinkSLSParameters

    object

    No

    The parameters for the SLS sink.

    Project

    object

    No

    The SLS project.

    Value

    string

    No

    The SLS project.

    test-project

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not supported.

    无
    LogStore

    object

    No

    The SLS Logstore.

    Value

    string

    No

    The SLS Logstore.

    test-logstore

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    No description is available.

    无
    Topic

    object

    No

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

    Value

    string

    No

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

    testTopic
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    无
    Body

    object

    No

    The content sent to SLS.

    Value

    string

    No

    The value before the transformation.

    { "key": "value" }
    Form

    string

    No

    The format of the transformation.

    TEMPLATE
    Template

    string

    No

    The template style.

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

    object

    No

    The RAM role used by EventBridge to read logs from SLS. When you create the role in the RAM console, select `Alibaba Cloud Service` for the trusted entity and `EventBridge` for the trusted service.

    Value

    string

    No

    The RAM role used by EventBridge to read logs from SLS. When you create the role in the RAM console, select `Alibaba Cloud Service` for the trusted entity and `EventBridge` for the trusted service.

    testRole
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    ContentType

    object

    No

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

    • JSON

    • KeyValue

    Value

    string

    No

    The SLS data format.

    JSON
    Form

    string

    No

    The format of the transformation.

    CONSTANT

    Template

    string

    No

    The template style.

    无
    ContentSchema

    object

    No

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

    Value

    string

    No

    The custom key-value pair.

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

    string

    No

    The format of the transformation.

    CONSTANT

    Template

    string

    No

    The template style.

    无
    SinkFnfParameters

    object

    No

    The parameters for the Fnf sink.

    FlowName

    object

    No

    The flow name.

    Value

    string

    No

    The flow name.

    test-streaming-fnf

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    ExecutionName

    object

    No

    The execution name.

    Value

    string

    No

    The execution name.

    123
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    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 format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    RoleName

    object

    No

    The role configuration.

    Value

    string

    No

    The role configuration.

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

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    SinkPrometheusParameters

    object

    No

    The parameters for the Prometheus sink.

    URL

    object

    No

    The Prometheus Remote Write URL.

    Value

    string

    No

    The Prometheus Remote Write URL.

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

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not used.

    无
    HeaderParameters

    object

    No

    The data structure for the request header parameters.

    Value

    string

    No

    • If `Form` is `CONSTANT`: A constant value.

    • If `Form` is `JSONPATH`: The content extracted using a JSONPath expression.

    • If `Form` is `TEMPLATE`: A template variable.

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

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

    string

    No

    The format of the transformation.

    Valid values:

    • JSONPATH

    • CONSTANT

    • TEMPLATE

    TEMPLATE
    Template

    string

    No

    The HTTP request header template style. This is required when `Form` is `TEMPLATE`. The transformed event content must be in JSON format.

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

    object

    No

    The authentication method.

    Value

    string

    No

    The authentication method.

    BASIC_AUTH
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    Username

    object

    No

    The username.

    Value

    string

    No

    The username.

    ***admin
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    Password

    object

    No

    The password.

    Value

    string

    No

    The password.

    abc
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    Data

    object

    No

    The metric content.

    Value

    string

    No

    The metric content.

    $.data
    Form

    string

    No

    The format of the transformation. Default value: JSONPATH.

    JSONPATH
    Template

    string

    No

    无
    NetworkType

    object

    No

    The network type.

    Value

    string

    No

    The network type:

    • PublicNetwork

    • PrivateNetwork

    PrivateNetwork
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not used.

    无
    VpcId

    object

    No

    The VPC ID.

    Value

    string

    No

    The VPC ID.

    vpc-adw1awdw*****
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    VSwitchId

    object

    No

    The vSwitch ID.

    Value

    string

    No

    The vSwitch ID.

    vsw-dwaafds****

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    None

    无
    SecurityGroupId

    object

    No

    The security group ID.

    Value

    string

    No

    The security group ID.

    sg-mw43*****

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is not supported.

    无
    SinkDataHubParameters

    object

    No

    The parameters for the DataHub sink.

    Project

    object

    No

    The DataHub project name.

    Value

    string

    No

    The DataHub project name.

    demo-project

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    This parameter is ignored.

    无
    Topic

    object

    No

    The DataHub topic name.

    Value

    string

    No

    The DataHub topic name.

    demo-topic
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    TopicType

    object

    No

    The topic type.

    • TUPLE

    • BLOB

    Value

    string

    No

    The topic type.

    • TUPLE

    • BLOB

    TUPLE
    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT
    Template

    string

    No

    Not applicable.

    无
    TopicSchema

    object

    No

    The content schema for the TUPLE topic type.

    Value

    string

    No

    The content schema for the TUPLE topic type.

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

    string

    No

    The format of the transformation.

    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 format of the transformation.

    ORIGINAL
    Template

    string

    No

    None

    无
    RoleName

    object

    No

    The name of the task role.

    Value

    string

    No

    The name of the task role.

    test-role

    Form

    string

    No

    The format of the transformation. Default value: CONSTANT.

    CONSTANT

    Template

    string

    No

    Not applicable.

    无
    ContentType

    object

    No

    The data format. You can use the default or specify a key-value pair:

    • JSON

    • KeyValue

    Value

    string

    No

    The value before the transformation.

    JSON
    Form

    string

    No

    The format of the transformation.

    CONSTANT
    Template

    string

    No

    The template style.

    无
    ContentSchema

    object

    No

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

    Value

    string

    No

    The value before the 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.

    无
    SinkCustomizedKafkaParameters

    object

    No

    The parameters for the Kafka sink.

    InstanceId

    string

    No

    The ID of the Kafka instance.

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

    object

    No

    The parameters for the Kafka connector sink.

    ConnectorPackageUrl

    string

    No

    The download URL of the OSS file.

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

    object

    No

    Parses the properties file in the current ZIP package.

    Name

    string

    No

    The 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 parameters for the DashVector sink.

    InstanceId

    string

    No

    The instance ID.

    vrs-cn-lbj3ru1***
    Collection

    string

    No

    The collection name.

    collection1
    ApiKey

    string

    No

    The API key created in the DashVector console.

    Q34nExQH7sQ****
    Operation

    string

    No

    The operation type for the DashVector database.

    • Delete

    • Upsert

    Upsert
    Network

    string

    No

    The network type.

    • PrivateNetwork

    • PublicNetwork

    PublicNetwork
    PrimaryKeyId

    object

    No

    The primary key ID for inserting or deleting records. If this field is not filled, a random primary key ID is used.

    Form

    string

    No

    The format of the transformation. Valid values:

    • JSONPATH

    • TEMPLATE

    JSONPATH
    Value

    string

    No

    If `Form` is `JSONPATH`: The content extracted using a JSONPath expression. If `Form` is `TEMPLATE`: A template variable.

    Note

    The `Value` field cannot exceed 10,240 characters.

    $.data.requestId
    Template

    string

    No

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

    ${ID}
    Partition

    object

    No

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

    Form

    string

    No

    The format of the transformation. Valid values:

    • JSONPATH

    • CONSTANT

    CONSTANT

    Value

    string

    No

    • If `Form` is `CONSTANT`: A constant value.

    • If `Form` is `JSONPATH`: The content extracted using a JSONPath expression.

    Note

    The `Value` field cannot exceed 10,240 characters.

    default
    Template

    string

    No

    无

    Vector

    object

    No

    The vector for the record to be inserted into DashVector.

    Form

    string

    No

    The format of the transformation.

    JSONPATH
    Value

    string

    No

    The content extracted using a JSONPath expression.

    Note

    The `Value` field cannot exceed 10,240 characters.

    $.data.messageBody
    Template

    string

    No

    This parameter is not used.

    无
    DashVectorSchemaParameters

    array<object>

    No

    The schema field definitions for table items when inserting into DashVector. The transformed event content must be in JSON format.

    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

    The parameters for the open source RabbitMQ sink.

    Endpoint

    string

    No

    The endpoint.

    192.168.1.1:9876
    VirtualHostName

    string

    No

    The virtual host name of the RabbitMQ instance.

    Vhost1
    TargetType

    string

    No

    The target type for message delivery.

    • Exchange: Messages are routed through an exchange.

    • Queue: Messages are delivered directly to a specified queue.

    Exchange
    Exchange

    string

    No

    The name of the exchange in RabbitMQ. This is effective only when `TargetType` is set to `Exchange`.

    my-exchange
    QueueName

    string

    No

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

    my-queue
    Username

    string

    No

    The username to access the RabbitMQ instance.

    admin
    Password

    string

    No

    The password to access the RabbitMQ instance.

    ****
    VpcId

    string

    No

    The VPC ID.

    vpc-uf6of9452b2pba82c ****
    VSwitchIds

    string

    No

    The vSwitch ID.

    vsw-uf6of9452b2pba82c ****
    SecurityGroupId

    string

    No

    The security group ID.

    sg-uf6of9452b2pba82c ****
    NetworkType

    string

    No

    The network type.

    • PrivateNetwork

    • PublicNetwork

    PublicNetwork

    AuthType

    string

    No

    The authentication type:

    • ACL

    • No configuration required

    ACL
    RoutingKey

    object

    No

    The message routing key.

    Form

    string

    No

    The transformation format. Default value: CONSTANT.

    CONSTANT
    Value

    string

    No

    The routing key value.

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

    string

    No

    The template style.

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

    object

    No

    The message body content.

    Form

    string

    No

    The transformation format. Default value: CONSTANT.

    CONSTANT
    Value

    string

    No

    The raw data value.

    {"key": "value"}
    Template

    string

    No

    The template style.

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

    object

    No

    The unique identifier of the message.

    Form

    string

    No

    The transformation format. Default value: CONSTANT.

    CONSTANT
    Value

    string

    No

    The message ID value.

    12345
    Template

    string

    No

    The template style.

    无
    Properties

    object

    No

    The additional properties of the message.

    Form

    string

    No

    The transformation format. Default value: CONSTANT.

    CONSTANT
    Value

    string

    No

    The property content.

    {"env": "prod"}
    Template

    string

    No

    The template style.

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

    No

    The parameters for the BaiLian sink.

    SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

    No

    SinkHttpsParameters

    SinkHttpsParameters

    No

    SinkApiDestinationParameters

    SinkApiDestinationParameters

    No

    SinkOSSParameters SinkOSSParameters

    No

    SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

    No

    SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

    No

    RunOptions

    object

    No

    The runtime environment parameters.

    MaximumTasks

    integer

    No

    The number of concurrent tasks.

    2
    ErrorsTolerance

    string

    No

    The fault tolerance policy: `NONE` (no tolerance) or `ALL` (tolerate all exceptions).

    ALL
    RetryStrategy

    object

    No

    The retry policy for failed event pushes.

    PushRetryStrategy

    string

    No

    The retry policy: `BACKOFF_RETRY` (backoff retry) or `EXPONENTIAL_DECAY_RETRY` (exponential decay retry).

    BACKOFF_RETRY
    MaximumEventAgeInSeconds

    integer

    No

    The maximum retry time.

    512
    MaximumRetryAttempts

    integer

    No

    The maximum number of retries.

    2
    DeadLetterQueue

    object

    No

    Specifies whether to enable the dead-letter queue. By default, the dead-letter queue is disabled, and 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

    The network type of the dead-letter queue.

    • PrivateNetwork

    • PublicNetwork

    PrivateNetwork
    VpcId

    string

    No

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

    vpc-2zehizpoendb3****
    VSwitchIds

    string

    No

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

    vsw-m5ev8asdc6h12345****
    SecurityGroupId

    string

    No

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

    sg-2vcgdxz7o1n9zapp****
    BatchWindow

    object

    No

    The batch window.

    CountBasedWindow

    integer

    No

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

    100
    TimeBasedWindow

    integer

    No

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

    10
    BusinessOption

    object

    No

    BusinessMode

    string

    No

    MinCapacityUnitCount

    integer

    No

    MaxCapacityUnitCount

    integer

    No

    Throttling

    integer

    No

    Transforms

    array<object>

    No

    The transform configurations.

    object

    No

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

    Arn

    string

    No

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

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

    DashScopeTransformParameters

    No

    BaiLianAgentTransformParameters

    BaiLianAgentTransformParameters

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The response information.

    Message

    string

    The error message.

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

    string

    The unique identifier generated by Alibaba Cloud for the request.

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

    string

    The return code of the API. `Success` indicates a successful operation. Other values indicate an error. For details about error codes, see Error codes.

    Success
    Success

    boolean

    Returns `true` if the operation is successful.

    true

    Examples

    Success response

    JSON format

    {
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "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.