【旧版】任务列表查询 ListTask--云手机-火山引擎

文档中心

立即注册

导航

云手机

【旧版】任务列表查询 ListTask

最近更新时间：2024.06.17 19:36:21首次发布时间：2023.06.14 12:45:19

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

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	ListTask
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01
product_id	Query	string	是	业务 ID	例：client-demo
task_id	Query	string	否	筛选条件，任务 ID	任务 ID，在任务创建后返回
task_action	Query	string	否	筛选条件，任务类型	任务类型，一般为创建任务接口的 Action，如：创建实例并部署应用：CreatePodOneStep 实例重置：ResetPod 实例迁移：PodDataTransfer 清理用户数据：PodDataDelete 应用上传：UploadApp 应用安装：InstallApp 启动应用：LaunchApp 关闭应用：CloseApp 应用卸载：UninstallApp 推送文件：PushFile 下载文件：PullFile 开始指令同步：StartPodEventSync 更新指令同步：UpdatePodEventSync
task_result	Query	int32	否	筛选条件，任务状态	任务进度，0~100，100为任务完成
offset	Query	int64	否	筛选条件，分页参数
count	Query	int64	否	筛选条件，分页参数

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
total	Integer	查询结果总量
row	`List<Task>`	查询到的任务信息列表，详细信息，参考 Task 定义

示例

请求示例

GET https://open.volcengineapi.com?Action=ListTask
&Version=2022-08-01
&product_id=15914953669544xxxxxx
&task_action=InstallApp
&task_result=100
&<通过header传入的公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "Action": "ListTask",
        "Region": "cn-north-1",
        "RequestId": "202311301531282136E51F7A2DB7EE6D55",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "row": [
            {
                "task_id": "7307092446734xxxxxx",
                "task_action": "InstallApp",
                "task_result": 100,
                "start_time": 1701315257,
                "end_time": 1701315270
            },
            {
                "task_id": "7304932680418xxxxxx",
                "task_action": "InstallApp",
                "task_result": 100,
                "start_time": 1700812322,
                "end_time": 1700812770
            }
        ],
        "total": 2
    }
}