Obtain a list of asynchronous tasks.

Request description

Request method: POST

Request URL: http://open.volcengineapi.com/?Action=ListAsyncTasks&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 parameters

Parameter	Type	Require or Not	sample value	Description
Action	String	Yes	ListAsyncTasks	Interface name. The name of the API is ListAsyncTasks.
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).
Filter	Object of ListAsyncTasksFilter	No	-	Filter conditions for querying asynchronous tasks.
OrderBy	Object of OrderBy	No	-	Parameter configuration for sorting the asynchronous tasks that have been queried.
PageNumber	Integer	No	1	The starting page number for paginated queries. The default value is 1.
PageSize	Integer	No	20	Number of records displayed per page in paginated queries. Available values: Minimum value: 1 Maximum value: 100 Default value: 20

ListAsyncTasksFilter

Parameter	Type	Require or Not	Sample value	Description
Status	Array of String	No	["Pending", "Running", "Succeeded", "Failed", "Terminated", "Unknown"]	Task status. Available values: Pending: The task is waiting to be executed. Running: The task is in progress. Succeeded: The task has been executed successfully. Failed: Task execution failed. Terminated: The task has been terminated. Unknown: An unknown error occurred. tip Multiple statuses are allowed in a request with half-width commas as separators (,).,
RequestId	String	No	634f6fbf-e7fa-4d87-85e3-******	ID of the task to be queried. This parameter is used to query the status of a single task. Task IDs can be found by going to Volcano Engine Function as a Service (veFaaS) console, selecting "Function" in the left navigation bar and clicking the function name to open the details page, and then going to Asynchronous task tab.
SubmitTimeBegin	Long	No	1751853600	Filter by the time range in which tasks were submitted. Set the start time of the time range: Format: Unix timestamp. Unit: second.
SubmitTimeEnd	Long	No	1752458400	Filter by the time range in which tasks were submitted. Set the end time of the time range: Format: Unix timestamp: Unit: second.

OrderBy

Parameter	Type	Require or Not	Sample value	Description
Key	String	Yes	SubmitTime	The sorting keys for the task list. Available values: SubmitTime: Sort by task submission time. warning The parameter Key is required in OrderBy,
Ascend	Boolean	No	true	Specify the order direction of the returned task list. Available values: false: (default) descending order true: ascending order

Sample request

Response parameters

Parameter	Type	Sample value	Description
Items	Array of AsyncTask	-	Task list.
Total	Integer	1,000	Number of tasks.

AsyncTask

Parameter	Type	Sample value	Description
Status	String	Succeeded	Task status.
RequestId	String	634f6fbf-e7fa-4d87-85e3-******	Task ID.
SubmitTime	String	2025-07-10 11:42:08.575 +0000 UTC	Task submission time.
EndTime	String	2025-07-10 11:44:08.579 +0000 UTC	Task end time.
ExecutionRecords	Array of ExecutionRecord	-	Task execution records.

ExecutionRecord

Parameter	Type	sample value	Description
Status	String	Succeeded	Execution status of a single task.
Command	String	./run.sh	Commands executed in the task.
StartTime	String	2025-07-10 11:42:08.575 +0000 UTC	Start time of a single task.
EndTime	String	2025-07-10 11:44:08.579 +0000 UTC	End time of a single task.
ErrorMessage	String	error executing command ./dummy_run.sh: exit status 127, please check the logs for more details	The error message of the task.
InstanceName	String	wrwskdhbd-vd9qztck6t-******	The instance name of the task.
RevisionNumber	Integer	1	The instance version of the task.

Sample response

Error code

There is no error code dedicated to this interface currently. If you encounter an exception when calling the interface, you can refer to public error code for troubleshooting.

Volcano Engine Function as a Service