查询代理任务列表 ListAgentRunTask--云手机-火山引擎

文档中心

立即注册

导航

查询代理任务列表 ListAgentRunTask

最近更新时间：2025.11.17 14:12:57首次发布时间：2025.11.17 14:12:57

查询代理任务列表。支持设置条件筛选、支持分页查询。

使用说明

调用 Mobile Use OpenAPI 前，必须先访问跨服务访问请求为您的账号授权。

注意事项

本接口整体 QPS 限制为 100 次/秒、单用户 QPS 限制为 20 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListAgentRunTask&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListAgentRunTask	接口名称。当前 API 的名称为 `ListAgentRunTask`。
Version	String	是	2023-08-01	接口版本。当前 API 的版本为 `2023-08-01`。
RunId	String	否	run-123456	运行 ID。传入 ID 可查询指定代理任务的运行信息，不传值则查询全部代理任务的运行信息。
ThreadId	String	否	thread-123	线程 ID。字符长度限制：1 ~ 63
PodId	String	否	pod-789	实例 ID。字符长度限制：1 ~ 63
Status	Integer	否	1	任务状态。取值范围： 1：任务已创建（created） 2：任务正在运行（running） 3：任务已完成（completed） 4：任务取消中（cancelling） 5：任务已被取消（cancelled） 6：任务已失败（failed） 7：任务已中断（interrupted）
Limit	Integer	否	10	分页查询参数，用于限制每页返回的数据条目数。最大值：100 默认值：10
Offset	Integer	否	0	查询结果的起始位置，用于指定从 `Offset * Limit` 记录开始返回数据。默认值为 0。例如 `Offset` 为 0、`Limit` 为 10，则表示从第 1 条记录开始。

返回参数

公共返回参数信息请见返回结构，其中 Result 包含的参数说明如下。

参数名称	类型	示例值	描述
AccountId	String	210005****	火山账号 ID。
RunId	String	756730042291063****	运行 ID。
RunName	String	测试****	运行名称。
ThreadId	String	9543****	线程 ID。
Status	String	4	任务状态。可能值： 1：任务已创建（created） 2：任务正在运行（running） 3：任务已完成（completed） 4：任务取消中（cancelling） 5：任务已被取消（cancelled） 6：任务已失败（failed） 7：任务已中断（interrupted）
PodId	String	756324785061411****	实例 ID。字符长度限制：0 ~ 63
ProductId	String	198018901670363****	业务 ID。字符长度限制：0 ~ 63
UserPrompt	String	打开XX地图，导航到XX	用户提示词。
CreatedAt	String	2025-10-31 16:30:28 +0800 CST	任务创建时间。
StartedAt	String	2025-10-31 16:31:28 +0800 CST	任务开始时间。
UpdatedAt	String	2025-10-31 16:40:28 +0800 CST	任务最新更新时间。
CompletedAt	String	2025-10-31 16:39:28 +0800 CST	任务完成时间。

请求示例

GET https://open.volcengineapi.com?Action=ListAgentRunTask&Version=2023-08-01&RunId=run-123456&ThreadId=thread-123&PodId=pod-789&Status=1&Limit=10&Offset=0

返回示例

{
        "ResponseMetadata": {
                "RequestId": "2023061111****",
                "Action": "ListAgentRunTask",
                "Version": "2023-08-01",
                "Service": "ipaas",
                "Region": "cn-north-1"
        },
        "Result": {
                "List": [{
                        "AccountId": "210005****",
                        "RunId": "756730042291063****",
                        "ThreadId": "9543****",
                        "RunName": "测试****",
                        "Status": 4,
                        "PodId": "756324785061411****",
                        "ProductId": "198018901670363****",
                        "UserPrompt": "打开XX地图，导航到XX",
                        "CreatedAt": "2025-10-31 16:30:28 +0800 CST",
                        "StartedAt": "2025-10-31 16:31:28 +0800 CST",
                        "UpdatedAt": "2025-10-31 16:40:28 +0800 CST",
                        "CompletedAt": "2025-10-31 16:39:28 +0800 CST"
                }],
                "Total": 1
        }
}

错误码

Mobile Use OpenAPI 错误码请参见错误码；更多错误码信息，可访问公共错误码。