ListEventStreamings

更新时间:
复制 MD 格式

You can use this operation to retrieve a list of event streams.

Operation description

Queries event streams.

Try it now

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

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:ListEventStreamings

list

*EventStreaming

acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/*

None None

Request parameters

Parameter

Type

Required

Description

Example

NamePrefix

string

No

The prefix of the event stream name.

name

Limit

integer

No

The maximum number of entries to return for each request. You can use this parameter with NextToken to get the next page of results.

Important The maximum value is 100.

10

NextToken

string

No

If the number of results exceeds the value of Limit, a NextToken is returned. Use this token in your next request to retrieve the next page of results.

10

Tags

array<object>

No

The tags that are used to filter event streams.

object

No

The tag.

Key

string

No

The key of the tag.

mns

Value

string

No

The value of the tag.

mnstest

SourceArn

string

No

The Alibaba Cloud Resource Name (ARN) of the event source.

acs:alikafka:cn-hangzhou:118609547428****:instance/alikafka_pre-cn-zxu36kvi****/topic/test-topic

SinkArn

string

No

The ARN of the event target.

acs:fc:cn-hangzhou:118609547428****:services/fw1.LATEST/functions/log1

Response elements

Element

Type

Description

Example

object

The returned data.

Message

string

The error message.

The event streaming [xxxx] not existed!

RequestId

string

The ID of the request.

283FF852-C4B8-58C9-9777-F88A5A16****

Data

object

A list of event streams.

EventStreamings

array<object>

The event streams.

array<object>

The event stream.

EventStreamingName

string

The name of the event stream.

name

Description

string

The description of the event stream.

demo

Source

object

The event source.

SourceMNSParameters

object

The MNS source.

RegionId

string

The ID of the region.

cn-zhangjiakou

QueueName

string

The name of the MNS queue.

work4

IsBase64Decode

boolean

Specifies whether Base64 decoding is enabled.

true

SourceRabbitMQParameters

object

The RabbitMQ source.

RegionId

string

The ID of the region.

cn-zhangjiakou

InstanceId

string

The ID of the RabbitMQ instance.

dbaudit-cn-7mz2hqo****

VirtualHostName

string

The name of the vhost of the RabbitMQ instance.

eb-connect

QueueName

string

The name of the queue in the RabbitMQ instance.

liuyang

SourceRocketMQParameters

object

The RocketMQ source.

RegionId

string

The region ID of the RocketMQ instance.

cn-chengdu

InstanceId

string

The ID of the 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: CONSUMEFROMLASTOFFSET: Start consuming messages from the latest offset. CONSUMEFROMFIRSTOFFSET: Start consuming messages from the earliest offset. CONSUMEFROMTIMESTAMP: Start consuming messages from a specific timestamp.

CONSUMEFROMTIMESTAMP

GroupID

string

The group ID of the RocketMQ instance.

GID_group1

Timestamp

integer

The timestamp. This parameter is valid only if you set Offset to CONSUMEFROMTIMESTAMP.

1670742074043

InstanceType

string

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

InstanceEndpoint

string

The instance endpoint.

registry-vpc.cn-hangzhou.aliyuncs.com

AuthType

string

The authentication type.

ACL

InstanceUsername

string

The instance username.

admin**

InstancePassword

string

The instance password.

123

InstanceVpcId

string

The ID of the VPC.

vpc-bp1a4gmlk31hy***l3ss

InstanceVSwitchIds

string

The vSwitch information of the instance.

vsw-m5ev8asdc6h123456****

InstanceSecurityGroupId

string

The security group information of the instance.

sg-m5edtu24f12345****

InstanceNetwork

string

The network type of the instance. Valid values:

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

BodyDataType

string

The message encoding format. Valid values:

  • JSON

  • Text

  • Binary

JSON

Network

string

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

FilterType

string

The message filtering type.

Tag

FilterSql

string

The SQL filtering 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****

SourceRocketMQCheckpointParameters

object

The RocketMQ checkpoint source.

RegionId

string

The region ID.

cn-hangzhou

InstanceType

string

The type of the RocketMQ instance.

Cloud_5

InstanceId

string

The ID of the RocketMQ instance.

rmq-cn-jte3w******

Topics

array

The topic of the RocketMQ instance.

string

The topic of the RocketMQ instance.

myTopic

SourceApacheRocketMQCheckpointParameters

object

The Apache RocketMQ checkpoint source.

RegionId

string

The region ID.

cn-hangzhou

Topics

array

The topic of the Apache RocketMQ instance.

string

The topic of the Apache RocketMQ instance.

myTopic

InstanceEndpoint

string

The endpoint of the Apache RocketMQ instance.

192.168.1.1:9876

InstanceUsername

string

The username for the Apache RocketMQ instance.

admin

InstancePassword

string

The password for the Apache RocketMQ instance.

****

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 Kafka source.

RegionId

string

The region ID of the instance.

cn-chengdu

InstanceId

string

The instance ID.

