创建沙箱工具

最近更新时间:2025-11-07 10:12:49

我的收藏

1. 接口描述

接口请求域名: ags.tencentcloudapi.com 。

创建沙箱工具

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSandboxTool。
Version String 公共参数,本接口取值:2025-09-20。
Region String 公共参数,详见产品支持的 地域列表
ToolName String 沙箱工具名称,长度 1-50 字符,支持英文、数字、下划线和连接线。同一 AppId 下沙箱工具名称必须唯一
示例值:code-interpreter-v1
ToolType String 沙箱工具类型,目前支持:browser、code-interpreter
示例值:code-interpreter
NetworkConfiguration NetworkConfiguration 网络配置
Description String 沙箱工具描述,最大长度 200 字符
示例值:代码解释器沙箱工具
DefaultTimeout String 默认超时时间,支持格式:5m、300s、1h 等,不指定则使用系统默认值(5 分钟)。最大 24 小时
示例值:5m
Tags.N Array of Tag 标签规格,为沙箱工具绑定标签,支持多种资源类型的标签绑定
ClientToken String 幂等性 Token,长度不超过 64 字符
示例值:your-unique-client-token

3. 输出参数

参数名称 类型 描述
ToolId String 创建的沙箱工具 ID
示例值:sdt-dibk4rra
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建沙箱工具

输入示例

POST / HTTP/1.1
Host: ags.<region>.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSandboxTool
<公共请求参数>

{
    "ToolName": "browser-sandbox",
    "ToolType": "browser",
    "Description": "浏览器沙箱环境",
    "DefaultTimeout": "30m",
    "NetworkConfiguration": {
        "NetworkMode": "PUBLIC"
    },
    "Tags": [
        {
            "Key": "Environment",
            "Value": "Production"
        },
        {
            "Key": "Team",
            "Value": "AI-Agent"
        }
    ],
    "ClientToken": "unique-token-123"
}

输出示例

{
    "Response": {
        "ToolId": "sdt-ee4ywozw",
        "RequestId": "custom-request-id-123"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DuplicateRequest 重复请求(幂等性检查)
FailedOperation.RequestInProgress 请求正在处理中(幂等性检查)
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.SandboxTool 沙箱工具名称不可用,可能是已经存在
InvalidParameterValue.Timeout 超时时间格式错误或超过最大限制
InvalidParameterValue.ToolType 不支持的沙箱工具类型
MissingParameter 缺少参数错误。