Update the specified Kafka Trigger.

Request description

Request method: POST

Request address: http://open.volcengineapi.com/?Action=UpdateKafkaTrigger&Version=2024-06-06

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameter

Parameter	Type	Required or Not	Sample value	Description
Action	String	Yes	UpdateKafkaTrigger	Interface name. The current API is called UpdateKafkaTrigger.
Version	String	Yes	2024-06-06	Interface version. The current version of the API is 2024-06-06.
FunctionId	String	Yes	wrw******	Function ID. You can call the ListFunctions interface to obtain function ID (Items.Id).
Id	String	Yes	nw******	Kafka Trigger ID. You can call the ListTriggers interface to obtain the Trigger ID.
Enabled	Boolean	No	true	Whether to enable the Trigger while creating it. Value: true: Enable. false: Turn off. tip Only Trigger enabled will work properly.
MaximumRetryAttempts	Integer	No	100	The maximum number of retries when a function has run errors, including user code errors and runtime errors. A positive integer with values ranging from 0 to 100.
Description	String	No	Example Kafka Trigger	Kafka Trigger description. The length is limited to 200 characters.
BatchSize	Integer	No	10	The number of messages per batch consumed by the Trigger in bulk. The recommended value should not exceed 1,000.
BatchFlushDurationMilliseconds	Integer	No	1,000	Maximum waiting time for bulk consumption by Trigger. The unit is millisecond (ms), and the value range is 1,000 to 60,000 ms. The default value is 1,000 ms. warning This parameter only takes effect when the BatchSize parameter has been configured.

Sample request

Response parameter

Parameter	Type	Sample value	Description
FunctionId	String	wrw******	Function ID.
Name	String	reviews-consumer	Kafka Trigger name.
Description	String	Example Kafka Trigger	Kafka Trigger description.
Enabled	Boolean	true	Whether to enable Kafka Trigger. Parameter value description: true: Enabled false: Turned off
MqInstanceId	String	kafka-cnngl4if******	Message queue Kafka instance ID.
TopicName	String	reviews-topic	Topic name of the message queue Kafka instance.
StartingPosition	String	Latest	Start consuming the message located in the Topic. Parameter value description: Latest: Only consume messages generated after subscribing to the Topic. Earliest: Start consuming from the first message produced in the Topic.
MaximumRetryAttempts	Integer	100	The maximum number of retries when a function runs incorrectly.
Id	String	18lt****	Kafka Trigger ID.
ConsumerGroup	String	reviews-topic_18lt****	The consumer group of message queue Kafka instance.
Status	String	pending	Kafka Trigger status. Parameter value description: ready: Running failed: Failed pending: Starting
CreationTime	String	2025-02-03 06:47:41.423691239 +0000 UTC	The creation time for Kafka Trigger. UTC + 0 time in standard RFC3339 format.
LastUpdateTime	String	2025-02-03 06:47:41.423691239 +0000 UTC	The latest update time for Kafka Trigger. UTC + 0 time in standard RFC3339 format.
BatchSize	Integer	10	The number of messages per batch consumed by the Trigger in bulk.
BatchFlushDurationMilliseconds	Integer	1,000	Maximum waiting time for bulk consumption by Trigger. The unit is millisecond.

Sample response

Error code

The current interface temporarily has no independent error code. If the interface calls back abnormally, you can refer to the Public error code to troubleshoot.

Volcano Engine Function as a Service