You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
Tool
ListTools - 批量查询工具详情
复制全文
下载 pdf
ListTools - 批量查询工具详情
通过自定义筛选条件批量查询工具详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListTools​
要执行的操作,取值:ListTools。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
CreateTimeAfter string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点后创建的工具。(RFC3339格式)​
​
CreateTimeBefore string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点前创建的工具。(RFC3339格式)​
​
Filters.N.Name string[] 可选 示例值:Name​
精确过滤的字段名,取值:​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • Id:工具ID。​
  • Name:工具名称。​
  • Description:工具描述。​
  • Status:工具状态。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.NameContains string[] 可选 示例值:Status​
模糊过滤的字段名,取值:​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • Id:工具ID。​
  • Name:工具名称。​
  • Description:工具描述。​
  • Status:工具状态。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.Values.N string[] 可选 示例值:Ready​
过滤字段的值。​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔。​
当过滤字段为Status时,取值:​
  • Creating:创建中。​
  • Error:错误。​
  • Ready:运行中。​
  • Deleting:删除中。​
  • Updating:更新中。​
​
MaxResults integer 可选 示例值:10​
分页查询时设置的每页行数。​
  • 最小值:1。​
  • 最大值:100。​
  • 默认值:100。​
​
NextToken string 可选 示例值:unique-token​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
UpdateTimeAfter string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点前更新的工具。(RFC3339格式)​
​
UpdateTimeBefore string 可选 示例值:2006-01-02T15:04:05Z07:00​
筛选该时间点前更新的工具。(RFC3339格式)​
​
ProjectName string 可选 示例值:default​
所属项目名称。​
​
TagFilters.N.Key string[] 可选 示例值:TagFilters.1.Key=k1​
为资源添加标签键。​
  • 参数 - N:表示标签键的序号。​
  • 取值范围:1~10,多个标签键之间用&分隔。​
  • 不允许重复。​
​
TagFilters.N.Values.N string[] 可选 示例值:TagFilters.1.Values.1=v1​
为资源添加标签键。​
  • 第一个N:表示标签键的序号,取值范围:1~10。​
  • 第二个N:表示标签值的序号,同一标签键最多支持同时查询3个标签值。取值范围:1~3。​
  • 多个标签值之间用&分隔。​
说明​
  • 如果传入该参数,则必须先传入TagFilters.N.Key。​
  • 不传则表示查询同一标签键下的所有标签值。​
  • 传入空字符串时,表示查询标签值为空的标签。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
NextToken string 示例值:bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******​
本次调用返回的查询凭证值,返回为空表示该页为末页。​
​
Tools object[] 示例值:--​
符合条件的工具信息。​
ApmplusEnable boolean 示例值:true​
是否开启日志服务。取值:​
  • true:开启。​
  • false:未开启。​
​
AuthorizerConfiguration object 示例值:--​
工具入站身份认证信息。目前支持API Key认证配置。​
KeyAuth object 示例值:--​
API Key认证配置。​
ApiKey string 示例值:22243eefff**​
API Key的值。​
​
ApiKeyLocation string 示例值:header​
API Key传递的位置。取值:​
  • Header:当前仅支持Header。​
​
ApiKeyName string 示例值:test-key​
API Key名称。​
​
​
​
Command string 示例值:./run.sh​
工具启动命令。​
说明​
当工具类型为自定义工具时有返回值。​
​
CreatedAt string 示例值:2006-01-02T15:04:05Z07:00​
工具创建时间。​
​
Description string 示例值:this is a tool​
工具的描述。​
​
EnableSnapshot boolean 示例值:true​
是否在实例过期前自动创建快照。​
  • true:创建。​
  • false:不创建。​
​
Envs object[] 示例值:--​
工具的环境变量。​
Key string 示例值:k1​
环境变量的键。​
​
Value string 示例值:v1​
环境变量的值。​
​
​
ImageUrl string 示例值:http://***​
工具镜像地址。​
说明​
当工具类型为自定义工具时有返回值。​
​
ModelAgentName string 示例值:doubao-seed-1.6​
推理模型接入点。​
​
Name string 示例值:tool-test​
工具名称。​
​
NetworkConfigurations object[] 示例值:--​
工具访问信息。​
Endpoint string 示例值:http://sd3qupshmeps3v7l9****.apigateway-cn-beijing.volceapi.com​
工具访问域名。​
​
NetworkType string 示例值:public​
工具访问域名的类型,取值:​
  • public:公网访问。​
  • private:私网访问。​
