文档中心

云手机

任务管理

查询任务列表信息 ListTask

查询任务列表信息 ListTask

查询实例、应用等相关任务的列表信息。

注意事项

本接口仅支持查询 7 天内发起的任务列表信息，超过 7 天的任务信息会自动清除。

请求说明

请求地址：https://open.volcengineapi.com?Action=ListTask&Version=2025-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListTask	接口名称。当前 API 的名称为 ListTask。
Version	String	是	2025-05-01	接口版本。当前 API 的版本为 2025-05-01。
ProductId	String	是	7658996557xxxxxx	筛选条件，业务 ID，管理云手机资源、开展云手机业务的标识。可登录云手机控制台，在已创建的业务卡片中获取。
TaskId	String	否	7294157141458xxxxxx	筛选条件，任务 ID。该 ID 在任务创建后由系统返回。
TaskAction	String	否	InstallApp	筛选条件，指定任务类型，一般为创建任务接口的 Action，例如：创建安卓实例并部署应用：CreatePodOneStep 实例重置：ResetPod 清理用户数据：PodDataDelete 实例数据复制迁移：PodDataTransfer 上传应用：UploadApp 安装应用：InstallApp 启动应用：LaunchApp 关闭应用：CloseApp 卸载应用：UninstallApp 上传文件：PushFile 下载文件：PullFile 说明不传该参数时默认查询所有类型的任务。
TaskResult	Long	否	100	筛选条件，表示任务的状态或进度。取值范围为 0 到 100，其中 100 表示任务已完成。
StartTime	Long	否	1701315257	任务创建时间的起始时间戳，用于筛选在此时间之后创建的任务。未指定时，默认值为三小时前的时间。时间戳格式为 Unix 时间戳，单位为秒。
EndTime	Long	否	1701315270	任务创建时间的结束时间戳，用于筛选在此时间之前创建的任务。未指定时，默认值为当前时间。时间戳格式为 Unix 时间戳，单位为秒。
MaxResults	Integer	否	20	分页查询时设置的每页行数。取值范围为 1 到 100，默认值为 10。
NextToken	String	否	eyJ0YXNrSWQiOiAiNzI5NDE1NzE0MTQ1OHh4eHh4eCIsICJ0aW1lc3RhbXAiOiAxNzAxMzE1MjU3fQ==	分页查询凭证，用于标记分页的位置。初次调用该接口时无需设置。下次查询时，取值为上一次 API 调用返回的 NextToken 参数值。如果 NextToken无效，会从第一条记录开始返回，不会产生错误。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of Task	-	查询到的任务信息列表，详情参看 Task 数据类型。
NextToken	String	eyJ0YXNrSWQiOiAiNzI5NDE1NzE0MTQ1OHh4eHh4eCIsICJ0aW1lc3RhbXAiOiAxNzAxMzE1MjU3fQ==	分页查询凭证，用于标记分页的位置。初次调用该接口时无需设置。下次查询时，取值为上一次 API 调用返回的 NextToken 参数值。如果 NextToken无效，会从第一条记录开始返回，不会产生错误。

Task

参数	类型	示例值	描述
TaskId	String	7307092446734xxxxxx	返回的任务 ID。
EndTime	Long	1701315270	任务结束时间（UTC）。
StartTime	Long	1701315257	任务开始时间（UTC）。
TaskAction	String	InstallApp	任务的操作类型，表示当前任务的具体动作。例如 InstallApp表示安装应用任务。
TaskResult	Integer	100	任务执行的进度，取值如下： 100：执行完成 <0：执行失败： -1：通用失败其他：待定

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.04.10 11:07:02

这个页面对您有帮助吗？

有用

有用

无用

无用