You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
代理运行配置
查询代理运行配置列表 ListAgentRunConfig
复制全文
下载 pdf
查询代理运行配置列表 ListAgentRunConfig
通过自定义条件查询代理运行配置列表。​
使用说明​
调用 CUA OpenAPI 前,必须先访问 跨服务访问请求 为您的账号授权。​
注意事项​
本接口整体 QPS 限制为 100 次/秒、单用户 QPS 限制为 20 次/秒。超过限制,API 调用会被限流。​
请求说明​
  • 请求方式:GET​
  • 请求地址:https://open.volcengineapi.com?Action=ListAgentRunConfig&Version=2023-08-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListAgentRunConfig​
接口名称。当前 API 的名称为 ListAgentRunConfig。​
Version​
String​
是​
2023-08-01​
接口版本。当前 API 的版本为 2023-08-01。​
AgentType​
String​
是​
cua​
Agent 类型,此场景下仅支持 cua。​
ProjectName​
String​
否​
project-a​
项目名称,传入后仅查询指定项目的代理运行配置。​
注意​
若项目名称与代理运行配置不匹配,则不查询任何配置。​
ConfigId​
Integer​
否​
7294***​
代理运行配置 ID,传入 ID 可查询指定代理运行配置信息,不传则查询全部代理运行配置信息。您可以调用 CreateAgentRunConfig 接口获取。​
Limit​
String​
否​
10​
分页查询参数,用于限制每页返回的数据条目数。​
  • 最大值:100。​
  • 默认值:10。​
Offset​
String​
否​
0​
查询结果的起始位置,用于指定从 Offset * Limit 记录开始返回数据,默认值为 0。​
例如 Offset 为 0、Limit 为 10,则表示从第 1 条记录开始。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见 返回结构。​
​
参数名称​
类型​
示例值​
描述​
Total​
Integer​
1​
已配置的代理运行总数。​
List​
Array of Object​
[]​
代理运行配置列表,每项元素结构参见 AgentRunConfig。​
​
AgentRunConfig​
​
参数名称​
类型​
示例值​
描述​
Id​
Integer​
7294***​
代理运行配置 ID。​
AccountId​
String​
210005****​
火山账号 ID。​
UseCase​
String​
screenshots​
存储桶的用途标识,取值:​
  • screenshots:截图,指 CUA 运行过程中产生的截图。​
  • artifacts:产物,指 CUA 运行过程中生成的文件等。​
  • skill:技能,指 CUA 所使用的技能。​
AgentType​
String​
cua​
Agent 类型,此场景下仅支持 cua。​
ProjectName​
String​
project-a​
项目名称。​
TosBucket​
String​
my-bucket​
对象存储 TOS 存储桶名称。​
TosEndpoint​
String​
tos-s***​
对象存储 TOS 访问域名。​
TosRegion​
String​
cn-beijing​
对象存储 TOS 区域。​
​
请求示例​
​
GET https://open.volcengineapi.com?Action=ListAgentRunConfig&Version=2023-08-01​
{​
"AgentType": "cua"​
"Limit": 10,​
"Offset": 0​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ListAgentRunConfig",​
"Version": "2023-08-01",​
"Service": "ipaas",​
"Region": "cn-north-1"​
},​
"Result": {​
"List": [​
{​
"Id": 7294***,​
"AccountId": "xxxxxx",​
"UseCase": "artifacts",​
"AgentType": "cua",​
"ProjectName": "project-a",​
"TosBucket": "my-bucket",​
"TosEndpoint": "tos-s***",​
"TosRegion": "cn-beijing"​
},​
{​
"Id": 7295***,​
"AccountId": "xxxxxx",​
"UseCase": "skill",​
"AgentType": "cua",​
"ProjectName": "project-b",​
"TosBucket": "my-bucket",​
"TosEndpoint": "tos-s***",​
"TosRegion": "cn-beijing"​
},​
{​
"Id": 7296***,​
"AccountId": "xxxxxx",​
"UseCase": "screenshots",​
"AgentType": "cua",​
"ProjectName": "project-c",​
"TosBucket": "my-bucket",​
"TosEndpoint": "tos-s***",​
"TosRegion": "cn-beijing"​
}​
],​
"Total": 3​
}​
}​
​
错误码​
CUA OpenAPI 错误码请参见 错误码。​
最近更新时间:2026.09.29 17:54:39
这个页面对您有帮助吗?
有用
有用
无用
无用