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
Authorization information
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| EventStreamingName | string | Yes | The name of the event stream. | myeventstreaming |
| Description | string | No | The description of the event stream. | rocketmq2mns |
| FilterPattern | string | Yes | The rule that is used to filter events. If you leave this parameter empty, all events are matched. | |
| Source | object | Yes | The event source, which is also known as the event source. You must and can specify only one event source. | |
| SourceMNSParameters | object | No | The parameters that are configured if you specify Message Service (MNS) as the event source. | |
| RegionId | string | No | The ID of the region where the MNS queue resides. | cn-hangzhou |
| QueueName | string | No | The name of the MNS queue. | queue_api_1642474203601 |
| IsBase64Decode | boolean | No | Specifies whether to enable Base64 encoding. Default value: true. | true |
| SourceRabbitMQParameters | object | No | The parameters that are configured if you specify Message Queue for RabbitMQ as the event source. | |
| RegionId | string | No | The ID of the region where the Message Queue for RabbitMQ instance resides. | cn-hangzhou |
| InstanceId | string | No | The ID of the Message Queue for RabbitMQ instance. | i-f8z9lqkldlb4oxsxwwub |
| VirtualHostName | string | No | The name of the vhost of the Message Queue for RabbitMQ instance. | eb-connect |
| QueueName | string | No | The name of the queue on the Message Queue for RabbitMQ instance. | demo |
| SourceKafkaParameters | object | No | The parameters that are configured if you specify Message Queue for Apache Kafka as the event source. | |
| RegionId | string | No | The ID of the region where the Message Queue for Apache Kafka instance resides. | cn-zhangjiakou |
| InstanceId | string | No | The ID of the Message Queue for Apache Kafka instance. | i-8vbh4a5b9yfhgkkzm98f |
| Topic | string | No | The topic name. | topic_empower_1641539400786 |
| ConsumerGroup | string | No | The group ID of the consumer that subscribes to the topic. | DEFAULT_GROUP |
| OffsetReset | string | No | The offset. | latest |
| Network | string | No | The network setting. Default value: Default. The value PublicNetwork specifies a virtual private cloud (VPC). | Default |
| VpcId | string | No | The VPC ID. | vpc-2ze6p0o345nykmekxtuop |
| VSwitchIds | string | No | The vSwitch ID. | vsw-wz9t1l1e8eu2omwjazmtm |
| SecurityGroupId | string | No | The security group ID. | sg-uf6jcm3y5hcs7hklytxh |
| SourceRocketMQParameters | object | No | The parameters that are configured if you specify Message Queue for Apache RocketMQ as the event source. | |
| RegionId | string | No | The ID of the region where the Message Queue for Apache RocketMQ instance resides. | cn-shanghai |
| InstanceId | string | No | The ID of the Message Queue for Apache RocketMQ instance. | i-f8z9a9mcgwri1c1idd0e |
| Topic | string | No | The topic name. | TOPIC-cainiao-pcs-order-process-inBoundConditionCheck |
| Tag | string | No | The tag that you want to use to filter messages. | test |
| Offset | string | No | The offset from which messages are consumed. Valid values:
Default value: CONSUMEFROMLASTOFFSET. | CONSUMEFROMLASTOFFSET |
| GroupID | string | No | The ID of the consumer group on the Message Queue for Apache RocketMQ instance. | GID_test |
| Timestamp | long | No | The timestamp that specifies the time from which messages are consumed. This parameter is valid only if you set Offset to CONSUMEFROMTIMESTAMP. | 1670656652009 |
| InstanceType | string | No | The instance type. | 2 |
| InstanceEndpoint | string | No | The instance endpoint. | reg****-vpc.cn-zhangjiakou.aliyuncs.com |
| InstanceUsername | string | No | The instance username. | admin |
| InstancePassword | string | No | The instance password. | admin |
| AuthType | string | No | The authentication method. | ACL |
| InstanceVpcId | string | No | The VPC ID of the instance. | vpc-m5e3sv4b12345**** |
| InstanceVSwitchIds | string | No | The vSwitch ID of the instance. | vsw-m5ev8asdc6h12**** |
| InstanceSecurityGroupId | string | No | The security group ID of the instance. | sg-m5edtu24f12345**** |
| InstanceNetwork | string | No | The network type of the instance. Valid values: PublicNetwork and PrivateNetwork. | PublicNetwork |
| SourceMQTTParameters | object | No | The parameters that are configured if you specify Message Queue for MQTT as the event source. | |
| RegionId | string | No | The ID of the region where the Message Queue for MQTT instance resides. | cn-shanghai |
| InstanceId | string | No | The ID of the Message Queue for MQTT instance. | i-bp1dsudbecqwt61jqswt |
| Topic | string | No | The topic name. | topic_empower_1642400400779 |
| SourceDTSParameters | object | No | The parameters that are configured if you specify Data Transmission Service (DTS) as the event source. | |
| TaskId | string | No | The task ID. | f86e5814-b223-482c-b768-3b873297dade |
| BrokerUrl | string | No | The URL and port number of the change tracking instance. | |
| Topic | string | No | The name of the tracked topic of the change tracking instance. | LTC_CACHE_PRD |
| Sid | string | No | The consumer group ID. | hkprdb |
| Username | string | No | The consumer group username. | admin |
| Password | string | No | The consumer group password. | admin |
| InitCheckPoint | long | No | The UNIX timestamp that is generated when the SDK client consumes the first data record. | 1620962769 |
| SourceSLSParameters | object | No | The parameters that are configured if you specify Log Service as the event source. | |
| RoleName | string | No | 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 |
| Sink | object | Yes | The event target. You must and can specify only one event target. | |
| SinkMNSParameters | object | No | The parameters that are configured if the event target is MNS. | |
| QueueName | object | No | The information about the MNS queue. | |
| Value | string | No | The name of the queue in MNS. | MyQueue |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Body | object | No | The message content. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| IsBase64Encode | object | No | Specifies whether to enable Base64 encoding. | |
| Value | string | No | Specifies that Base64 encoding is enabled. | true |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| SinkFcParameters | object | No | The parameters that are configured if the event target is Function Compute. | |
| ServiceName | object | No | The information about the Function Compute service. | |
| Value | string | No | The name of the Function Compute service. | myService |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| FunctionName | object | No | The information about the Function Compute function. | |
| Value | string | No | The name of the Function Compute function. | mFunction |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Concurrency | object | No | The information about the delivery concurrency. | |
| Value | string | No | The delivery concurrency. Minimum value: 1. | 1 |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | None |
| Qualifier | object | No | The information about the service to which the function belongs. | |
| Value | string | No | The alias of the service to which the function belongs. | LATEST |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| InvocationType | object | No | The information about the invocation type. | |
| Value | string | No | The invocation type. Valid values: Sync and Async. | Async |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Body | object | No | The message body that is sent to the function. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| SinkRabbitMQParameters | object | No | The parameters that are configured if the event target is Message Queue for RabbitMQ. | |
| InstanceId | object | No | The information about the Message Queue for RabbitMQ instance. | |
| Value | string | No | The ID of the Message Queue for RabbitMQ instance. | amqp-cn-2r42e73o**** |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| VirtualHostName | object | No | The information about the vhost of the Message Queue for RabbitMQ instance. | |
| Value | string | No | The vhost name of the Message Queue for RabbitMQ instance. | rabbit-host |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| TargetType | object | No | The information about the type of the resource to which events are delivered. | |
| Value | string | No | The type of the resource to which events are delivered. Valid values: Exchange: exchanges. Queue: queues. | Exchange/Queue |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Exchange | object | No | The information about the exchange to which events are delivered. This parameter is available only if you set TargetType to Exchange. | |
| Value | string | No | The name of the exchange in the Message Queue for RabbitMQ instance. | a_exchange |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| RoutingKey | object | No | The information about the routing rule of the message. This parameter is available only if you set TargetType to Exchange. | |
| Value | string | No | The routing rule of the message. | housekeeping |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| QueueName | object | No | The information about the queue to which events are delivered. This parameter is available only if you set TargetType to Queue. | |
| Value | string | No | The name of the queue in the Message Queue for RabbitMQ instance. | MyQueue |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Body | object | No | The message content. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| MessageId | object | No | The message ID. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| Properties | object | No | The properties that are used to filter messages. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| SinkKafkaParameters | object | No | The parameters that are configured if the event target is Message Queue for Apache Kafka. | |
| InstanceId | object | No | The information about the Message Queue for Apache Kafka instance. | |
| Value | string | No | The ID of the Message Queue for Apache Kafka instance. | Defaut_1283278472_sadkj |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Topic | object | No | The information about the topic in Message Queue for Apache Kafka instance. | |
| Value | string | No | The name of the topic in Message Queue for Apache Kafka instance. | test |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Acks | object | No | The information about 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. | |
| Value | string | No | 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 |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Key | object | No | The information about the message key. | |
| Value | string | No | The message key. | key |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Value | object | No | The information about the message value. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| SinkRocketMQParameters | object | No | Sink RocketMQ Parameters | |
| InstanceId | object | No | The parameters that are configured if the event target is Message Queue for Apache RocketMQ. | |
| Value | string | No | The ID of the Message Queue for Apache RocketMQ instance. | MQ_INST_164901546557****_BAAN**** |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Topic | object | No | The information about the topic in the Message Queue for Apache RocketMQ instance. | |
| Value | string | No | The name of the topic in the Message Queue for Apache RocketMQ instance. | Mytopic |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Body | object | No | The message content. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| Properties | object | No | The properties that are used to filter messages. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| Keys | object | No | The properties that are used to filter messages. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| Tags | object | No | The properties that are used to filter messages. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| SinkSLSParameters | object | No | Sink SLS Parameters | |
| Project | object | No | The information about the Log Service project. | |
| Value | string | No | The Log Service project. | test-project |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| LogStore | object | No | The information about the Log Service Logstore. | |
| Value | string | No | The Log Service Logstore. | test-logstore |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Topic | object | No | The information about the topic in which logs are stored. The topic corresponds to the topic reserved field in Log Service. | |
| Value | string | No | The name of the topic in which logs are stored. The topic corresponds to the topic reserved field in Log Service. | testTopic |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| Body | object | No | The message body that is sent to Log Service. | |
| Value | string | No | The value before event transformation. | { "key": "value" } |
| Form | string | No | The method that is used to transform events. | TEMPLATE |
| Template | string | No | The template based on which events are transformed. | The value of ${key} is ${value}! |
| RoleName | object | No | The information about the role. 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. | |
| Value | string | No | 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 |
| Form | string | No | The method that is used to transform events. Default value: CONSTANT. | CONSTANT |
| Template | string | No | None. | |
| RunOptions | object | No | The parameters that are configured for the runtime environment. | |
| MaximumTasks | long | No | The concurrency level. | 2 |
| ErrorsTolerance | string | No | The fault tolerance policy. The value NONE specifies that faults are not tolerated, and the value All specifies that all faults are tolerated. | ALL |
| RetryStrategy | object | No | The information about the retry policy that is used if the event fails to be pushed. | |
| PushRetryStrategy | string | No | The retry policy that is used if an event failed to be pushed. Valid values: BACKOFF_RETRY and EXPONENTIAL_DECAY_RETRY. | BACKOFFRETRY |
| MaximumEventAgeInSeconds | long | No | The maximum period of time during which retries are performed. | 512 |
| MaximumRetryAttempts | long | No | The maximum number of retries. | 2 |
| DeadLetterQueue | object | No | 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 specified by the retry policy is reached. | |
| Arn | string | No | The Alibaba Cloud Resource Name (ARN) of the dead-letter queue. | acs:ram::1317334647812936:role/rdstoecsassumekms |
| BatchWindow | object | No | The information about the batch window. | |
| CountBasedWindow | integer | No | The maximum number of events that is allowed in the batch window. If the value specified by this parameter is reached, the data in the batch window is pushed to the downstream application. If multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows. | 100 |
| TimeBasedWindow | integer | No | The maximum period of time during which events are allowed in the batch window. Unit: seconds. If the value specified by this parameter is reached, the data in the batch window is pushed to the downstream application. If multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows. | 10 |
Response parameters
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 code | Error code | Error message |
|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2024-02-21 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2024-01-25 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-12-28 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-11-22 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-10-11 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-09-13 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-04-21 | The Error code has changed | see changesets | ||||||||
| ||||||||||
| 2023-04-06 | The Error code has changed | see changesets | ||||||||
|