查询代理运行配置列表 ListAgentRunConfig--云手机-火山引擎

文档中心

立即注册

云手机

配置管理

查询代理运行配置列表 ListAgentRunConfig

查询代理运行配置列表。支持设置条件筛选、支持分页查询。

使用说明

调用 Mobile Use 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`。
ConfigId	String	否	123	配置 ID。传入 ID 可查询指定代理运行配置信息，不传值则查询全部代理运行配置信息。
Limit	String	否	10	分页查询参数，用于限制每页返回的数据条目数。最大值：100 默认值：10
Offset	String	否	0	查询结果的起始位置，用于指定从 `Offset * Limit` 记录开始返回数据。默认值为 0。例如 `Offset` 为 0、`Limit` 为 10，则表示从第 1 条记录开始。

返回参数

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

参数名称	类型	示例值	描述
Id	int	8505	配置 ID。
AccountId	String	210005****	火山账号 ID。
MaxStep	Integer	55	最大步骤数。
StepInterval	Integer	3	步骤间隔时间（秒）。
CallbackUrl	String	http://www.example.com	回调 URL 地址。
OutputSchema	String	{}	输出格式。JSON 字符串形式，具体参数参考通用数据结构中的OutputSchema。
RetryLimit	Integer	3	重试次数限制。
SystemPrompt	String	你是个测试专家	系统提示词。
TosBucket	String	my-bucket	TOS 存储桶名称。
TosEndpoint	String	tos-s3-cn-beijing.volces.com	TOS 端点地址。
TosRegion	String	cn-beijing	TOS 区域。

请求示例

GET https://open.volcengineapi.com?Action=ListAgentRunConfig&Version=2023-08-01&ConfigId=123&Limit=10&Offset=0

返回示例

{
        "ResponseMetadata": {
                "RequestId": "20230604110420****100232280022D31",
                "Action": "ListAgentRunConfig",
                "Version": "2023-08-01",
                "Service": "ipaas",
                "Region": "cn-north-1"
        },
        "Result": {
                "List": [{
                        "Id": 8505,
                        "AccountId": "210005****",
                        "MaxStep": 55,
                        "StepInterval": 5,
                        "CallbackUrl": "http://www.example.com",
                        "OutputSchema": "{}",
                        "RetryLimit": 3,
                        "SystemPrompt": "你是个测试专家",
                        "TosBucket": "my-bucket",
                        "TosEndpoint": "tos-s3-cn-beijing.volces.com",
                        "TosRegion": "cn-beijing"
                }],
                "Total": 1
        }
}

错误码

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

最近更新时间：2025.11.17 14:12:57

这个页面对您有帮助吗？

有用

无用