AgentKit
AgentKit
文档指南
请输入
- 文档首页
AgentKitAgentKit开发者指南API参考Sandbox ToolGetTool - 查询工具详情
复制全文
下载 pdfGetTool - 查询工具详情
文档反馈
问问助手查询工具详情。
请求参数
Action string 必选 示例值：GetTool
要执行的操作，取值：GetTool。
Version string 必选 示例值：2025-10-30
API的版本，取值：2025-10-30。
ToolId string 必选 示例值：t-3tigy72q3u3vj0x2****
工具ID。
返回参数
CpuMilli integer 示例值：1000
单实例最大CPU。单位：milli cpu。
MemoryMb integer 示例值：2048
单实例最大内存，单位 MB。
ApmplusEnable boolean 示例值：true
是否开启日志服务。取值：
- true：开启。
- false：未开启。
AssociatedRuntimes object[] 示例值：--
工具关联的智能体运行时。
Id string 示例值：r-ye7agye1a8cr38iu****
运行时ID。
Name string 示例值：runtime-01
运行时名称。
AuthorizerConfiguration object 示例值：--
工具入站身份认证信息。目前支持API Key认证配置。
CustomJwtAuthorizer object
Inbound 认证信息，CustomJWTAuthorizer方式
AllowedClients string[]
允许访问的客户端列表
DiscoveryUrl string
认证服务地址
KeyAuth object 示例值：--
API Key认证配置。
ApiKey string 示例值：22243eefff**
API Key的值。
ApiKeyLocation string 示例值：Header
API Key传递的位置。当前只支持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 示例值：false
是否在实例过期前自动创建快照。
- 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[] 示例值：--
工具访问信息，包括公网和VPC。
Endpoint string 示例值：https://sd3p0u******.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 示例值：AgentKit-Runtime-Default-ServiceRole-xbv8s36
工具绑定的IAM角色名称。
SkillSpaceId string 示例值：ss-yedd6rcsu8****
Skills空间的ID。
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。
TosMountConfig object 示例值：--
TOS挂载配置。
Credentials object 示例值：--
TOS凭证。
AccessKeyId string 示例值：GY2OGJiOTdl****
平台的Access Key ID。
SecretAccessKey string 示例值：emRoTnpVNU5HU****
平台的Secret Access Key ID。
EnableTos boolean 示例值：true
是否启用TOS挂载。挂载后，工具实例对应目录产生的数据将存储至TOS服务。取值：
- true：开启。
- false：不开启。
MountPoints object[] 示例值：--
TOS挂载点列表。
BucketName string 示例值：bucket01
TOS存储桶名称。
BucketPath string 示例值：http://tos-cn-beijing.ivolces.com
TOS存储桶路径。
Endpoint string 示例值：tmp/abc
TOS存储桶子目录。
LocalMountPath string 示例值：/home/app
待挂载的工具实例本地目录。
ReadOnly boolean 示例值：false
指定待挂载的Sandbox工具实例的访问权限。取值：
- true：只读权限。
- false：读写权限。
UpdatedAt string 示例值：2006-01-02T15:04:05Z07:00
工具的更新时间。
请求示例
POST https://agentkit.cn-beijing.volcengineapi.com?Action=GetTool&Version=2025-10-30 HTTP/1.1
Content-Type: application/json
{
"ToolId": "t-ye6xzwchkwoaroxxxxxx"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "20251027142329504394C726CC0349****",
"Action": "GetTool",
"Version": "2025-10-30",
"Service": "agentkit",
"Region": "cn-beijing"
},
"Result": {
"ToolId": "t-ye9qwatywwb6wrvc****",
"Name": "test-name",
"Description": "",
"Status": "Ready",
"ToolType": "All-in-one",
"AuthorizerConfiguration": {
"KeyAuth": {
"ApiKey": "****",
"ApiKeyLocation": "header",
"ApiKeyName": "test-api-key"
}
},
"AssociatedRuntimes": [],
"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,
"ApmplusEnable": false,
"Envs": [],
"ProjectName": "default",
"NetworkConfigurations": [
{
"NetworkType": "public",
"Endpoint": "https://sd4hcnv3318ffuppa***.apigateway-cn-beijing.volceapi.com",
"VpcConfiguration": {
"VpcId": "vpc-1unjb731ek1s51j8e75l****",
"SubnetIds": [
"subnet-w0eiz5pvhlhc865ykakf****"
],
"SecurityGroupIds": [
"sg-1c11cukupn1ts5e8j711g****"
]
}
}
]
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | MissingParameter.ToolId | The required parameter ToolId is not supplied. | tool id不能为空。 |
404 | InvalidResource.NotFound | The specified resource does not exist. | 指定资源不存在。 |
最近更新时间：2026.09.23 18:59:28
这个页面对您有帮助吗？
有用
有用
无用
无用