文档中心

函数服务

异步任务

ListAsyncTasks

ListAsyncTasks

获取异步任务列表。

请求说明

请求方式：POST

请求地址：http://open.volcengineapi.com/?Action=ListAsyncTasks&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListAsyncTasks	接口名称。当前 API 的名称为 ListAsyncTasks。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 2024-06-06。
FunctionId	String	是	wrw******	函数 ID。可以调用 ListFunctions 接口，获取函数 ID（Items.Id）。
Filter	Object of ListAsyncTasksFilter	否	-	查询异步任务的过滤条件。
OrderBy	Object of OrderBy	否	-	将查询到的异步任务进行排序的参数配置。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	20	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：20

ListAsyncTasksFilter

参数	类型	是否必选	示例值	描述
Statuses	Array of String	否	["Pending", "Running", "Succeeded", "Failed", "Terminated", "Unknown"]	任务状态。取值： Pending：任务正在等待执行。 Running：任务正在执行中。 Succeeded：任务已执行成功。 Failed：任务执行失败。 Terminated：任务已终止。 Unknown：发生未知错误。说明支持填写多个状态，多个状态之间使用半角逗号（,）分割。
RequestId	String	否	634f6fbf-e7fa-4d87-85e3-******	待查询任务的 ID。该参数用于查询单个任务状态。在函数服务控制台的目标函数详情页面异步任务页签，查看任务 ID。
SubmitTimeBegin	Long	否	1751853600	通过提交任务的时间区间进行筛选。设置时间区间的起始时间：格式：Unix 时间戳。单位：秒。
SubmitTimeEnd	Long	否	1752458400	通过提交任务的时间区间进行筛选。设置时间区间的结束时间：格式：Unix 时间戳：单位：秒。

OrderBy

参数	类型	是否必选	示例值	描述
Key	String	是	SubmitTime	对任务进行排序的基础选项，取值： SubmitTime：基于任务提交时间进行排序。注意配置 OrderBy 参数时，Key 为必填参数。
Ascend	Boolean	否	true	基于基础选项筛选出的数据，进行排序。取值： false：（默认）降序排序 true：升序排序

请求示例

返回参数

参数	类型	示例值	描述
Items	Array of AsyncTask	-	任务列表。
Total	Integer	1000	任务数量。

AsyncTask

参数	类型	示例值	描述
Status	String	Succeeded	任务状态。
RequestId	String	634f6fbf-e7fa-4d87-85e3-******	任务 ID。
SubmitTime	String	2025-07-10 11:42:08.575 +0000 UTC	任务提交时间。
EndTime	String	2025-07-10 11:44:08.579 +0000 UTC	任务结束时间。
ExecutionRecords	Array of ExecutionRecord	-	任务执行记录。

ExecutionRecord

参数	类型	示例值	描述
Status	String	Succeeded	单次任务的执行状态。
Command	String	./run.sh	任务的命令。
StartTime	String	2025-07-10 11:42:08.575 +0000 UTC	单次任务执行开始时间。
EndTime	String	2025-07-10 11:44:08.579 +0000 UTC	单次任务执行结束时间。
ErrorMessage	String	error executing command ./dummy_run.sh: exit status 127, please check the logs for more details	任务的错误信息。
InstanceName	String	wrwskdhbd-vd9qztck6t-******	任务的实例名称。
RevisionNumber	Integer	1	任务的实例版本号。

返回示例

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

最近更新时间：2025.07.25 17:39:44

这个页面对您有帮助吗？

有用

有用

无用

无用