All Products
Search

This Product

    EventBridge:GetEventStreaming

    Document Center

    EventBridge:GetEventStreaming

    Last Updated:Feb 03, 2026

    Retrieves the details of an event stream.

    Operation description

    Retrieves the details of an event stream.

    Try it now

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

    Test

    RAM authorization

    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 for which you want to retrieve details.

    myeventstreaming

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned information.

    Message

    string

    The error message.

    The event streaming [xxxx] not existed!
    RequestId

    string

    The unique identifier that Alibaba Cloud generates for the request.

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

    object

    The returned data.

    EventStreamingName

    string

    The name of the event stream.

    rocketmq-sync
    Description

    string

    The description of the event stream.

    RocketMQ-to-RocketMQ
    Source

    object

    The event provider.

    SourceMNSParameters

    object

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

    RegionId

    string

    The region ID.

    cn-hangzhou
    QueueName

    string

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

    demo
    IsBase64Decode

    boolean

    Indicates whether Base64 decoding is enabled.

    true
    SourceRabbitMQParameters

    object

    The ApsaraMQ for RabbitMQ source.

    RegionId

    string

    The region ID.

    cn-hangzhou
    InstanceId

    string

    The ID of the ApsaraMQ for RabbitMQ instance.

    i-f8z9a9mcgwri1c1i****
    VirtualHostName

    string

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

    eb-connect
    QueueName

    string

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

    comp
    SourceRocketMQParameters

    object

    The ApsaraMQ for RocketMQ source.

    RegionId

    string

    The region ID of the ApsaraMQ for RocketMQ instance.

    cn-hangzhou
    InstanceId

    string

    The ID of the ApsaraMQ for RocketMQ instance.

    i-f8zbher64dlm58pl****
    Topic

    string

    The message topic.

    topic_add_anima
    Tag

    string

    The message filtering tag.

    v1
    Offset

    string

    The consumer offset. Valid values: CONSUME_FROM_LAST_OFFSET: Start consumption from the latest offset. CONSUME_FROM_FIRST_OFFSET: Start consumption from the earliest offset. CONSUME_FROM_TIMESTAMP: Start consumption from the offset at a specified point in time.

    CONSUMEFROMLASTOFFSET
    GroupID

    string

    The group ID of the ApsaraMQ for RocketMQ instance.

    GID_group1
    Timestamp

    integer

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

    1636597951964
    InstanceType

    string

    The instance type. Valid values:

    • Cloud_4: Alibaba Cloud ApsaraMQ for RocketMQ 4.0 instance (default)

    • Cloud_5: Alibaba Cloud ApsaraMQ for RocketMQ 5.0 instance

    • SelfBuilt: Self-managed Apache RocketMQ cluster

    Cloud_4

    InstanceEndpoint

    string

    The instance endpoint.

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

    AuthType

    string

    The authentication type.

    ACL
    InstanceUsername

    string

    The instance username.

    xxxa
    InstancePassword

    string

    The instance password.

    xxxa
    InstanceVpcId

    string

    The VPC information of the instance.

    vpc-m5e3sv4b12345****

    InstanceVSwitchIds

    string

    The vSwitch information of the instance.

    vsw-m5ev8asdc6h12****

    InstanceSecurityGroupId

    string

    The security group information of the instance.

    sg-m5edtu24f12345****

    InstanceNetwork

    string

    The network information of the instance:

    • PublicNetwork

    • PrivateNetwork

    PublicNetwork
    BodyDataType

    string

    The message encoding format:

    • Json

    • Text

    • Binary

    Json
    FilterType

    string

    The message filtering type.

    Tag

    FilterSql

    string

    The SQL filter statement.

    index > 10
    VpcId

    string

    The VPC ID.

    vpc-m5e3sv4b12345****

    VSwitchIds

    string

    The vSwitch ID.

    vsw-m5ev8asdc6h12345****

    SecurityGroupId

    string

    The security group ID.

    sg-m5edtu24f12345****

    Network

    string

    The network type.

    • PublicNetwork

    • PrivateNetwork

    PublicNetwork
    SourceRocketMQCheckpointParameters

    object

    The ApsaraMQ for RocketMQ Checkpoint source.

    RegionId

    string

    The region ID.

    cn-hangzhou
    InstanceType

    string

    The instance type. Valid values:

    • Cloud_4: Alibaba Cloud ApsaraMQ for RocketMQ 4.0 instance (default)

    • Cloud_5: Alibaba Cloud ApsaraMQ for RocketMQ 5.0 instance

    • SelfBuilt: Self-managed Apache RocketMQ cluster

    Cloud_4
    InstanceId

    string

    The instance ID.

    rmp-cn-jte3w******

    Topics

    array

    The message topic.

    string

    The message topic.

    opic_add_anima
    SourceApacheRocketMQCheckpointParameters

    object

    The Apache RocketMQ Checkpoint source.

    RegionId

    string

    The region ID.

    cn-hangzhou

    InstanceId

    string

    The RocketMQ instance ID.

    MQ_INST_164901546557****_BAAN****
    Topics

    array

    The list of topics.

    string

    The list of topics to consume.

    ["Topic_1","Topic_2"]
    InstanceEndpoint

    string

    The instance endpoint.

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

    string

    The instance username.

    admin
    InstancePassword

    string

    The instance password.

    123456
    NetworkType

    string

    The network type.

    PrivateNetwork
    VpcId

    string

    The VPC ID.

    vpc-adw1awdw*****
    VSwitchId

    string

    The vSwitch ID.

    vsw-dwaafds****
    SecurityGroupId

    string

    The security group ID.

    sg-mw43*****
    SourceKafkaParameters

    object

    The ApsaraMQ for Kafka source.

    RegionId

    string

    The region ID of the instance.

    cn-hangzhou
    InstanceId

    string

    The instance ID.

    i-bp1fbtrnqmjvgq66****
    Topic

    string

    The topic name.

    topic_empower_1642473600414
    ConsumerGroup

    string

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

    GID_TEST
    OffsetReset

    string

    The offset.

    latest
    Network

    string

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

    Default
    VpcId

    string

    The VPC ID.

    vpc-2zehizpoendb3****
    VSwitchIds

    string

    The vSwitch ID.

    vsw-wz9qqeovkwjxlu9uc****
    SecurityGroupId

    string

    The security group ID.

    sg-2vcgdxz7o1n9zapp****
    ValueDataType

    string

    The encoding format. Valid values:

    1. JSON: The bytes are decoded as a string in UTF-8 and parsed as JSON.

    2. Text: The bytes are decoded as a string in UTF-8 and placed directly into the payload.

    3. Binary: The bytes are encoded as a string in Base64 and placed into the payload.

    Text
    SourceMQTTParameters

    object

    The ApsaraMQ for MQTT source.

    RegionId

    string

    The region ID.

    cn-shanghai
    InstanceId

    string

    The instance ID.

    i-2ze06wqdwk0uq14k****
    Topic

    string

    The topic name.

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

    string

    The message encoding format:

    • JSON

    • Text

    • Binary

    JSON
    SourceDTSParameters

    object

    The Data Transmission Service (DTS) source.

    TaskId

    string

    The task ID.

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

    string

    The network address and port number of the change tracking channel.

    无
    Topic

    string

    The subscription topic of the change tracking channel.

    TP_TEST_UNDERWRITE_ISSUE
    Sid

    string

    The consumer group ID.

    HD1
    Username

    string

    The account of the consumer group.

    admin
    Password

    string

    The password for the consumer group account.

    admin****
    InitCheckPoint

    string

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

    1620962769
    SourceSLSParameters

    object

    The Simple Log Service (SLS) source.

    Project

    string

    The project in Simple Log Service (SLS).

    dmmzk
    LogStore

    string

    The Logstore in Simple Log Service (SLS).

    waf-logstore
    ConsumerGroup

    string

    The consumer group.

    无
    ConsumePosition

    string

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

    begin
    RoleName

    string

    The RAM role that grants EventBridge the permissions to read logs from SLS. When you create this role in the RAM console, you must select Alibaba Cloud Service for the trusted entity and EventBridge for the trusted service.

    testRole
    SourcePrometheusParameters

    object

    The Prometheus event source.

    RegionId

    string

    The region ID.

    cn-hangzhou
    ClusterId

    string

    The cluster ID.

    c83555068b6******ad213f565f209

    DataType

    string

    The data type.

    Json
    Labels

    string

    The labels.

    __name__=.*

    RoleName

    string

    The name of the task role.

    test-role
    ExternalLabels

    string

    The external labels attached to the event stream.

    {"env":"test"}
    SourceCustomizedKafkaParameters

    object

    The custom Kafka event source.

    InstanceId

    string

    The ID of the ApsaraMQ for Kafka instance.

    r-8vb64581862c****

    SourceCustomizedKafkaConnectorParameters

    object

    The custom Apache Kafka connector event source.

    ConnectorPackageUrl

    string

    The download URL for 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

    The connector parameters.

    Name

    string

    The connector name.

    test-name

    Config

    object

    The connector configuration.

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

    object

    The instance configuration.

    { "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }
    SourceApacheKafkaParameters

    object

    Bootstraps

    string

    Topic

    string

    ConsumerGroup

    string

    OffsetReset

    string

    ValueDataType

    string

    VpcId

    string

    VSwitchIds

    string

    SecurityGroupId

    string

    NetworkType

    string

    SecurityProtocol

    string

    SaslMechanism

    string

    SaslUser

    string

    SaslPassword

    string

    SslTruststoreCertificates

    string

    SourceOSSParameters

    object

    The Object Storage Service (OSS) event source.

    RoleName

    string

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

    eventbridge_oss_role

    BucketName

    string

    The name of the bucket in Object Storage Service (OSS).

    bucket_abc

    Prefix

    string

    The file path prefix.

    fun/document/

    LoadMode

    string

    The data loading mode. `single` indicates single-document loading, and `element` indicates chunked loading. Valid values: single/element. Default value: single.

    single

    LoadFormat

    string

    The document loader.

    TextLoader

    Delimiter

    string

    The separator. In chunked loading mode, this separator is used as the chunk identifier for the text. The default separator is a line feed (`\n`).

    \n

    SourceOpenSourceRabbitMQParameters

    object

    The open source RabbitMQ source.

    Endpoint

    string

    The endpoint of the open source RabbitMQ instance.

    192.168.1.100:5672
    VirtualHostName

    string

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

    eb-connect
    QueueName

    string

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

    demo
    BodyDataType

    string

    The message encoding format:

    • JSON

    • Text

    • Binary

    Json
    Username

    string

    The username.

    admin
    Password

    string

    The password.

    ******
    VpcId

    string

    The VPC ID.

    vpc-bp1vllc1lnw1v657******
    VSwitchIds

    string

    The vSwitch ID.

    vsw-uf65zhil5oukof5******
    SecurityGroupId

    string

    The security group ID.

    sg-2ze65razphjfz3******
    NetworkType

    string

    The network type:

    • PublicNetwork: Internet

    • PrivateNetwork: VPC

    PrivateNetwork

    AuthType

    string

    The authentication type.

    ACL
    SourceEventBusParameters

    object

    The EventBridge source.

    EventBusName

    string

    The name of the event bus.

    demo
    EventRuleName

    string

    The name of the event rule.

    test
    SourceMySQLParameters SourceMySQLParameters

    The MySQL source.

    SourcePostgreSQLParameters SourcePostgreSQLParameters

    SourceRabbitMQMetaParameters SourceRabbitMQMetaParameters

    SourceRabbitMQMsgSyncParameters SourceRabbitMQMsgSyncParameters

    FilterPattern

    string

    The event filter pattern. If a pattern is not specified, all events are matched.

    无
    Transforms

    array<object>

    The transform configurations.

    object

    The ARN of the cloud product, such as the ARN of a function in Function Compute.

    Arn

    string

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

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

    DashScopeTransformParameters

    DashScopeTransformParameters

    BaiLianAgentTransformParameters

    BaiLianAgentTransformParameters

    Sink

    object

    The event target.

    SinkMNSParameters

    object

    The Simple Message Queue (formerly MNS) event target.

    QueueName

    object

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

    Value

    string

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

    MyQueue
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The style of the template.

    无
    Body

    object

    The content of the message.

    Value

    string

    The value before the transform.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The template format.

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

    object

    Whether to enable Base64 encoding.

    Value

    string

    Indicates whether Base64 encoding is enabled.

    true
    Form

    string

    The event transformation format. The default is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    SinkRabbitMQParameters

    object

    The parameters of the RabbitMQ sink.

    InstanceId

    object

    The target service type is Message Queue for RabbitMQ.

    Value

    string

    The instance ID of Message Queue for RabbitMQ.

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

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    VirtualHostName

    object

    The name of the virtual host of the Message Queue for RabbitMQ instance.

    Value

    string

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

    rabbit-host

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    TargetType

    object

    The target type.

    Value

    string

    The type of the target. Valid values:

    • Exchange: The Exchange pattern.

    • Queue: The Queue pattern.

    Exchange/Queue
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

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

    Exchange

    object

    The configuration for the exchange. This parameter is required only when the TargetType parameter is set to Exchange.

    Value

    string

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

    a_exchange
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    RoutingKey

    object

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

    Value

    string

    The routing rule for the message.

    housekeeping
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    QueueName

    object

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

    Value

    string

    The name of the instance's queue.

    MyQueue
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

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

    Body

    object

    The message content.

    Value

    string

    The value before transformation.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    object

    The message ID.

    Value

    string

    The value before the transformation.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    object

    The filter properties.

    Value

    string

    The value before the transform.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    SinkFcParameters

    object

    The function target.

    ServiceName

    object

    The name of the service.

    Value

    string

    The name of the service.

    myService
    Form

    string

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

    CONSTANT
    Template

    string

    The format of the template.

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

    FunctionName

    object

    The function name.

    Value

    string

    The function name.

    mFunction
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    Concurrency

    object

    The delivery concurrency. The minimum value is 1.

    Value

    string

    The delivery concurrency. The minimum value is 1.

    1
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

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

    Qualifier

    object

    The service version.

    Value

    string

    The service version.

    LATEST
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    InvocationType

    object

    The invocation type.

    • Sync: Synchronous.

    • Async: Asynchronous.

    Value

    string

    Specifies whether the invocation is synchronous or asynchronous.

    • Sync: Synchronous.

    • Async: Asynchronous.

    Async
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    Body

    object

    The content to send to the function.

    Value

    string

    The value before the transformation.

    { "key": "value" }
    Form

    string

    The transform format:

    • ORIGINAL: complete event

    • JSONPATH: partial event

    • CONSTANT: constant

    • TEMPLATE: template

    For more information, see Event transformation.

    TEMPLATE
    Template

    string

    The format of the template.

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

    DataFormat

    object

    The format transformation rule for the event content.

    Value

    string

    The value before the transform.

    { "key": "value" }
    Form

    string

    The transform format. Valid values:

    • ORIGINAL: complete event

    • JSONPATH: partial event

    • CONSTANT: constant

    • TEMPLATE: template

    JSONPATH
    Template

    string

    The format of the template.

    $.data.key
    SinkKafkaParameters

    object

    The Kafka sink parameters.

    InstanceId

    object

    The target service is Message Queue for Kafka.

    Value

    string

    The instance ID.

    Defaut_1283278472_s****
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

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

    Topic

    object

    The topic name.

    Value

    string

    The topic name.

    test
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    CompressionType

    string

    Acks

    object

    The acknowledgment mode for writing data to Kafka:

    • acks=0: The server does not send a response. This offers high performance with a high risk of data loss.

    • acks=1: The server sends a response after the primary node successfully writes the data. This offers medium performance and a medium risk of data loss. Data can be lost if the primary node goes down.

    • acks=all: The server sends a response only after the primary node writes the data and the secondary nodes synchronize it. This offers low performance but high data safety. Data is lost only if both the primary and secondary nodes go down.

    Value

    string

    The acknowledgment mode for writing data to Kafka:

    • acks=0: The server does not send a response. This mode provides high performance but has a high risk of data loss.

    • acks=1: The server sends a response after the primary node successfully writes the data. This mode provides medium performance and has a medium risk of data loss. Data loss can occur if the primary node goes down.

    • acks=all: The server sends a response only after the primary node successfully writes the data and the secondary nodes complete synchronization. This mode provides low performance but ensures high data security. Data is lost only if both the primary and secondary nodes go down.

    1
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    Key

    object

    The message key.

    Value

    string

    The message key.

    key
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    Headers

    object

    The additional metadata for the Kafka message.

    Value

    string

    The value before transformation.

    { "key": "value" }

    Form

    string

    The transform format. Valid values:

    • ORIGINAL: complete event

    • JSONPATH: partial event

    • CONSTANT: constant

    • TEMPLATE: template

    CONSTANT
    Template

    string

    The template format.

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

    Value

    object

    The message body.

    Value

    string

    The value before transformation.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The template format.

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

    SinkApacheKafkaParameters

    object

    The description.

    Bootstraps

    string

    Topic

    string

    Acks

    string

    CompressionType

    string

    Key

    object

    Value

    string

    Form

    string

    Template

    string

    Headers

    object

    Value

    string

    Form

    string

    Template

    string

    Value

    object

    Value

    string

    Form

    string

    Template

    string

    SecurityProtocol

    string

    SaslMechanism

    string

    SaslUser

    string

    VpcId

    object

    Value

    string

    Form

    string

    Template

    string

    VSwitchIds

    object

    Value

    string

    Form

    string

    Template

    string

    SecurityGroupId

    object

    Value

    string

    Form

    string

    Template

    string

    NetworkType

    object

    Value

    string

    Form

    string

    Template

    string

    SaslPassword

    string

    SslTruststoreCertificates

    string

    SinkRocketMQParameters

    object

    The parameters for the RocketMQ sink.

    InstanceId

    object

    The target service is Message Queue for Apache RocketMQ.

    Value

    string

    The instance ID of ApsaraMQ for RocketMQ.

    MQ_INST_164901546557****_BAAN****
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

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

    Topic

    object

    The topic of the Message Queue for Apache RocketMQ instance.

    Value

    string

    The name of the topic for the Message Queue for Apache RocketMQ instance.

    Mytopic
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

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

    Body

    object

    The message content.

    Value

    string

    The value before the transform.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The template format.

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

    Properties

    object

    Filter properties.

    Value

    string

    The value before transformation.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    Keys

    object

    The filter properties.

    Value

    string

    The value before the transform.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    object

    The filter tags.

    Value

    string

    The value before the transformation.

    { "key": "value" }
    Form

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The template format.

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

    object

    The type of the instance. Valid values:

    • Cloud_4: An Alibaba Cloud RocketMQ 4.0 instance. This is the default option.

    • Cloud_5: An Alibaba Cloud RocketMQ 5.0 instance.

    • SelfBuilt: A self-managed Apache RocketMQ cluster.

    Value

    string

    The instance type. Valid values:

    • Cloud_4: An Alibaba Cloud RocketMQ 4.0 instance. (Default)

    • Cloud_5: An Alibaba Cloud RocketMQ 5.0 instance.

    • SelfBuilt: A self-managed Apache RocketMQ cluster.

    Cloud_4

    Form

    string

    The transformation format. The default is CONSTANT.

    CONSTANT
    Template

    string

    None.

    无
    InstanceEndpoint

    object

    The instance endpoint.

    Value

    string

    The endpoint of the instance.

    vbr-8vbsvkkbpf3vb0zef****

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT

    Template

    string

    None

    无
    InstanceUsername

    object

    The username of the instance.

    Value

    string

    The username of the instance.

    admin

    Form

    string

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

    CONSTANT

    Template

    string

    None.

    无
    InstancePassword

    object

    The instance password.

    Value

    string

    The instance password.

    admin****

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT

    Template

    string

    None

    无

    VpcId

    object

    The ID of the VPC.

    Value

    string

    The VPC ID.

    vbr-8vb835n3zf9shwlvb****

    Form

    string

    The event transformation format. The default is CONSTANT.

    CONSTANT

    Template

    string

    None.

    无

    VSwitchIds

    object

    The vSwitch IDs.

    Value

    string

    The vSwitch ID.

    vbr-8vb835n3zf9shwl****mp

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT

    Template

    string

    Not applicable.

    无

    SecurityGroupId

    object

    The security group ID.

    Value

    string

    The ID of the security group.

    b4bf375515f6440f942e3a20c33d****

    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT

    Template

    string

    None

    无

    Network

    object

    The network type.

    • PublicNetwork

    • PrivateNetwork

    Value

    string

    The network type.

    • PublicNetwork

    • PrivateNetwork

    PublicNetwork

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT

    Template

    string

    None.

    无

    DeliveryOrderType

    object

    The delivery order of messages. This parameter is optional. The default is concurrent delivery.

    Value

    string

    The delivery order type.

    • Orderly: Ordered delivery

    • Concurrently: Concurrent delivery

    Concurrently
    Form

    string

    The format of the transform. The default is CONSTANT.

    CONSTANT
    Template

    string

    The style of the template.

    无
    ShardingKey

    object

    The message sharding key.

    Note

    • This parameter is required if DeliveryOrderType is set to Orderly.

    • If Source is set to RocketMQ, this parameter can be empty. If it is empty, the system concatenates the upstream BrokerName and QueueId to generate the message sharding key.

    Value

    string

    The value of the sharding key.

    order_id
    Form

    string

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

    CONSTANT
    Template

    string

    The template format.

    无
    SinkDorisParameters

    object

    QueryEndpoint

    object

    Value

    string

    Form

    string

    Template

    string

    FeHttpEndpoint

    object

    Value

    string

    Form

    string

    Template

    string

    BeHttpEndpoint

    object

    Value

    string

    Form

    string

    Template

    string

    UserName

    object

    Value

    string

    Form

    string

    Template

    string

    Password

    object

    Value

    string

    Form

    string

    Template

    string

    Database

    object

    Value

    string

    Form

    string

    Template

    string

    Table

    object

    Value

    string

    Form

    string

    Template

    string

    Body

    object

    Value

    string

    Form

    string

    Template

    string

    NetworkType

    object

    Value

    string

    Form

    string

    Template

    string

    VpcId

    object

    Value

    string

    Form

    string

    Template

    string

    VSwitchIds

    object

    Value

    string

    Form

    string

    Template

    string

    SecurityGroupId

    object

    Value

    string

    Form

    string

    Template

    string

    SinkRocketMQCheckpointParameters

    object

    The checkpoint parameters for the RocketMQ sink.

    InstanceType

    string

    The instance type. Valid values:

    • Cloud_4: an Alibaba Cloud Message Queue for Apache RocketMQ 4.0 instance.

    • Cloud_5: an Alibaba Cloud Message Queue for Apache RocketMQ 5.0 instance.

    Cloud_4
    InstanceId

    string

    The instance ID.

    MQ_INST_164901546557****_BAAN****
    Topic

    object

    The topic of the Message Queue for Apache RocketMQ instance.

    Value

    string

    The topic of the Message Queue for Apache RocketMQ instance.

    Mytopic
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    Group

    object

    The Group ID of the consumer group.

    Value

    string

    The group ID.

    GID_EVENTBRIDGE_1736234******
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    ConsumeTimestamp

    object

    The timestamp when the message is consumed.

    Value

    string

    The timestamp.

    1570761026400
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    SinkApacheRocketMQCheckpointParameters

    object

    The checkpoint parameters for the Apache RocketMQ sink.

    Topic

    object

    The topic of the Apache RocketMQ instance.

    Value

    string

    The name of the topic in the Apache RocketMQ instance.

    Mytopic
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

    无
    Group

    object

    The group ID of the consumer group.

    Value

    string

    The group ID.

    GID_EVENTBRIDGE_1736234******

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    ConsumeTimestamp

    object

    The message consumption timestamp.

    Value

    string

    The UNIX timestamp.

    1570761026400
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

    无
    InstanceEndpoint

    string

    The instance endpoint.

    192.168.1.1:9876
    InstanceUsername

    string

    The username required for authentication.

    admin
    InstancePassword

    string

    The password for the username.

    ****
    NetworkType

    string

    The network type.

    PrivateNetwork
    VpcId

    string

    The ID of the virtual private cloud (VPC).

    vpc-2zeccak5pb0j3ay******
    VSwitchId

    string

    The vSwitch ID.

    vsw-uf62oqt1twuevrt******
    SecurityGroupId

    string

    The security group ID.

    sg-2ze5bmpw6adn0q******
    SinkSLSParameters

    object

    The parameters for the SLS sink.

    Project

    object

    The Simple Log Service project.

    Value

    string

    The Simple Log Service (SLS) project.

    test-project

    Form

    string

    The transform format. The default is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    LogStore

    object

    The Simple Log Service (SLS) Logstore.

    Value

    string

    The Logstore in Simple Log Service.

    test-logstore
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The template format.

    无
    Topic

    object

    The topic of the log. This corresponds to the topic reserved field in SLS.

    Value

    string

    The topic of the log. This corresponds to the "topic" reserved field of SLS.

    testTopic
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The format of the template.

    无
    Body

    object

    The content sent to SLS.

    Value

    string

    The value before transformation.

    { "key": "value" }
    Form

    string

    The transform format.

    TEMPLATE
    Template

    string

    The template format.

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

    RoleName

    object

    This role grants EventBridge permissions to read log content from Simple Log Service (SLS). When you create the role in the RAM console, select Alibaba Cloud Service and set Trusted Service to EventBridge.

    Value

    string

    When you create the role in the RAM console, select Alibaba Cloud Service and set the trusted service to EventBridge. This is required to authorize EventBridge to read log content from SLS.

    testRole
    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    The style of the template.

    无
    ContentType

    object

    The data format for Simple Log Service (SLS). Valid values:

    • JSON

    • KeyValue

    Value

    string

    The value before the transform.

    JSON

    Form

    string

    The transform format.

    CONSTANT

    Template

    string

    The template style.

    无
    ContentSchema

    object

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

    Value

    string

    The value before the transform.

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

    string

    The style of the template.

    CONSTANT

    Template

    string

    The format of the template.

    无
    SinkFnfParameters

    object

    The Sink Fnf parameters.

    FlowName

    object

    The name of the flow.

    Value

    string

    The name of the flow.

    test-streaming-fnf
    Form

    string

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

    CONSTANT
    Template

    string

    The template style.

    无
    ExecutionName

    object

    The execution name.

    Value

    string

    The execution name.

    123
    Form

    string

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

    • JSONPATH: partial event.

    • CONSTANT: constant.

    • TEMPLATE: template.

    For more information, see Event transformation.

    CONSTANT
    Template

    string

    The template format.

    无
    Input

    object

    The execution input.

    Value

    string

    The input for the execution.

    123
    Form

    string

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

    CONSTANT
    Template

    string

    The template style.

    无
    RoleName

    object

    The role configuration.

    Value

    string

    The configuration of the role.

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

    string

    The transformation format. The default is CONSTANT.

    CONSTANT
    Template

    string

    The template style.

    无
    SinkDataHubParameters

    object

    The DataHub sink parameters.

    Project

    object

    The name of the DataHub project.

    Value

    string

    The name of the DataHub project.

    demo-project

    Form

    string

    The transform format. The default is CONSTANT.

    CONSTANT

    Template

    string

    None

    无

    Topic

    object

    The name of the DataHub topic.

    Value

    string

    The name of the DataHub topic.

    demo-topic

    Form

    string

    The format of the transformation. The default is CONSTANT.

    CONSTANT
    Template

    string

    None.

    无
    TopicType

    object

    The topic type. Valid values:

    • TUPLE

    • BLOB

    Value

    string

    The topic type.

    • TUPLE

    • BLOB

    TUPLE

    Form

    string

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

    CONSTANT
    Template

    string

    None.

    无
    TopicSchema

    object

    The content pattern for a topic of the TUPLE type.

    Value

    string

    The content pattern of the TUPLE-type topic.

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

    string

    The transformation format.

    TEMPLATE
    Template

    string

    The format of the template.

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

    object

    The template for the record content. The data type is BLOB.

    Value

    string

    The content template for the record. The value is a BLOB.

    无
    Form

    string

    The transformation format.

    ORIGINAL
    Template

    string

    None

    无
    RoleName

    object

    The name of the task role.

    Value

    string

    The name of the task role.

    test-role
    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Template

    string

    None

    无
    SinkCustomizedKafkaParameters

    object

    The parameters for the Kafka sink.

    InstanceId

    string

    The instance ID of Message Queue for Apache Kafka.

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

    object

    The Sink Kafka connector parameters.

    ConnectorPackageUrl

    string

    The download link for 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=rb8q3OpV******"
    ConnectorParameters

    object

    Parses the properties file in the current ZIP package.

    Name

    string

    The connector name.

    mongo-sink
    Config

    object

    The connector configuration.

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

    object

    The instance configuration.

    { "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }
    SinkDashVectorParameters

    object

    The SinkDashVector parameters.

    InstanceId

    string

    The instance ID.

    vrs-cn-lbj3ru1***
    Collection

    string

    The name of the collection.

    collection1
    ApiKey

    string

    The API key created in the DashVector console.

    Q34nExQH7sQ****
    Operation

    string

    The operation type for the DashVector database.

    Upsert
    Network

    string

    The network type.

    PublicNetwork
    PrimaryKeyId

    object

    The primary key ID for inserting or deleting a record. If a value is not specified for this field, a random primary key ID is used.

    Form

    string

    The transformation format.

    JSONPATH
    Value

    string

    • If Form is set to JSONPATH: The JSONPath expression.

    • If Form is set to TEMPLATE: The template variable.

    Note: The Value field cannot exceed 10240 characters.

    $.data.requestId
    Template

    string

    The template for the primary key ID. This parameter is required only when Form is set to TEMPLATE.

    ${ID}
    Partition

    object

    The partition. The default value is the default partition.

    Form

    string

    The transformation format.

    CONSTANT
    Value

    string

    • If Form is set to CONSTANT: The constant value.

    • If Form is set to JSONPATH: The content to fetch using JSONPath.

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

    default
    Template

    string

    None.

    无
    Vector

    object

    The vector to insert into the DashVector record.

    Form

    string

    The transformation format.

    JSONPATH
    Value

    string

    The JSONPath expression to fetch the content.

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

    $.data.messageBody
    Template

    string

    None.

    无
    DashVectorSchemaParameters

    array<object>

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

    array<object>

    Name

    object

    Form

    string

    Value

    string

    Template

    string

    Type

    object

    Form

    string

    Value

    string

    Template

    string

    Value

    object

    Form

    string

    Value

    string

    Template

    string

    SinkOpenSourceRabbitMQParameters

    object

    The parameters for the open source RabbitMQ sink.

    Endpoint

    string

    The endpoint.

    192.168.1.1:9876
    VirtualHostName

    string

    The name of the RabbitMQ virtual host.

    vhost1
    TargetType

    string

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

    Exchange
    Exchange

    string

    The name of the RabbitMQ exchange.

    my-exchange
    QueueName

    string

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

    my-queue
    Username

    string

    The username to access the RabbitMQ instance.

    admin
    Password

    string

    The password to access the RabbitMQ instance.

    ****
    VpcId

    string

    The virtual private cloud (VPC) ID.

    vpc-uf6of9452b2pba82c ****
    VSwitchIds

    string

    The vSwitch ID.

    vsw-uf6of9452b2pba82c ****
    SecurityGroupId

    string

    The security group ID.

    sg-uf6of9452b2pba82c ****
    NetworkType

    string

    The network type.

    PublicNetwork

    AuthType

    string

    The authentication type.

    ACL
    RoutingKey

    object

    The message routing key.

    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Value

    string

    The routing key value.

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

    Template

    string

    The template format.

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

    object

    The message body.

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Value

    string

    The raw data value.

    {"key": "value"}
    Template

    string

    The template format.

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

    object

    The unique identifier of the message.

    Form

    string

    The transform format. The default value is CONSTANT.

    CONSTANT
    Value

    string

    The message ID value.

    12345
    Template

    string

    The template format.

    无
    Properties

    object

    The additional message properties.

    Form

    string

    The transformation format. The default value is CONSTANT.

    CONSTANT
    Value

    string

    The value of the property.

    {"env": "prod"}
    Template

    string

    The format of the template.

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

    SinkBaiLianParameters SinkBaiLianParameters

    The BaiLian sink parameters.

    SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

    SinkHttpsParameters

    SinkHttpsParameters

    SinkApiDestinationParameters

    SinkApiDestinationParameters

    SinkOSSParameters SinkOSSParameters

    SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

    SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

    SinkMQTTParameters SinkMQTTParameters

    RunOptions

    object

    The runtime environment parameters.

    MaximumTasks

    integer

    The number of concurrent tasks.

    2
    RetryStrategy

    object

    The retry policy for failed event pushes.

    PushRetryStrategy

    string

    The retry policy. Valid values are BACKOFF_RETRY (backoff retry) and EXPONENTIALDECAY_RETRY (exponential decay retry).

    BACKOFF_RETRY
    MaximumEventAgeInSeconds

    number

    The maximum retry time.

    512
    MaximumRetryAttempts

    number

    The maximum number of retries.

    2
    ErrorsTolerance

    string

    The error tolerance policy. `NONE` means that no errors are tolerated. `ALL` means that all errors are tolerated.

    ALL
    DeadLetterQueue

    object

    Specifies whether to enable the dead-letter queue. By default, this feature is disabled. If a message cannot be delivered after all retries, it is discarded.

    Arn

    string

    The Alibaba Cloud Resource Name (ARN) of the dead-letter queue.

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

    string

    The network type of the dead-letter queue.

    PrivateNetwork
    VpcId

    string

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

    vpc-2zehizpoendb3****
    VSwitchIds

    string

    The IDs of the virtual switches that contain the dead-letter queue.

    vsw-m5ev8asdc6h12345****
    SecurityGroupId

    string

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

    sg-2vcgdxz7o1n9zapp****
    BatchWindow

    object

    The batch window.

    CountBasedWindow

    integer

    The maximum number of events in the window. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, the push is triggered when the condition of any window is met.

    100
    TimeBasedWindow

    integer

    The maximum duration of the window, in seconds. When this threshold is reached, events in the window are pushed downstream. If multiple windows exist, the push is triggered when any window meets its condition.

    10
    BusinessOption

    object

    BusinessMode

    string

    MinCapacityUnitCount

    integer

    MaxCapacityUnitCount

    integer

    Throttling

    integer

    Status

    string

    The status of the event stream.

    RUNNING
    DetailedStatus

    object

    The detailed status.

    TPS

    number

    The number of transactions processed per second.

    5
    DelayTime

    integer

    The delay time.

    3
    DiffOffset

    integer

    The offset difference.

    0
    Extensions

    object

    The extension properties.

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

    string

    The return code. If the request is successful, Success is returned. If the request fails, an error code is returned. For more information about error codes, see Error codes.

    Success
    Success

    boolean

    Returns true if the operation is successful.

    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.