All Products
Search
Document Center

EventBridge:UpdateEventStreaming

Last Updated:Dec 04, 2024

Modifies the information about an event stream, such as the basic information and the information about the event source, event filtering rule, and event target.

Operation description

You can call this API operation to modify the information about an event stream, such as the basic information and the information about the event source, event filtering rule, and event target.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eventbridge:UpdateEventStreamingupdate
*EventStreaming
acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/{#EventStreamingName}
    none
none

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-hangzhou
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 ApsaraMQ for RabbitMQ as the event source.

RegionIdstringNo

The ID of the region where the ApsaraMQ for RabbitMQ instance resides.

cn-hangzhou
InstanceIdstringNo

The ID of the ApsaraMQ for RabbitMQ instance.

i-f8z9lqkldlb4oxsxwwub
VirtualHostNamestringNo

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

eb-connect
QueueNamestringNo

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

demo
SourceKafkaParametersobjectNo

The parameters that are configured if you specify ApsaraMQ for Kafka as the event source.

RegionIdstringNo

The ID of the region where the ApsaraMQ for Kafka instance resides.

cn-zhangjiakou
InstanceIdstringNo

The ID of the ApsaraMQ for Kafka instance.

i-8vbh4a5b9yfhgkkzm98f
TopicstringNo

The name of the topic on the ApsaraMQ for Kafka instance.

topic_empower_1641539400786
ConsumerGroupstringNo

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

DEFAULT_GROUP
OffsetResetstringNo

The offset from which messages are consumed.

latest
NetworkstringNo

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

Default
VpcIdstringNo

The ID of the VPC to which the ApsaraMQ for Kafka instance belongs.

vpc-2ze6p0o345nykmekxtuop
VSwitchIdsstringNo

The ID of the vSwitch with which the ApsaraMQ for Kafka instance is associated.

vsw-wz9t1l1e8eu2omwjazmtm
SecurityGroupIdstringNo

The ID of the security group to which the ApsaraMQ for Kafka instance belongs.

sg-uf6jcm3y5hcs7hklytxh
ValueDataTypestringNo

The encoding or decoding method. Valid values: Json, Text, and Binary. The value Json specifies that binary data is decoded into strings based on UTF-8 encoding and then parsed into the JSON format. The value Text specifies that binary data is decoded into strings based on UTF-8 encoding and then put into the payload. The value Binary specifies that binary data is encoded into strings based on Base64 encoding and then put into the payload.

Text
SourceRocketMQParametersobjectNo

The parameters that are configured if you specify ApsaraMQ for RocketMQ as the event source.

RegionIdstringNo

The ID of the region where the ApsaraMQ for RocketMQ instance resides.

cn-shanghai
InstanceIdstringNo

The ID of the ApsaraMQ for RocketMQ instance.

i-f8z9a9mcgwri1c1idd0e
TopicstringNo

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

TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
TagstringNo

The tag that you want to use to filter messages.

test
OffsetstringNo

The offset from which messages are consumed. Valid values:

  • CONSUMEFROMLASTOFFSET: Messages are consumed from the latest offset.
  • CONSUMEFROMFIRSTOFFSET: Messages are consumed from the earliest offset.
  • CONSUMEFROMTIMESTAMP: Messages are consumed from the offset at the specified point in time.

Default value: CONSUMEFROMLASTOFFSET.

CONSUMEFROMLASTOFFSET
GroupIDstringNo

The ID of the consumer group on the ApsaraMQ for RocketMQ instance.

GID_test
TimestamplongNo

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

1670656652009
InstanceTypestringNo

The type of the ApsaraMQ for RocketMQ instance.

2
InstanceEndpointstringNo

The endpoint that you want to use to access the ApsaraMQ for RocketMQ instance.

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

The username that you want to use to access the ApsaraMQ for RocketMQ instance.

admin
InstancePasswordstringNo

The password that you want to use to access the ApsaraMQ for RocketMQ instance.

admin
AuthTypestringNo

The authentication method.

ACL
InstanceVpcIdstringNo

The ID of the VPC in which the ApsaraMQ for RocketMQ instance is deployed.

vpc-m5e3sv4b12345****
InstanceVSwitchIdsstringNo

The ID of the vSwitch with which the ApsaraMQ for RocketMQ instance is associated.

vsw-m5ev8asdc6h12****
InstanceSecurityGroupIdstringNo

The ID of the security group to which the ApsaraMQ for RocketMQ instance belongs.

sg-m5edtu24f12345****
InstanceNetworkstringNo

The network type of the ApsaraMQ for RocketMQ instance. Valid values:

PublicNetwork and PrivateNetwork.

PublicNetwork
SourceMQTTParametersobjectNo

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

RegionIdstringNo

The ID of the region where the ApsaraMQ for MQTT instance resides.

cn-shanghai
InstanceIdstringNo

The ID of the ApsaraMQ for MQTT instance.

i-bp1dsudbecqwt61jqswt
TopicstringNo

The name of the topic on the ApsaraMQ for MQTT instance.

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

hkprdb
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 Simple Log Service as the event source.

RoleNamestringNo

The role name. If you want to authorize EventBridge to use this role to read logs in Simple 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
SourcePrometheusParametersobjectNo

The parameters that are configured if you specify Managed Service for Prometheus as the event source.

ClusterIdstringNo

The cluster ID.

c83555068b6******ad213f565f209
DataTypestringNo

The data type.

json
LabelsstringNo

The labels.

__name__=.*
SinkobjectYes

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

SinkMNSParametersobjectNo

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

QueueNameobjectNo

The name of the MNS queue.

ValuestringNo

The name of the MNS queue.

MyQueue
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

BodyobjectNo

The message content.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The method that you want to use 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 whether to enable Base64 encoding.

true
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SinkFcParametersobjectNo

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

ServiceNameobjectNo

The service name.

ValuestringNo

The service name.

myService
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

FunctionNameobjectNo

The function name.

ValuestringNo

The function name.

mFunction
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

ConcurrencyobjectNo

The delivery concurrency. Minimum value: 1.

ValuestringNo

The delivery concurrency. Minimum value: 1.

1
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

None
QualifierobjectNo

The alias of the service to which the function belongs.

ValuestringNo

The alias of the service to which the function belongs.

LATEST
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

InvocationTypeobjectNo

The invocation mode. Valid values: Sync and Async.

ValuestringNo

The invocation mode.

Async
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

BodyobjectNo

The message body that you want to deliver to the function.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The method that you want to use to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want events to be transformed.

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

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

InstanceIdobjectNo

The ID of the ApsaraMQ for RabbitMQ instance.

ValuestringNo

The ID of the ApsaraMQ for RabbitMQ instance.

amqp-cn-2r42e73o****
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

VirtualHostNameobjectNo

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

ValuestringNo

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

rabbit-host
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TargetTypeobjectNo

The type of the resource to which events are delivered.

ValuestringNo

The type of the resource to which events are delivered. Valid values:

  • Exchange
  • Queue
Exchange/Queue
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

ExchangeobjectNo

The exchange mode. This parameter is required only if you set TargetType to Exchange.

ValuestringNo

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

a_exchange
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

RoutingKeyobjectNo

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

ValuestringNo

The rule that you want to use to route messages.

housekeeping
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

QueueNameobjectNo

The queue mode. This parameter is required only if you set TargetType to Queue.

ValuestringNo

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

MyQueue
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

BodyobjectNo

The message content.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The method that you want to use 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 method that you want to use to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want events to be transformed.

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 method that you want to use to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want events to be transformed.

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

The parameters that are configured if you specify ApsaraMQ for Kafka as the event target.

InstanceIdobjectNo

The ID of the ApsaraMQ for Kafka instance.

ValuestringNo

The ID of the ApsaraMQ for Kafka instance.

Defaut_1283278472_sadkj
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicobjectNo

The name of the topic on the ApsaraMQ for Kafka instance.

ValuestringNo

The name of the topic on the ApsaraMQ for Kafka instance.

test
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

AcksobjectNo

The acknowledgment (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 method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

KeyobjectNo

The message key.

ValuestringNo

The message key.

key
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

ValueobjectNo

The message body.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The method that you want to use 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 ApsaraMQ for RocketMQ as the event target.

InstanceIdobjectNo

The ID of the ApsaraMQ for RocketMQ instance.

ValuestringNo

The ID of the ApsaraMQ for RocketMQ instance.

MQ_INST_164901546557****_BAAN****
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

TopicobjectNo

The topic on the ApsaraMQ for RocketMQ instance.

ValuestringNo

The topic on the ApsaraMQ for RocketMQ instance.

Mytopic
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

BodyobjectNo

The message content.

ValuestringNo

The value before transformation.

{ "key": "value" }
FormstringNo

The method that you want to use 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 method that you want to use 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 method that you want to use 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 method that you want to use to transform events.

TEMPLATE
TemplatestringNo

The template based on which you want to transform events.

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

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

ProjectobjectNo

The Simple Log Service project.

ValuestringNo

The Simple Log Service project.

test-project
FormstringNo

The method that you want to use 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 method that you want to use 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 reserved field topic in Simple Log Service.

ValuestringNo

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

testTopic
FormstringNo

The method that you want to use 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 method that you want to use 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 Simple 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 Simple 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 method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SinkFnfParametersobjectNo

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

FlowNameobjectNo

The flow name.

ValuestringNo

The flow name.

test-streaming-fnf
FormstringNo

The method that you want to use 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 method that you want to use 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 method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want events to be transformed.

RoleNameobjectNo

The role name.

ValuestringNo

The role name.

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

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

The template based on which you want to transform events.

SinkPrometheusParametersobjectNo

The parameters that are configured if you specify Managed Service for Prometheus as the event target.

URLobjectNo

The URL for the remote write configuration item of the Managed Service for Prometheus instance.

ValuestringNo

The URL for the remote write configuration item of the Managed Service for Prometheus instance.

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

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

AuthorizationTypeobjectNo

The authentication method.

ValuestringNo

The authentication method.

BASIC_AUTH
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

UsernameobjectNo

The username.

ValuestringNo

The username.

***admin
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

PasswordobjectNo

The password.

ValuestringNo

The password.

abc
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

DataobjectNo

The metric data.

ValuestringNo

The metric data.

$.data
FormstringNo

The method that you want to use to transform events. Default value: JSONPATH.

JSONPATH
TemplatestringNo

None.

NetworkTypeobjectNo

The network type.

ValuestringNo

The network type.

PrivateNetwork
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

VpcIdobjectNo

The ID of the VPC to which the Managed Service for Prometheus instance belongs.

ValuestringNo

The ID of the VPC to which the Managed Service for Prometheus instance belongs.

vpc-adw1awdw*****
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

VSwitchIdobjectNo

The ID of the vSwitch with which the Managed Service for Prometheus instance is associated.

ValuestringNo

The ID of the vSwitch with which the Managed Service for Prometheus instance is associated.

vsw-dwaafds****
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

SecurityGroupIdobjectNo

The ID of the security group to which the Managed Service for Prometheus instance belongs.

ValuestringNo

The ID of the security group to which the Managed Service for Prometheus instance belongs.

sg-mw43*****
FormstringNo

The method that you want to use to transform events. Default value: CONSTANT.

CONSTANT
TemplatestringNo

None.

RunOptionsobjectNo

The parameters that are configured for the runtime environment.

MaximumTaskslongNo

The maximum number of concurrent tasks.

2
ErrorsTolerancestringNo

The exception tolerance policy. Valid values: NONE and ALL.

ALL
RetryStrategyobjectNo

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

PushRetryStrategystringNo

The retry policy. Valid values: BACKOFF_RETRY and EXPONENTIAL_DECAY_RETRY.

BACKOFFRETRY
MaximumEventAgeInSecondslongNo

The maximum timeout period for a retry.

512
MaximumRetryAttemptslongNo

The maximum number of retries.

2
DeadLetterQueueobjectNo

Indicates whether dead-letter queues are enabled. By default, dead-letter queues are disabled. Events 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 are allowed in the batch window. When this threshold is reached, data in the window is pushed to the downstream service. When 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. When 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.

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

The returned response code. The value Success indicates that the request is successful. Other values indicate that the request failed. For more information about error codes, see Error codes.

Success
Successboolean

Indicates whether the request is successful. Valid values: true and false.

true

Examples

Sample success responses

JSONformat

{
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5",
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status codeError codeError message
403ServiceNotEnableService not enable

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

Change history

Change timeSummary of changesOperation
2024-09-10The Error code has changedView Change Details
2024-09-09The Error code has changedView Change Details
2024-08-19The Error code has changedView Change Details
2024-07-12The Error code has changedView Change Details
2024-06-28The Error code has changedView Change Details
2024-05-31The Error code has changedView Change Details
2024-04-09The Error code has changedView Change Details
2024-02-21The Error code has changedView Change Details
2024-01-25The Error code has changedView Change Details
2023-12-28The Error code has changedView Change Details
2023-11-22The Error code has changed. The request parameters of the API has changedView Change Details
2023-10-11The Error code has changedView Change Details
2023-09-13The Error code has changedView Change Details
2023-04-21The Error code has changedView Change Details
2023-04-06The Error code has changedView Change Details