查询任务列表信息 ListTask--云手机-火山引擎

文档中心

立即注册

导航

查询任务列表信息 ListTask

最近更新时间：2025.06.03 15:01:48首次发布时间：2024.05.08 16:20:06

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

注意事项

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

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListTask&Version=2023-10-30

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListTask`	接口名称。当前 API 的名称为 `ListTask`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`15914953669544xxxxxx`	筛选条件，业务ID，可在「云手机控制台-业务管理-业务详情」中获取。
TaskId	String	否	`7294157141458xxxxxx`	筛选条件，任务 ID，在任务创建后返回。
TaskAction	String	否	`InstallApp`	筛选条件，任务类型，一般为创建任务接口的 Action，如：创建实例并部署应用：`CreatePodOneStep` 实例重置：`ResetPod` 清理用户数据：`PodDataDelete` 实例数据迁移：`PodDataTransfer` 应用上传：`UploadApp` 应用安装：`InstallApp` 启动应用：`LaunchApp` 关闭应用：`CloseApp` 应用卸载：`UninstallApp` 推送文件：`PushFile` 下载文件：`PullFile` 开始指令同步：`StartPodEventSync` 更新指令同步：`UpdatePodEventSync`
TaskResult	Long	否	`100`	筛选条件，任务状态；任务进度，0~100，100为任务完成。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

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

参数	类型	示例值	描述
Total	Integer	`1`	查询结果总量。
Row	Array of Task	`-`	查询到的任务信息列表，详情参看 `Task` 数据类型。

Task

参数	类型	示例值	描述
TaskId	String	`7307092446734xxxxxx`	返回的任务 ID。
EndTime	Long	`1701315270`	任务结束时间（UTC）。
StartTime	Long	`1701315257`	任务开始时间（UTC）。
TaskAction	String	`InstallApp`	任务类型。
TaskResult	Integer	`100`	任务执行进度。 100：执行完成； <0：执行失败： -1：通用失败；其他：待定。

请求示例

GET https://open.volcengineapi.com?Action=ListTask&Version=2023-10-30&ProductId=15914953669544xxxxxx&TaskId=7294157141458xxxxxx&TaskAction=InstallApp&TaskResult=100&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "Action": "ListTask",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "Total": 1,
        "Row": [
            {
                "TaskId": "7307092446734xxxxxx",
                "EndTime": 1701315270,
                "StartTime": 1701315257,
                "TaskAction": "InstallApp",
                "TaskResult": 100
            }
        ]
    }
}

错误码

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