bastionhost-cn-i7m2gwt****

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 type. Default value: Default. If the instance is in a VPC, the value is PublicNetwork.

Default

VpcId

string

The VPC ID of the user.

vpc-wz9ki1qdlx3cx5cbf****

VSwitchIds

string

The vSwitch ID.

vsw-bp1rmi8rind7eo50c****

SecurityGroupId

string

The security group ID.

sg-5ud5f3p0rqqis69****eho7cp

ValueDataType

string

The message body encoding format. Valid values:

  • JSON

  • Text

  • Binary

JSON

SourceMQTTParameters

object

The MQTT source.

RegionId

string

The region ID.

cn-qingdao

InstanceId

string

The instance ID.

bastionhost-cn-zvp27kc****

Topic

string

The topic name.

migration_instance

BodyDataType

string

The message encoding format. Valid values:

  • JSON

  • Text

  • Binary

JSON

NetworkType

string

The network type.

VpcId

string

The VPC ID.

VSwitchIds

string

The vSwitch ID.

SecurityGroupId

string

The security group ID.

SourceDTSParameters

object

The DTS source.

TaskId

string

The task ID.

1611b337285f44e2936a2c4170****

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.

HG9

Username

string

The account of the consumer group.

admin

Password

string

The password of the consumer group account.

123456

InitCheckPoint

string

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

1620962769

SourceSLSParameters

object

The SLS source.

Project

string

The project in SLS.

dmmzk

LogStore

string

The Logstore in SLS.

waf-logstore

ConsumerGroup

string

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

go-dts-shelf-group

ConsumePosition

string

The consumer offset. Valid values are begin, end, or a UNIX timestamp in seconds.

begin

RoleName

string

The name of the RAM role that grants EventBridge permissions to read logs from SLS. When you create this role in the RAM console, select **Alibaba Cloud Service** for Trusted Entity and **EventBridge** for Trusted Service.

testRole

SourcePrometheusParameters

object

The Prometheus event source.

RegionId

string

The region ID.

cn-beijing

ClusterId

string

The cluster ID.

c83555068b6******ad213f565f209

DataType

string

The data type.

JSON

Labels

string

The labels.

__name__=.*

RoleName

string

The role used to access Prometheus data.

testRole

ExternalLabels

string

The custom tags attached to the event.

{"source":"prometheus-prod"}

SourceCustomizedKafkaParameters

object

The custom Kafka event source.

InstanceId

string

The instance ID.

gtm-cn-k2c2yfg****

SourceCustomizedKafkaConnectorParameters

object

The custom Apache Kafka connector event source.

ConnectorPackageUrl

string

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

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 Kafka instance configuration.

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

SourceOSSParameters

object

The OSS event source.

RoleName

string

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

The name of the bucket in OSS.

bucket_abc

Prefix

string

The file path prefix.

fun/document/

LoadMode

string

The data loading mode. `single` loads a single document. `element` loads the document in chunks. Valid values: `single` and `element`. Default value: `single`.

single

LoadFormat

string

The document loader.

TextLoader

Delimiter

string

The separator used in chunk loading mode. The default separator is the line feed character (`\n`).

\n

SourceOpenSourceRabbitMQParameters

object

The open source RabbitMQ source.

Endpoint

string

The instance endpoint.

192.168.1.1:9876

VirtualHostName

string

The name of the virtual host of the open source RabbitMQ instance.

Vhost1

QueueName

string

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

demo

BodyDataType

string

The message body data type.

Json

Username

string

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

admin

Password

string

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

****

VpcId

string

The VPC ID.

vpc-m5e3sv4b12345****

VSwitchIds

string

The vSwitch ID.

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

The security group ID.

sg-m5edtu24f12345****

NetworkType

string

The network type.

PrivateNetwork

AuthType

string

The authentication type.

ACL

SourceEventBusParameters

object

The EventBridge source.

EventBusName

string

The event bus name.

my-event-bus

EventRuleName

string

The event rule name.

my-event-rule

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

object

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

Arn

string

The ARN of a 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 MNS event target.

QueueName

object

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

Value

string

The name of the MNS queue.

MyQueue

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Body

object

The message body.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

IsBase64Encode

object

Specifies whether to enable Base64 encoding.

Value

string

Indicates whether Base64 encoding is enabled.

true

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not applicable.

SinkEventHouseParameters

object

The name of the event target.

CatalogName

string

The name of the catalog.

cat1

NamespaceName

string

The name of the namespace.

name1

EventTableName

string

The name of the table.

table1

MappingRules

array<object>

The field mapping rule.

array<object>

The mapping rule.

ColumnValue

object

The rule for extracting the column value.

Value

string

The extraction path.

$.data.value

Form

string

The extraction method.

JSONPATH

Template

string

The template.

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

ColumnName

string

The column name.

age

ColumnType

string

The column type.

text

SinkFcParameters

object

The function target.

ServiceName

object

The name of the service.

Value

string

The name of the service.

myService

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

None.

FunctionName

object

The name of the function.

Value

