Call the UpdateTimer interface to update the configuration of Timer trigger.

Request description

Request method: POST

Request address: http://open.volcengineapi.com/?Action=UpdateTimer&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	UpdateTimer	Interface name. The current API is called UpdateTimer.
Version	String	Yes	2024-06-06	Interface version. The current version of the API is 2024-06-06.
FunctionId	String	Yes	wr******	The ID of the function to which the Timer trigger belongs.
Id	String	Yes	nw******	Timer Trigger ID.
Description	String	No	Timer trigger	The remarks information for the Timer trigger.
Enabled	Boolean	No	true	Whether the Timer trigger is enabled or not. true: Enabled false: Turned off.
Crontab	String	No	/5 * * *	Timer trigger trigger time. The time format is crontab expression, and you can access crontab.guru to view the meanings of crontab expression.
Payload	String	No		The Timer trigger sends requested payload, that is, a trigger message.
EnableConcurrency	Boolean	No	false	Whether the Timer trigger allows concurrency. true: allows concurrency false: concurrency is prohibited.
Retries	Integer	No	0	The number of retries for the Timer trigger.

Sample request

Response parameter

Parameter	Type	Sample value	Description
FunctionId	String	wr******	Function ID.
Id	String	nw******	Timer trigger ID.
Name	String	doc-timer	Timer trigger name.
Description	String	Timer Trigger	The remarks information for the Timer trigger.
Enabled	Boolean	true	Whether the Timer trigger has been turned on. true indicates it is turned on.
Crontab	String	/5 * * *	The execution time of Trimer trigger, in the format crontab expression.
Payload	String		The Timer trigger sends requested payload, that is, a trigger message.
CreationTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	Timer trigger creation time.
LastUpdateTime	String	2024-06-14 15:31:07.143863441 +0800 CST m=+88714.902440864	Timer trigger update time.
EnableConcurrency	Boolean	true	Whether the Timer trigger allows concurrency. true indicates it allows concurrency.
Retries	Integer	0	The number of retries for the Timer trigger.

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