AgentKit
AgentKit
文档指南
请输入
- 文档首页
AgentKitAgentKit开发者指南API参考Sandbox ToolUpdateTool - 修改工具的描述信息
复制全文
下载 pdfUpdateTool - 修改工具的描述信息
文档反馈
问问助手修改工具的描述信息。
请求参数
Action string 必选 示例值：UpdateTool
要执行的操作，取值：UpdateTool。
Version string 必选 示例值：2025-10-30
API的版本，取值：2025-10-30。
Description string 可选 示例值：tool01
工具的描述，取值：长度限制为 1000 以内的 Unicode 字符。
ApmplusEnable boolean 可选 示例值：true
是否开启日志服务。取值：
- true：开启。
- false：未开启。
ToolId string 必选 示例值：t-3tigy72q3u3vj0x2****
工具ID。
Command string 可选 示例值：./run.sh
工具启动命令。
说明
当ToolType取值为自定义工具时需传入，默认值为./run.sh。
CpuMilli integer 可选 示例值：2000
实例vCPU规格, 单位为milli cpu。
- All-in-one和Skill：2000
Envs.N.Key string[] 必选 示例值：Envs.1.Key=k1
工具环境变量的键。
- 参数 - N：表示环境变量的序号，取值1～30。
- 取值：只能包含字母、数字、下划线，且只能以下划线字母开头， 长度限制为1 ~ 63个字符。
Envs.N.Value string[] 可选 示例值：Envs.1.Value=v1
工具环境变量的值。
- 参数 - N：表示环境变量的序号，取值1～30。
EnableSnapshot boolean 可选 示例值：true
是否在实例过期前自动创建快照。
- true：创建。
- false：不创建。
ImageUrl string 可选 示例值：http://***
工具镜像地址。
说明
当ToolType取值为自定义工具时必填。
Port integer 可选 示例值：8000
工具监听端口。
说明
当ToolType取值为自定义工具时需传入，默认值为8000。
ModelAgentName string 可选 示例值：doubao-seed-1.6
推理模型接入点。
ToolType string 可选 示例值：All-in-one
工具类型。取值：
- All-in-one：一体化工具集，即预置工具AIO Sandbox。
- Skill: Skill工具镜像，即预置工具Skills Sandbox。
- PersonalAssistant：预置工具OpenClaw。
- Private: 自定义工具。
TosMountConfig.Credentials.AccessKeyId string 可选 示例值：GY2OGJiOTdl****
输入平台的Access Key ID。
说明
当TosMountConfig.EnableTos配置为true时必填。
MemoryMb integer 可选 示例值：600
实例Memory规格。单位：MiB。取值范围：512~131072。
TosMountConfig.Credentials.SecretAccessKey string 可选 示例值：emRoTnpVNU5HU****
输入平台的Secret Access Key ID。
说明
当TosMountConfig.EnableTos配置为true时必填。
TosMountConfig.EnableTos boolean 可选 示例值：false
是否启用TOS挂载。挂载后，工具实例对应目录产生的数据将存储至TOS服务。取值：
- true：开启。
- false：不开启。
TosMountConfig.MountPoints.N.BucketName string[] 可选 示例值：bucket01
TOS存储桶名称。
说明
当TosMountConfig.EnableTos配置为true时必填。
TosMountConfig.MountPoints.N.BucketPath string[] 可选 示例值：http://tos-cn-beijing.ivolces.com
TOS存储桶路径。
说明
当TosMountConfig.EnableTos配置为true时必填。
TosMountConfig.MountPoints.N.Endpoint string[] 可选 示例值：tmp/abc
TOS存储桶子目录。
说明
当TosMountConfig.EnableTos配置为true时必填。
TosMountConfig.MountPoints.N.LocalMountPath string[] 可选 示例值：/home/app
待挂载的工具实例本地目录。
说明
当TosMountConfig.EnableTos配置为true时必填。
TosMountConfig.MountPoints.N.ReadOnly boolean[] 可选 示例值：false
指定待挂载的工具实例本地目录的访问权限。取值：
- true：只读权限。
- false：读写权限。
说明
当TosMountConfig.EnableTos配置为true时必填。
返回参数
ToolId string 示例值：t-3tigy72q3u3vj0x2****
工具ID。
请求示例
POST https://agentkit.cn-beijing.volcengineapi.com?Action=UpdateTool&Version=2025-10-30 HTTP/1.1
Content-Type: application/json
{
"ToolId": "t-ye6xzwchkwoaroxxxxxx"
"Description": "123"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "202106111445100102252431000052****",
"Action": "UpdateTool",
"Version": "2025-10-30",
"Service": "agentkit",
"Region": "cn-beijing"
},
"Result": {
"ToolId": "t-ye7hr4n01soarome****"
}
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidDescription.Malformed | The specified Description is malformed. | 指定的描述格式错误。 |
400 | InvalidKey.Malformed | The specified Key is malformed. | 指定的Key不合法。 |
400 | InvalidModelAgentName.Malformed | The specified ModelAgentName is malformed. | 指定的ModelAgentName不合法。 |
400 | MissingParameter.Key | The required parameter Key is not supplied. | 参数Key不能为空。 |
400 | MissingParameter.ToolId | The required parameter ToolId is not supplied. | tool id不能为空。 |
400 | InvalidResourceStatus | The status of the specified resource does not support this request. | 当前资源的状态不支持此操作。 |
400 | InvalidParameter.Port | The specified Port is invalid. | 指定Port无效。 |
400 | InvalidParameter.ToolType | The specified ToolType is invalid. | 指定ToolType无效。 |
400 | MissingParameter.ImageUrl | The required parameter ImageUrl is not supplied. | ImageUrl不能为空。 |
404 | InvalidResource.NotFound | The specified resource does not exist. | 指定资源不存在。 |
最近更新时间：2026.09.23 18:59:28
这个页面对您有帮助吗？
有用
有用
无用
无用