string

The name of the function.

mFunction

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Concurrency

object

The delivery concurrency. The minimum value is 1.

Value

string

The delivery concurrency. The minimum value is 1.

1

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Qualifier

object

The service alias for the function.

Value

string

The alias of the service to which the function belongs.

LATEST

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

None

InvocationType

object

The invocation type. Valid values:

  • Sync: synchronous

  • Async: asynchronous

Value

string

The invocation can be synchronous or asynchronous. Valid values:

  • Sync: synchronous

  • Async: asynchronous

Async

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This field is not used.

Body

object

The content body sent to the function.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

DataFormat

object

The transformation rule for the event content format.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The format of the template.

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

SinkRabbitMQParameters

object

The parameters for the RabbitMQ sink.

InstanceId

object

The target service is an instance of Message Queue for RabbitMQ.

Value

string

The ID of the RabbitMQ instance.

si-296cd57939a1421b****

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

None

VirtualHostName

object

The vhost name of the RabbitMQ instance.

Value

string

The name of the vhost of the RabbitMQ instance.

rabbit-host

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

TargetType

object

The target type.

Value

string

The target type. Valid values: Exchange: the exchange pattern. Queue: the queue pattern.

Queue

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Exchange

object

The Exchange pattern. This parameter is required only if the TargetType parameter is set to Exchange.

Value

string

The name of the exchange in the RabbitMQ instance.

a_exchange

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

RoutingKey

object

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

Value

string

The routing rule for the message.

housekeeping

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

QueueName

object

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

Value

string

The name of the queue for the instance.

MyQueue

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

Body

object

The message content.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

MessageId

object

The message ID.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

Properties

object

Filter properties.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

SinkKafkaParameters

object

The Kafka sink parameters.

InstanceId

object

The target service is Message Queue for Kafka.

Value

string

The instance ID.

Defaut_1283278472_sad****

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

CompressionType

string

Topic

object

The name of the topic.

Value

string

The topic name.

topic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

DynamicTopic

object

The policy for routing messages to the destination topic. If both `topic` and `topics` are specified, `topics` takes precedence. The following modes are supported: 1. **Static constant mode**: Specify a fixed topic name, such as "order_created". All messages are sent to this topic. 2. **Dynamic extraction mode**: Specify a standard JSONPath expression, such as "$.user.id" or "$.metadata.category". The system parses the upstream message and uses the extracted value as the topic name.

Value

string

The value.

Form

string

The transform type. Valid values: CONSTANT: a fixed value. JSONPATH: extracts a value from the upstream message based on the specified path.

Template

string

The template.

Acks

object

The acknowledgment mode for writing data to Kafka:

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

  • acks=1: The server sends a response after the data is written to the primary node. This mode offers medium performance with 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 data is written to the primary node and synchronized to all secondary nodes. This mode offers low performance but ensures high data security. Data is lost only if the primary node and all 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 offers high performance with a high risk of data loss.

  • acks=1: The server sends a response after the data is written to the primary node. This mode offers medium performance with 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 data is written to the primary node and synchronized to all secondary nodes. This mode offers low performance but ensures high data security. Data is lost only if the primary node and all secondary nodes go down.

1

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Key

object

The identity of the message.

Value

string

Specifies the identity of the message.

key

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Value

object

The content of the message.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

SinkRocketMQParameters

object

The RocketMQ sink.

InstanceId

object

The target service is Message Queue for Apache RocketMQ.

Value

string

The ID of the RocketMQ instance.

MQ_INST_164901546557****_BAAN****

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

Topic

object

The topic of the RocketMQ instance.

Value

string

The topic of the RocketMQ instance.

topic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not returned.

Body

object

The message content.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

Properties

object

The filter properties.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

Keys

object

The filter properties.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

Tags

object

The filter properties.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

InstanceType

object

The instance type.

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-built Apache RocketMQ cluster

Cloud_4

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

InstanceEndpoint

object

The instance endpoint.

Value

string

The instance endpoint.

vbr-8vbsvkkbpf3vb0zef****

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

InstanceUsername

object

The instance username.

Value

string

The instance username.

admin

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

InstancePassword

object

The instance password.

Value

string

The instance password.

admin******

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

None

VpcId

object

The VPC ID.

Value

string

The VPC ID.

vbr-8vb835n3zf9shwlvb****

Form

string

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

CONSTANT

Template

string

Not supported.

VSwitchIds

object

The vSwitch ID.

Value

string

The vSwitch ID.

vbr-8vb835n3zf9shwl****mp

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

SecurityGroupId

object

The security group ID.

Value

string

The security group ID.

b4bf375515f6440f942e3a20c33d****

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not applicable.

Network

object

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork

Value

string

The network type. Valid values:

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

DeliveryOrderType

object

The delivery order type for messages.

Value

string

The delivery order type.

Orderly

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

No description is available.

ShardingKey

object

The sharding key for the message. This key controls message partitioning.

Value

string

The value of the sharding key.

order_id

Form

string