​
VpcConfiguration object 示例值:--​
VPC私网配置。​
EnableSharedInternetAccess boolean 示例值:true​
公网出口配置。取值:​
  • ture:开启,表示工具使用平台提供的公网出口访问公网。​
  • false:未开启,表示工具使用私有网络中已配置的公网NAT网关出口访问公网。​
说明​
仅当网络配置为私网访问时有返回。​
​
SecurityGroupIds string[] 示例值:["sg-w08tvkc3e****"]​
安全组ID列表。​
​
SubnetIds string[] 示例值:["subnet-1234567890"]​
子网ID列表。​
​
VpcId string 示例值:vpc-257gqcdfvx6n****​
VPC的ID。​
​
​
​
Port integer 示例值:8000​
工具监听端口。​
说明​
当工具类型为自定义工具时有返回值。​
​
ProjectName string 示例值:default​
工具所属项目名称。​
​
RoleName string 示例值:MyTestRole​
工具绑定的IAM角色名称。​
​
Status string 示例值:Ready​
工具状态,取值:​
  • Creating:创建中。​
  • Error:错误。​
  • Ready:运行中。​
  • Deleting:删除中。​
  • Updating:更新中。​
​
Tags object[] 示例值:--​
工具标签。​
Key string 示例值:k1​
标签键。​
​
Type string 示例值:system​
标签类型。​
  • system:系统标签。​
  • custom:用户标签。​
​
Value string 示例值:v1​
标签值。​
​
​
ToolId string 示例值:t-3tigy72q3u3vj0x2****​
工具的ID。​
​
ToolType string 示例值:All-in-one​
工具类型。取值:​
  • All-in-one:一体化工具集,即预置工具AIO Sandbox。​
  • Skill: Skill工具镜像,即预置工具Skills Sandbox。​
  • Private: 自定义工具。​
  • CodeEnv:预置工具Code Sandbox。​
​
UpdatedAt string 示例值:2006-01-02T15:04:05Z07:00​
工具的更新时间。​
​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=ListTools&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json​
{​
"Filters": [​
{​
"Name": "Name",​
"Values": [​
""​
]​
}​
]​
}​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202106111445100102252431000052****",​
"Action": "ListTools",​
"Version": "2025-10-30",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"Tools": [​
{​
"ToolId": "t-ye9qwatywwb6wrvc****",​
"Name": "test-name",​
"Description": "",​
"Status": "Ready",​
"ToolType": "All-in-one",​
"AuthorizerConfiguration": {​
"KeyAuth": {​
"ApiKey": "",​
"ApiKeyLocation": "header",​
"ApiKeyName": "test-api-key"​
},​
},​
"RoleName": "",​
"CreatedAt": "2025-11-23T16:55:21+08:00",​
"UpdatedAt": "2025-11-23T16:55:29+08:00",​
"Tags": [],​
"ImageUrl": "enterprise-cn-beijing.cr.volces.com/vefaas-public/all-in-one-sandbox:1.0.0.126",​
"Command": "/opt/gem/run.sh",​
"Port": 8080,​
"Envs": [],​
"ProjectName": "default",​
"ApmplusEnable": false,​
"NetworkConfigurations": [​
{​
"NetworkType": "public",​
"Endpoint": "https://sd4hcnv3318ffuppa***.apigateway-cn-beijing.volceapi.com",​
"VpcConfiguration": {​
"VpcId": "vpc-1unjb731ek1s51j8e75l****",​
"SubnetIds": [​
"subnet-w0eiz5pvhlhc865ykakf****"​
],​
"SecurityGroupIds": [​
"sg-1c11cukupn1ts5e8j711g****"​
]​
}​
}​
]​
}​
],​
"NextToken": "dC15ZTdjZ2xlM3VvYzFrZHRvcn****=="​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
LimitExceeded.MaximumFilters​
The number of specified Filters exceeds the maximum limit.​
指定的Filters超过最大限制。​
400​
InvalidTagFilterKey.Malformed​
The specified TagFilterKey is malformed.​
指定TagFilterKey不合法。​
​
​
最近更新时间:2026.09.23 18:59:28
这个页面对您有帮助吗?
有用
有用
无用
无用