You need to enable JavaScript to run this app.
Volcano Engine Function as a Service

Volcano Engine Function as a Service

Copy page
Download PDF
Timer trigger
GetTimer
Copy page
Download PDF
GetTimer
Call the GetTimer interface to obtain Timer trigger details.​
Request description​
  • Request method: POST​
  • Request address: http://open.volcengineapi.com/?Action=GetTimer&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.
​
Request parameter​
​
Parameter​
Type​
Required or Not​
Sample value​
Description​
Action​
String​
Yes​
GetTimer​
Interface name. The current API is called GetTimer.​
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​
nwwz**​
Timer trigger ID.​
​
Sample request​
​
POST http://open.volcengineapi.com/?Action=GetTimer&Version=2024-06-06 HTTP/1.1​
Content-Type: application/json​
{​
"FunctionId": "wr******",​
"Id": "nwwz**"​
}​
​
Response parameter​
​
Parameter​
Type​
Sample value​
Description​
FunctionId​
String​
wrwsk**​
Function ID.​
Id​
String​
nwwzo**​
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 trigger time of Timer trigger, in the format crontab expression.​
Payload​
String​
​
The Timer trigger sends the requested payload, which is the 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​
​
HTTP/1.1 200 OK​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "2024112916192814CC1E0FD73**",​
"Action": "GetTimer",​
"Version": "2024-06-06",​
"Service": "vefaas",​
"Region": "cn-Beijing"​
},​
"Result": {​
"FunctionId": "qt ******",​
"Id": "in ******",​
"Name": "doc-timer",​
"Description": "Timer Trigger",​
"Enabled": true,​
"Crontab": "*/5 * * * *",​
"Payload": "",​
"CreationTime": "2024-11-29 08:16:31.54 + 0000 UTC",​
"LastUpdateTime": "2024-11-29 08:16:31.54 + 0000 UTC",​
"EnableConcurrency": false,​
"Retries": 0​
}​
}​
​
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 troublehshoot.​
Last updated: 2025.06.30 11:37:44