The transform format. Default value: 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 Sink RocketMQ Checkpoint parameters.

InstanceType

string

The instance type of RocketMQ.

Cloud_5

InstanceId

string

The RocketMQ instance ID.

MQ_INST_1825725063814405_BZ******

Topic

object

The topic of the RocketMQ instance.

Value

string

The name of the topic.

myTopic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

Group

object

The consumer group for RocketMQ.

Value

string

The group ID of the consumer group.

GID_******

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

ConsumeTimestamp

object

The consumer offset.

Value

string

The timestamp.

1636597951964

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

SinkApacheRocketMQCheckpointParameters

object

The Sink Apache RocketMQ Checkpoint parameters.

Topic

object

The name of the topic for the Apache RocketMQ instance.

Value

string

The name of the topic.

myTopic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

Group

object

The information about the consumer group for Apache RocketMQ.

Value

string

The Group ID of the consumer group.

GID_******

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

ConsumeTimestamp

object

The consumer offset.

Value

string

The timestamp.

1636597951964

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

InstanceEndpoint

string

The endpoint of the Apache RocketMQ instance.

192.168.1.1:9876

InstanceUsername

string

The username for the Apache RocketMQ instance.

admin

InstancePassword

string

The password for the Apache RocketMQ instance.

****

NetworkType

string

The network type.

PrivateNetwork

VpcId

string

The VPC ID.

vpc-2zehizpoendb3****

VSwitchId

string

The vSwitch ID.

vsw-wz9qqeovkwjxlu9uc****

SecurityGroupId

string

The security group ID.

sg-2vcgdxz7o1n9zapp****

SinkSLSParameters

object

The parameters for the SLS sink.

Project

object

The SLS project.

Value

string

The SLS project.

test-project

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not used.

LogStore

object

The SLS Logstore.

Value

string

The SLS Logstore.

test-logstore

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not used.

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 in SLS.

topic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Body

object

The content sent to SLS.

Value

string

The value before the transform.

{ "key": "value" }

Form

string

The transform format.

TEMPLATE

Template

string

The template format.

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

RoleName

object

The name of the RAM role that grants EventBridge permissions to read logs from SLS. When you create this role in the RAM console, select **Alibaba Cloud Service** for Trusted Entity and **EventBridge** for Trusted Service.

Value

string

The name of the RAM role that grants EventBridge permissions to read logs from SLS. When you create this role in the RAM console, select **Alibaba Cloud Service** for Trusted Entity and **EventBridge** for Trusted Service.

test-role

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

ContentType

object

The data format for SLS. Valid values:

  • JSON

  • KeyValue

Value

string

The data format for SLS. Valid values:

  • JSON

  • KeyValue

JSON

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not used.

ContentSchema

object

The key-value pairs for custom logs. 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 transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

SinkFnfParameters

object

The Sink Fnf parameters.

FlowName

object

The flow name.

Value

string

The flow name.

test-streaming-fnf

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

ExecutionName

object

The execution name.

Value

string

The execution name.

123

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

Input

object

The input for the execution.

Value

string

The input for the execution.

123

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

RoleName

object

The role configuration.

Value

string

The role configuration.

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

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

The template format.

SinkDataHubParameters

object

The DataHub sink parameters.

Project

object

The DataHub project name.

Value

string

The DataHub project name.

demo-project

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

Topic

object

The name of the DataHub topic.

Value

string

The name of the DataHub topic.

demo-topic

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not used.

TopicType

object

The topic type. Valid values:

  • TUPLE

  • BLOB

Value

string

The type of the DataHub topic. Valid values:

  • TUPLE

  • BLOB

TUPLE

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not supported.

TopicSchema

object

The content pattern of the topic. The type is TUPLE.

Value

string

The content pattern for a topic of the TUPLE type.

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

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

Not applicable.

Body

object

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

Value

string

The template for the content of a BLOB record.

Form

string

The transform format.

ORIGINAL

Template

string

Not applicable.

RoleName

object

The name of the RAM role that grants EventBridge permissions to read logs from SLS. When you create this role in the RAM console, select **Alibaba Cloud Service** for Trusted Entity and **EventBridge** for Trusted Service.

Value

string

To authorize EventBridge to read SLS log content, create a role in the RAM console. For this role, select Alibaba Cloud Service and set the Trusted Service to EventBridge.

testRole

Form

string

The transform format. Default value: CONSTANT.

CONSTANT

Template

string

This parameter is not used.

SinkCustomizedKafkaParameters

object

The sink parameters for Kafka.

InstanceId

string

The ID of the Kafka instance.

90be1f96-4229-4535-bb76-34b4f6fb2b71

SinkCustomizedKafkaConnectorParameters

object

The sink Kafka connector parameters.

ConnectorPackageUrl

string

The download link for the file in OSS.

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

ConnectorParameters

object

The result of parsing the properties file in the current ZIP package.

Name

string

The name of the connector.

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 DashVector sink 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 records. If you do not specify a value, a random primary key ID is used.

