All Products
Search
Document Center

EventBridge:CreateEventStreaming

Last Updated:Jan 30, 2024

Creates an event stream.

Operation description

You can call this API operation to create an event stream.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
EventStreamingNamestringYes

The name of the event stream.

myeventstreaming
DescriptionstringNo

The description of the event stream.

rocketmq2mns
FilterPatternstringYes

The rule that is used to filter events. If you leave this parameter empty, all events are matched.

SourceobjectYes

The event provider, which is also known as the event source. You must and can specify only one event source.

SourceMNSParametersobjectNo

The parameters that are configured if you specify Message Service (MNS) as the event source.

RegionIdstringNo

The ID of the region where the MNS queue resides.

cn-beijing
QueueNamestringNo

The name of the MNS queue.

queue_api_1642474203601
IsBase64DecodebooleanNo

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

true
SourceRabbitMQParametersobjectNo

The parameters that are configured if you specify Message Queue for RabbitMQ as the event source.

RegionIdstringNo

The ID of the region where the Message Queue for RabbitMQ instance resides. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringNo

The ID of the Message Queue for RabbitMQ instance.

gtm-cn-k2c2yfgzt02
VirtualHostNamestringNo

The vhost name of the Message Queue for RabbitMQ instance.

eb-connect
QueueNamestringNo

The queue name of the Message Queue for RabbitMQ instance.

demo
SourceKafkaParametersobjectNo

The parameters that are configured if you specify Message Queue for Apache Kafka as the event source.

RegionIdstringNo

The ID of the region where the Message Queue for Apache Kafka instance resides.

cn-hangzhou
InstanceIdstringNo

The ID of the Message Queue for Apache Kafka instance.

r-8vb64581862cd814
TopicstringNo

The topic name.

popvip_center_robot_order
ConsumerGroupstringNo

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

DEFAULT_GROUP
OffsetResetstringNo

The offset.

latest
NetworkstringNo

The network setting. Default value: Default. The value PublicNetwork specifies a virtual private cloud (VPC).

Default
VpcIdstringNo

The VPC ID.

vpc-8vblalsi0vbhizr77cbhu
VSwitchIdsstringNo

The vSwitch ID.

vsw-bp179l3llg3jjxwrq72hh
SecurityGroupIdstringNo

The security group ID.

sg-bp1iv19sp1msc7zot4wr
SourceRocketMQParametersobjectNo

The parameters that are configured if you specify Message Queue for Apache RocketMQ as the event source.

RegionIdstringNo

The ID of the region where the Message Queue for Apache RocketMQ instance resides.

cn-qingdao
InstanceIdstringNo

The ID of the Message Queue for Apache RocketMQ instance.

default_C56C360261515
TopicstringNo

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

Topic_publicRule_api_1667273421288
TagstringNo

The tag that you want to use to filter messages.

test
OffsetstringNo

The offset from which messages are consumed. Valid values:

  • CONSUME_FROM_LAST_OFFSET: Messages are consumed from the latest offset.
  • CONSUME_FROM_FIRST_OFFSET: Messages are consumed from the earliest offset.
  • CONSUME_FROM_TIMESTAMP: Messages are consumed from the offset at the specified point in time.

Default value: CONSUME_FROM_LAST_OFFSET.

CONSUMEFROMLAST_OFFSET
GroupIDstringNo

The ID of the consumer group on the Message Queue for Apache RocketMQ instance.

GID_group1
TimestamplongNo

The timestamp that specifies the time from which messages are consumed. This parameter is valid only if you set Offset to CONSUME_FROM_TIMESTAMP.

1670656652009
InstanceTypestringNo

The instance type.

2
InstanceEndpointstringNo

The instance endpoint.

registry-vpc.cn-zhangjiakou.aliyuncs.com
InstanceUsernamestringNo

The instance username.

admin
InstancePasswordstringNo

The instance password.

admin
NetworkstringNo

The network type. Valid values: PublicNetwork and PrivateNetwork.

PrivateNetwork
FilterTypestringNo

The method that you want to use to filter messages.

Tag
FilterSqlstringNo