Form

string

The transform format.

JSONPATH

Value

string

  • If Form is JSONPATH, the value is the content fetched by the JSONPath expression.

  • If Form is TEMPLATE, the value is 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 transform format.

CONSTANT

Value

string

  • If Form is CONSTANT: The constant value.

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

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

default

Template

string

No value is returned.

Vector

object

The vector of the record to insert into DashVector.

Form

string

The transform format.

JSONPATH

Value

string

The content extracted by JSONPath.

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

$.data.messageBody

Template

string

Not supported.

DashVectorSchemaParameters

array<object>

The schema definitions for the fields of a table entry that is inserted 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 of the RabbitMQ instance.

192.168.1.1:9876

VirtualHostName

string

The name of the RabbitMQ virtual host.

Vhost1

TargetType

string

The target type.

exchange

Exchange

string

The name of the exchange used for message routing.

my_exchange

QueueName

string

The name of the queue used to store messages.

my_queue

Username

string

The username for identity verification.

admin

Password

string

The password for identity verification.

****

VpcId

string

The VPC ID.

vpc-2zehizpoendb3****

VSwitchIds

string

The vSwitch ID.

vsw-wz9qqeovkwjxlu9uc****

SecurityGroupId

string

The security group ID.

sg-2vcgdxz7o1n9zapp****

NetworkType

string

The network type.

PrivateNetwork

AuthType

string

The authentication type.

ACL

RoutingKey

object

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

Form

string

The data format. Default value: JSONPATH.

JSONPATH

Value

string

The routing rule for the message.

housekeeping

Template

string

The template format.

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

Body

object

The message body.

Form

string

The transform format.

TEMPLATE

Value

string

The value before the transform.

{ "key": "value" }

Template

string

The template format.

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

MessageId

object

The message ID.

Form

string

The transform format.

TEMPLATE

Value

string

The value before the transform.

{ "key": "value" }

Template

string

The template format.

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

Properties

object

The filter properties.

Form

string

The transform format.

TEMPLATE

Value

string

The value before the transform.

{ "key": "value" }

Template

string

The template format.

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

SinkBaiLianParameters SinkBaiLianParameters

The Sink BaiLian parameters.

SinkHttpsParameters

SinkHttpsParameters

The HTTPS target parameters.

SinkApiDestinationParameters

SinkApiDestinationParameters

The API destination target parameters.

SinkOSSParameters SinkOSSParameters

SinkRabbitMQMetaParameters SinkRabbitMQMetaParameters

SinkRabbitMQMsgSyncParameters SinkRabbitMQMsgSyncParameters

SinkMQTTParameters SinkMQTTParameters

RunOptions

object

The runtime environment parameters.

MaximumTasks

integer

The concurrency.

2

RetryStrategy

object

The retry policy for a failed event push.

PushRetryStrategy

string

The retry policy. Valid values: `BACKOFF_RETRY` (backoff retry) and `EXPONENTIAL_DECAY_RETRY` (exponential decay retry).

EXPONENTIAL_DECAY_RETRY

ErrorsTolerance

string

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

ALL

DeadLetterQueue

object

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

The ARN of the dead-letter queue.

acs:ram::159787121179****:role/aliyunsaedefaultrole

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 ID of the virtual switch for the dead-letter queue.

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

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

sg-2vcgdxz7o1n9zapp****

BatchWindow

object

The batch window.

CountBasedWindow

integer

The maximum number of events per window. When this threshold is met, data is pushed to the downstream service. If multiple window conditions exist, the push is triggered as soon as one condition is met.

100

TimeBasedWindow

integer

The maximum time window in seconds. When this time threshold is reached, the data in the window is pushed to the downstream service. If multiple window conditions exist, the push is triggered as soon as one condition is met.

10

BusinessOption

object

BusinessMode

string

MinCapacityUnitCount

integer

MaxCapacityUnitCount

integer

Throttling

integer

Status

string

The status of the event stream.

RUNNING

NextToken

string

The token that marks the last read position. If this parameter is empty, all data has been read. To continue reading, set the `NextToken` request parameter to this value for your next call.

177

Total

integer

The total number of records.

10

Code

string

The status code returned. A value of `Success` indicates that the request was successful. For more information about other values, see the "Error codes" section of this topic.

Success: The request was successful.

Other values indicate an error code. For details, see Error codes.

Success

Success

boolean

Indicates whether the request was successful. A value of `true` indicates that the request was successful.

true

Examples

Success response

JSON format