The SQL statement that you want to use to filter messages.

index > 10
AuthTypestringNo

The authentication method.

ACL
VpcIdstringNo

The VPC ID of the cross-border task.

vpc-m5e3sv4b123456789
VSwitchIdsstringNo

The vSwitch ID of the cross-border task.

vsw-m5ev8asdc6h123456789
SecurityGroupIdstringNo

The security group ID of the cross-border task.

sg-m5edtu24f123456789
InstanceVpcIdstringNo

The VPC ID of the Message Queue for Apache RocketMQ instance.

vpc-m5e3sv4b123456789
InstanceVSwitchIdsstringNo

The vSwitch ID of the Message Queue for Apache RocketMQ instance.

vsw-m5ev8asdc6h123456789
InstanceSecurityGroupIdstringNo

The security group ID of the Message Queue for Apache RocketMQ instance.

sg-m5edtu24f123456789
InstanceNetworkstringNo

The network type of the Message Queue for Apache RocketMQ instance. Valid values:

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
SourceMQTTParametersobjectNo

The parameters that are configured if you specify Message Queue for MQTT as the event source.

RegionIdstringNo

The ID of the region where the Message Queue for MQTT instance resides.

cn-shenzhen
InstanceIdstringNo

The ID of the Message Queue for MQTT instance.

r-bp1b5ncun5lqerzg4r
TopicstringNo

The topic from which messages are sent.

CANAL_VICUTU_UAT
SourceDTSParametersobjectNo

The parameters that are configured if you specify Data Transmission Service (DTS) as the event source.

TaskIdstringNo

The task ID.

f86e5814-b223-482c-b768-3b873297dade
BrokerUrlstringNo

The URL and port number of the change tracking instance.

TopicstringNo

The name of the tracked topic of the change tracking instance.

LTC_CACHE_PRD
SidstringNo

The consumer group ID.

HD3
UsernamestringNo

The consumer group username.

admin
PasswordstringNo

The consumer group password.

admin
InitCheckPointlongNo

The UNIX timestamp that is generated when the SDK client consumes the first data record.

1620962769
SourceSLSParametersobjectNo

The parameters that are configured if you specify Log Service as the event source.

ProjectstringNo

The Log Service project.

test
LogStorestringNo

The Log Service Logstore.

sas-log
ConsumePositionstringNo

The consumer offset. The value begin specifies the earliest offset, and the value end specifies the latest offset. You can also specify a time in seconds to start consumption.

end
RoleNamestringNo

The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the Resource Access Management (RAM) console.

testRole
SinkobjectYes

The event target. You must and can specify only one event target.

SinkMNSParametersobjectNo

The parameters that are configured if you specify the event target as MNS.

QueueNameobjectNo

The name of the MNS queue.

ValuestringNo

The name of the MNS queue.

MyQueue
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message body.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

Specifies whether to enable Base64 encoding.

ValuestringNo

Specifies that Base64 encoding is enabled.

true
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The parameters that are configured if you specify the event target as Message Queue for RabbitMQ.

InstanceIdobjectNo

The information about the Message Queue for RabbitMQ instance.

ValuestringNo

The ID of the Message Queue for RabbitMQ instance.

a5ff91ad4f3f24947887fe184fc20d07
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The name of the vhost of the Message Queue for RabbitMQ instance.

ValuestringNo

The name of the vhost of the Message Queue for RabbitMQ instance.

rabbit-host
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The type of the resource to which you want to deliver events.

ValuestringNo

The type of the resource to which you want to deliver events. Valid values:

  • Exchange
  • Queue
Exchange/Queue
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The exchange to which you want to deliver events. This parameter is available only if you set TargetType to Exchange.

ValuestringNo

The name of the exchange on the Message Queue for RabbitMQ instance.

a_exchange
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The rule that you want to use to route messages. This parameter is available only if you set TargetType to Exchange.

ValuestringNo

The rule that you want to use to route messages.

housekeeping
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The queue to which you want to deliver events. This parameter is available only if you set TargetType to Queue.

ValuestringNo

The name of the queue on the Message Queue for RabbitMQ instance.