{
  "Message": "The event streaming [xxxx] not existed!\n",
  "RequestId": "283FF852-C4B8-58C9-9777-F88A5A16****",
  "Data": {
    "EventStreamings": [
      {
        "EventStreamingName": "name",
        "Description": "demo",
        "Source": {
          "SourceMNSParameters": {
            "RegionId": "cn-zhangjiakou",
            "QueueName": "work4",
            "IsBase64Decode": true
          },
          "SourceRabbitMQParameters": {
            "RegionId": "cn-zhangjiakou",
            "InstanceId": "dbaudit-cn-7mz2hqo****",
            "VirtualHostName": "eb-connect\n",
            "QueueName": "liuyang"
          },
          "SourceRocketMQParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "i-f8zbher64dlm58pl****\n",
            "Topic": "topic_add_anima",
            "Tag": "v1",
            "Offset": "CONSUMEFROMTIMESTAMP",
            "GroupID": "GID_group1",
            "Timestamp": 1670742074043,
            "InstanceType": "Cloud_4\n",
            "InstanceEndpoint": "registry-vpc.cn-hangzhou.aliyuncs.com",
            "AuthType": "ACL",
            "InstanceUsername": "admin**",
            "InstancePassword": "123",
            "InstanceVpcId": "vpc-bp1a4gmlk31hy***l3ss",
            "InstanceVSwitchIds": "vsw-m5ev8asdc6h123456****\n",
            "InstanceSecurityGroupId": "sg-m5edtu24f12345****\n",
            "InstanceNetwork": "PublicNetwork",
            "BodyDataType": "JSON\n",
            "Network": "PublicNetwork",
            "FilterType": "Tag\n",
            "FilterSql": "index > 10\n",
            "VpcId": "vpc-m5e3sv4b12345****\n",
            "VSwitchIds": "vsw-m5ev8asdc6h12345****\n",
            "SecurityGroupId": "sg-m5edtu24f12345****\n"
          },
          "SourceRocketMQCheckpointParameters": {
            "RegionId": "cn-hangzhou",
            "InstanceType": "Cloud_5",
            "InstanceId": "\nrmq-cn-jte3w******",
            "Topics": [
              "myTopic"
            ]
          },
          "SourceApacheRocketMQCheckpointParameters": {
            "RegionId": "cn-hangzhou",
            "Topics": [
              "myTopic"
            ],
            "InstanceEndpoint": "192.168.1.1:9876",
            "InstanceUsername": "admin",
            "InstancePassword": "****",
            "NetworkType": "PrivateNetwork",
            "VpcId": "vpc-adw1awdw*****",
            "VSwitchId": "vsw-dwaafds****",
            "SecurityGroupId": "sg-mw43*****"
          },
          "SourceKafkaParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "bastionhost-cn-i7m2gwt****",
            "Topic": "topic_empower_1642473600414\n",
            "ConsumerGroup": "GID_TEST",
            "OffsetReset": "latest",
            "Network": "Default",
            "VpcId": "vpc-wz9ki1qdlx3cx5cbf****",
            "VSwitchIds": "vsw-bp1rmi8rind7eo50c****",
            "SecurityGroupId": "sg-5ud5f3p0rqqis69****eho7cp",
            "ValueDataType": "JSON\n"
          },
          "SourceMQTTParameters": {
            "RegionId": "cn-qingdao",
            "InstanceId": "bastionhost-cn-zvp27kc****",
            "Topic": "migration_instance",
            "BodyDataType": "JSON\n"
          },
          "SourceDTSParameters": {
            "TaskId": "1611b337285f44e2936a2c4170****",
            "BrokerUrl": "无",
            "Topic": "TP_TEST_UNDERWRITE_ISSUE\n",
            "Sid": "HG9",
            "Username": "admin",
            "Password": "123456",
            "InitCheckPoint": "1620962769"
          },
          "SourceSLSParameters": {
            "Project": "dmmzk",
            "LogStore": "waf-logstore\n",
            "ConsumerGroup": "go-dts-shelf-group",
            "ConsumePosition": "begin",
            "RoleName": "testRole"
          },
          "SourcePrometheusParameters": {
            "RegionId": "cn-beijing",
            "ClusterId": "c83555068b6******ad213f565f209\n",
            "DataType": "JSON\n",
            "Labels": "__name__=.*\n",
            "RoleName": "testRole",
            "ExternalLabels": "{\"source\":\"prometheus-prod\"}"
          },
          "SourceCustomizedKafkaParameters": {
            "InstanceId": "gtm-cn-k2c2yfg****\n"
          },
          "SourceCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "\"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": {
              "Name": "test-name\n",
              "Config": {
                "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector",
                "tasks.max": "1",
                "topics": "sourceA,sourceB"
              }
            },
            "WorkerParameters": {
              "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"
            }
          },
          "SourceOSSParameters": {
            "RoleName": "eventbridge_oss_role\n",
            "BucketName": "bucket_abc\n",
            "Prefix": "fun/document/\n",
            "LoadMode": "single\n",
            "LoadFormat": "TextLoader\n",
            "Delimiter": "\\n\n"
          },
          "SourceOpenSourceRabbitMQParameters": {
            "Endpoint": "192.168.1.1:9876",
            "VirtualHostName": "Vhost1",
            "QueueName": "demo",
            "BodyDataType": "Json",
            "Username": "admin",
            "Password": "****",
            "VpcId": "vpc-m5e3sv4b12345****",
            "VSwitchIds": "vsw-m5ev8asdc6h12345****",
            "SecurityGroupId": "sg-m5edtu24f12345****",
            "NetworkType": "PrivateNetwork",
            "AuthType": "ACL"
          },
          "SourceEventBusParameters": {
            "EventBusName": "my-event-bus",
            "EventRuleName": "my-event-rule"
          },
          "SourceMySQLParameters": {
            "IncludeSchemaChanges": "",
            "User": "",
            "VSwitchIds": "",
            "SnapshotMode": "",
            "SecurityGroupId": "",
            "Port": 0,
            "DatabaseName": "",
            "VpcId": "",
            "NetworkType": "",
            "TableNames": "",
            "RegionId": "",
            "HostName": "",
            "Password": ""
          }
        },
        "FilterPattern": "无",
        "Transforms": [
          {
            "Arn": "acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func\n"
          }
        ],
        "Sink": {
          "SinkMNSParameters": {
            "QueueName": {
              "Value": "MyQueue",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "IsBase64Encode": {
              "Value": "true",
              "Form": "CONSTANT",
              "Template": "无"
            }
          },
          "SinkFcParameters": {
            "ServiceName": {
              "Value": "myService",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "FunctionName": {
              "Value": "mFunction",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Concurrency": {
              "Value": "1",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Qualifier": {
              "Value": "LATEST",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "InvocationType": {
              "Value": "Async",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "DataFormat": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "CONSTANT",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkRabbitMQParameters": {
            "InstanceId": {
              "Value": "si-296cd57939a1421b****",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "VirtualHostName": {
              "Value": "rabbit-host\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "TargetType": {
              "Value": "Queue",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Exchange": {
              "Value": "a_exchange",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "RoutingKey": {
              "Value": "housekeeping",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "QueueName": {
              "Value": "MyQueue",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "MessageId": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Properties": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkKafkaParameters": {
            "InstanceId": {
              "Value": "Defaut_1283278472_sad****",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Acks": {
              "Value": "1",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Key": {
              "Value": "key",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Value": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkRocketMQParameters": {
            "InstanceId": {
              "Value": "MQ_INST_164901546557****_BAAN****\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Properties": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Keys": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Tags": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "InstanceType": {
              "Value": "Cloud_4",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstanceEndpoint": {
              "Value": "vbr-8vbsvkkbpf3vb0zef****\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstanceUsername": {
              "Value": "admin\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstancePassword": {
              "Value": "admin******\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "VpcId": {
              "Value": "vbr-8vb835n3zf9shwlvb****\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "VSwitchIds": {
              "Value": "vbr-8vb835n3zf9shwl****mp\n",
              "Form": "CONSTANT\n\n",
              "Template": "无"
            },
            "SecurityGroupId": {
              "Value": "b4bf375515f6440f942e3a20c33d****\n",
              "Form": "CONSTANT\n",
              "Template": "无\n"
            },
            "Network": {
              "Value": "PublicNetwork\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "DeliveryOrderType": {
              "Value": "Orderly",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ShardingKey": {
              "Value": "order_id",
              "Form": "CONSTANT",
              "Template": "无"
            }
          },
          "SinkDorisParameters": {
            "QueryEndpoint": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "FeHttpEndpoint": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "BeHttpEndpoint": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "UserName": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Password": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Database": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Table": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Body": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "NetworkType": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "VpcId": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "VSwitchIds": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "SecurityGroupId": {
              "Value": "",
              "Form": "",
              "Template": ""
            }
          },
          "SinkRocketMQCheckpointParameters": {
            "InstanceType": "Cloud_5",
            "InstanceId": "MQ_INST_1825725063814405_BZ******",
            "Topic": {
              "Value": "myTopic",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Group": {
              "Value": "GID_******",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ConsumeTimestamp": {
              "Value": "1636597951964",
              "Form": "CONSTANT",
              "Template": "无"
            }
          },
          "SinkApacheRocketMQCheckpointParameters": {
            "Topic": {
              "Value": "myTopic",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Group": {
              "Value": "GID_******",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ConsumeTimestamp": {
              "Value": "1636597951964",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "InstanceEndpoint": "192.168.1.1:9876",
            "InstanceUsername": "admin",
            "InstancePassword": "****",
            "NetworkType": "PrivateNetwork",
            "VpcId": "vpc-2zehizpoendb3****",
            "VSwitchId": "vsw-wz9qqeovkwjxlu9uc****",
            "SecurityGroupId": "sg-2vcgdxz7o1n9zapp****"
          },
          "SinkSLSParameters": {
            "Project": {
              "Value": "test-project\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "LogStore": {
              "Value": "test-logstore\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "RoleName": {
              "Value": "test-role",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ContentType": {
              "Value": "JSON\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ContentSchema": {
              "Value": "{\"Key_1\":{\"form\":\"CONSTANT\",\"value\":\"demoKey\"},\"Value_1\":{\"form\":\"JSONPATH\",\"value\":\"$.data.value\"}}",
              "Form": "CONSTANT\n",
              "Template": "无"
            }
          },
          "SinkFnfParameters": {
            "FlowName": {
              "Value": "test-streaming-fnf\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ExecutionName": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Input": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "RoleName": {
              "Value": "Al****FNF-x****\n",
              "Form": "CONSTANT",
              "Template": "无"
            }
          },
          "SinkDataHubParameters": {
            "Project": {
              "Value": "demo-project\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "Topic": {
              "Value": "demo-topic\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "TopicType": {
              "Value": "TUPLE\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "TopicSchema": {
              "Value": "{\"k1\":\"value1\",\"k2\":\"value2\"}\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "无",
              "Form": "ORIGINAL\n",
              "Template": "无"
            },
            "RoleName": {
              "Value": "testRole\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            }
          },
          "SinkCustomizedKafkaParameters": {
            "InstanceId": "90be1f96-4229-4535-bb76-34b4f6fb2b71\n"
          },
          "SinkCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "\"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": {
              "Name": "mongo-sink\n",
              "Config": {
                "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector",
                "tasks.max": "1",
                "topics": "sourceA,sourceB"
              }
            },
            "WorkerParameters": {
              "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": {
            "InstanceId": "vrs-cn-lbj3ru1***\n",
            "Collection": "collection1\n",
            "ApiKey": "Q34nExQH7sQ****\n",
            "Operation": "Upsert\n",
            "Network": "PublicNetwork\n",
            "PrimaryKeyId": {
              "Form": "JSONPATH\n",
              "Value": "$.data.requestId\n",
              "Template": "${ID}\n"
            },
            "Partition": {
              "Form": "CONSTANT\n",
              "Value": "default\n",
              "Template": "无"
            },
            "Vector": {
              "Form": "JSONPATH\n",
              "Value": "$.data.messageBody\n",
              "Template": "无"
            },
            "DashVectorSchemaParameters": {
              "Form": "TEMPLATE\n",
              "Value": "{\n  \"value1\":\"v1\",\n  \"value2\":\"v2\"\n}",
              "Template": "[\n  {\n    \"name\": \"schema1\",\n    \"type\": \"INT\",\n    \"value\": \"${value1}\"\n  },\n  {\n    \"name\": \"schema2\",\n    \"type\": \"FLOAT\",\n    \"value\": \"${value2}\"\n  }\n]"
            }
          },
          "SinkOpenSourceRabbitMQParameters": {
            "Endpoint": "192.168.1.1:9876",
            "VirtualHostName": "Vhost1",
            "TargetType": "exchange",
            "Exchange": "my_exchange",
            "QueueName": "my_queue",
            "Username": "admin",
            "Password": "****",
            "VpcId": "vpc-2zehizpoendb3****",
            "VSwitchIds": "vsw-wz9qqeovkwjxlu9uc****",
            "SecurityGroupId": "sg-2vcgdxz7o1n9zapp****",
            "NetworkType": "PrivateNetwork",
            "AuthType": "ACL",
            "RoutingKey": {
              "Form": "JSONPATH",
              "Value": "housekeeping\n",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Body": {
              "Form": "TEMPLATE\n",
              "Value": "{\n      \"key\": \"value\"\n}",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "MessageId": {
              "Form": "TEMPLATE\n",
              "Value": "{\n      \"key\": \"value\"\n}",
              "Template": "The value of ${key} is ${value}!"
            },
            "Properties": {
              "Form": "TEMPLATE",
              "Value": "\t\n{\n      \"key\": \"value\"\n}",
              "Template": "The value of ${key} is ${value}!"
            }
          },
          "SinkBaiLianParameters": {
            "Before": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Context": "",
            "ApplicationType": "",
            "Op": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Partition": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Extend": "",
            "WorkspaceId": "",
            "After": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Offset": {
              "Form": "",
              "Value": "",
              "Template": ""
            }
          }
        },
        "RunOptions": {
          "MaximumTasks": 2,
          "RetryStrategy": {
            "PushRetryStrategy": "EXPONENTIAL_DECAY_RETRY",
            "MaximumEventAgeInSeconds": 512,
            "MaximumRetryAttempts": 2
          },
          "ErrorsTolerance": "ALL",
          "DeadLetterQueue": {
            "Arn": "acs:ram::159787121179****:role/aliyunsaedefaultrole",
            "Network": "PrivateNetwork",
            "VpcId": "vpc-2zehizpoendb3****",
            "VSwitchIds": "vsw-m5ev8asdc6h12345****",
            "SecurityGroupId": "sg-2vcgdxz7o1n9zapp****"
          },
          "BatchWindow": {
            "CountBasedWindow": 100,
            "TimeBasedWindow": 10
          },
          "BusinessOption": {
            "BusinessMode": "",
            "MinCapacityUnitCount": 0,
            "MaxCapacityUnitCount": 0
          },
          "Throttling": 0
        },
        "Status": "RUNNING"
      }
    ],
    "NextToken": "177",
    "Total": 10
  },
  "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.