MyQueue
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message body.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The message ID.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The properties that you want to use to filter messages.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The parameters that are configured if you specify the event target as Message Queue for Apache Kafka.

InstanceIdobjectNo

The ID of the Message Queue for Apache Kafka instance.

ValuestringNo

The instance ID.

Defaut_1283278472_sadkj
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The topic name.

ValuestringNo

The topic name.

test
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The acknowledgement (ACK) mode.

  • If you set this parameter to 0, no response is returned from the broker. In this mode, the performance is high, but the risk of data loss is also high.
  • If you set this parameter to 1, a response is returned when data is written to the leader. In this mode, the performance and the risk of data loss are moderate. Data loss may occur if a failure occurs on the leader.
  • If you set this parameter to all, a response is returned when data is written to the leader and synchronized to the followers. In this mode, the performance is low, but the risk of data loss is also low. Data loss occurs if the leader and the followers fail at the same time.
ValuestringNo

The ACK mode.

  • If you set this parameter to 0, no response is returned from the broker. In this mode, the performance is high, but the risk of data loss is also high.
  • If you set this parameter to 1, a response is returned when data is written to the leader. In this mode, the performance and the risk of data loss are moderate. Data loss may occur if a failure occurs on the leader.
  • If you set this parameter to all, a response is returned when data is written to the leader and synchronized to the followers. In this mode, the performance is low, but the risk of data loss is also low. Data loss occurs if the leader and the followers fail at the same time.
1
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message key.

ValuestringNo

The message key.

key
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message body.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The parameters that are configured if you specify the event target as Function Compute.

ServiceNameobjectNo

The service name.

ValuestringNo

The service name.

myService
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The function name.

ValuestringNo

The function name.

myFunction
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The delivery concurrency. Minimum value: 1.

ValuestringNo

The delivery concurrency. Minimum value: 1.

1
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

None
QualifierobjectNo

The service version.

ValuestringNo

The service version.

LATEST
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The invocation method. Valid values: Sync and Async.

ValuestringNo

The invocation method. Valid values: Sync and Async.

Async
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message body that you want to deliver to Function Compute.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The parameters that are configured if you specify the event target as Message Queue for Apache RocketMQ.

InstanceIdobjectNo

The parameters that are configured if you specify the event target as Message Queue for Apache RocketMQ.

ValuestringNo

The ID of the Message Queue for Apache RocketMQ instance.

MQ_INST_164901546557****_BAAN****
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The topic on the Message Queue for Apache RocketMQ instance.

ValuestringNo

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

Mytopic
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

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

The message body.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The properties that you want to use to filter messages.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The keys that you want to use to filter messages.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The tags that you want to use to filter messages.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The instance type.

ValuestringNo

The instance type.

2
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

InstanceEndpointobjectNo

The instance endpoint.

ValuestringNo

The instance endpoint.

vbr-8vbsvkkbpf3vb0zefs7ex
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

InstanceUsernameobjectNo

The instance username.

ValuestringNo

The instance username.

admin
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

InstancePasswordobjectNo

The instance password.

ValuestringNo

The instance password.

admin
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

VpcIdobjectNo

The VPC ID.

ValuestringNo

The VPC ID.

vbr-8vb835n3zf9shwlvbwlmp
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

VSwitchIdsobjectNo

The vSwitch ID.

ValuestringNo

The vSwitch ID.

vbr-8vb835n3zf9shwlvbwlmp
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SecurityGroupIdobjectNo

The security group ID.

ValuestringNo

The security group ID.

b4bf375515f6440f942e3a20c33d5b9c
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

NetworkobjectNo

The network type. Valid values:

  • PublicNetwork
  • PrivateNetwork
ValuestringNo

The network type. Valid values:

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SinkSLSParametersobjectNo

The parameters that are configured if you specify the event target as Simple Log Service.

ProjectobjectNo

The Simple Log Service project.

ValuestringNo

The Simple Log Service project.

test-project
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

LogStoreobjectNo

The Simple Log Service Logstore.

ValuestringNo

The Simple Log Service Logstore.

test-logstore
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicobjectNo

The topic that you want to use to store logs. This parameter corresponds to the topic reserved field in Simple Log Service.

ValuestringNo

The topic that you want to use to store logs. This parameter corresponds to the topic reserved field in Simple Log Service.

testTopic
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

BodyobjectNo

The message body that you want to deliver to Simple Log Service.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the Resource Access Management (RAM) console.

ValuestringNo

The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the RAM console.

testRole
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SinkDataHubParametersobjectNo

The parameters that are configured if you specify the event target as DataHub.

ProjectobjectNo

The name of the DataHub project.

ValuestringNo

The name of the DataHub project.

demo-project
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicobjectNo

The name of the DataHub topic.

ValuestringNo

The name of the DataHub topic.

demo-topic
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicTypeobjectNo

The topic type. Valid values:

  • TUPLE
  • BLOB
ValuestringNo

The topic type. Valid values:

  • TUPLE
  • BLOB
TUPLE
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicSchemaobjectNo

The TUBLE topic.

ValuestringNo

The TUBLE topic.

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

The format into which you want to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

The BLOB topic.

ValuestringNo

The BLOB topic.

FormstringNo

The format into which you want to transform events.

ORIGINAL
TemplatestringNo

None.

RoleNameobjectNo

The role name.

ValuestringNo

The role name.

test-role
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SinkFnfParametersobjectNo

The parameters that are configured if you specify the event target as Serverless Workflow.

FlowNameobjectNo

The flow name.

ValuestringNo

The flow name.

test-streaming-fnf
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

ExecutionNameobjectNo

The execution name.

ValuestringNo

The execution name.

123
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

InputobjectNo

The input information of the execution.

ValuestringNo

The input information of the execution.

123
FormstringNo

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

RoleNameobjectNo

The role name.

ValuestringNo

The role name.

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

The format into which you want to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

RunOptionsobjectNo

The parameters that are configured for the runtime environment.

MaximumTaskslongNo

The maximum number of concurrent threads.

2
ErrorsTolerancestringNo

The exception tolerance policy. Valid values:

  • NONE: does not tolerate exceptions.
  • ALL: tolerates all exceptions.
ALL
RetryStrategyobjectNo

The retry policy that you want to use if events fail to be pushed.

PushRetryStrategystringNo

The retry policy. Valid values:

  • BACKOFF_RETRY
  • EXPONENTIAL_DECAY_RETRY
BACKOFFRETRY
MaximumEventAgeInSecondslongNo

The maximum timeout period for a retry.

512
MaximumRetryAttemptslongNo

The maximum number of retries.

2
DeadLetterQueueobjectNo

Specifies whether to enable dead-letter queues. By default, dead-letter queues are disabled. Messages that fail to be pushed are discarded after the maximum number of retries that is specified by the retry policy is reached.

ArnstringNo

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

acs:ram::1317334647812936:role/rdstoecsassumekms
BatchWindowobjectNo

The batch window.

CountBasedWindowintegerNo

The maximum number of events that is allowed in the batch window. When this threshold is reached, data in the window is pushed to the downstream service. If multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.

100
TimeBasedWindowintegerNo

The maximum period of time during which events are allowed in the batch window. Unit: seconds. When this threshold is reached, data in the window is pushed to the downstream service. If multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.

10

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The returned error message.

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

The request ID.

B896B484-F16D-59DE-9E23-DD0E5C361108
Dataobject

The returned data.

EventStreamingARNstring

The ARN of the event stream.

acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming
Codestring

The response code. Valid values:

  • Success: The request is successful.
  • Other codes: The request failed. For more information about error codes, see Error codes.
200
Successboolean

Indicates whether the operation is successful. The value true indicates that the operation is successful.

true

Examples

Sample success responses

JSONformat

{
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "B896B484-F16D-59DE-9E23-DD0E5C361108",
  "Data": {
    "EventStreamingARN": "acs:eventbridge:cn-hangzhou:164901546557****:eventstreaming/myeventstreaming"
  },
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
403ServiceNotEnableService not enable

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
2023-12-28The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
2023-11-22The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Transforms
2023-09-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
2023-04-21The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
2023-04-06The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403