1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
启动沙箱实例
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:StartSandboxInstance。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ToolId | 否 | String | 沙箱工具 ID,与 ToolName 至少有一个要填 示例值:sdt-ee4ywozw |
| ToolName | 否 | String | 沙箱工具名称,与 ToolId 至少有一个要填 示例值:my-browser-sandbox |
| Timeout | 否 | String | 超时时间,超过这个时间就自动回收实例。支持格式:5m、300s、1h 等,默认 5m。最小 30s,最大 24h 示例值:10m |
| ClientToken | 否 | String | 幂等性 Token,长度不超过 64 字符 示例值:instance-token-456 |
| MountOptions.N | 否 | Array of MountOption | 沙箱实例存储挂载配置 |
| CustomConfiguration | 否 | CustomConfiguration | 沙箱实例自定义配置 |
| AuthMode | 否 | String | 沙箱访问认证模式 枚举值:
默认值:DEFAULT 示例值:DEFAULT |
| Metadata.N | 否 | Array of MetadataVar | 沙箱元数据 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Instance | SandboxInstance | 创建的沙箱实例完整信息 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 启动沙箱实例
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartSandboxInstance
<公共请求参数>
{
"ToolName": "test_tool"
}
输出示例
{
"Response": {
"Instance": {
"AuthMode": "DEFAULT",
"CreateTime": "2026-08-06T08:10:44+08:00",
"CustomConfiguration": {
"Args": [
"-c"
],
"Command": [
"/bin/bash"
],
"Image": "ccr.ccs.tencentyun.com/******************:2.19-alpine-with-envd",
"ImageDigest": "sha256:8c14af9fd97819411ea7368c8c9b85823085c8abf911675cfa16c5475d1b627c",
"ImageRegistryType": "personal",
"Ports": [
{
"Name": "http",
"Port": 8080,
"Protocol": "TCP"
}
],
"Probe": {
"FailureThreshold": 10,
"HttpGet": {
"Path": "/health",
"Port": 49983,
"Scheme": "HTTP"
},
"ProbePeriodMs": 3000,
"ProbeTimeoutMs": 1000,
"ReadyTimeoutMs": 30000,
"SuccessThreshold": 1
},
"Resources": {
"CPU": "1000m",
"Memory": "500Mi",
"Storage": "1024Mi"
}
},
"ExpiresAt": "2026-08-06T08:15:40+08:00",
"InstanceId": "v4bstpofq5tkvgsaywzkscssvoftz4q4mh6c5jdr",
"NetworkMode": "PUBLIC",
"Persistent": false,
"Status": "RUNNING",
"TimeoutSeconds": 300,
"ToolId": "sdt-********",
"ToolName": "test_tool",
"UpdateTime": "2026-08-06T08:10:44+08:00"
},
"RequestId": "2fb58122-4e85-4640-b0ed-16af015e0bae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未CAM授权 |
| FailedOperation.DependencyUnavailable | 依赖服务不可用或超时 |
| FailedOperation.DuplicateRequest | 重复请求(幂等性检查) |
| FailedOperation.RequestInProgress | 请求正在处理中(幂等性检查) |
| FailedOperation.StorageMount | 沙箱实例存储配置挂载失败 |
| InternalError | 内部错误。 |
| InternalError.Unknown | 未分类内部错误 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.MountOption | MountOption部分参数填写错误 |
| InvalidParameterValue.StorageMount | StorageMount部分参数错误 |
| InvalidParameterValue.Timeout | 超时时间格式错误或超过最大限制 |
| LimitExceeded.SandboxInstance | 沙箱实例配额超限 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.RoleArn | 缺少角色Arn |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.SandboxTool | 沙箱工具不存在 |
| ResourceNotFound.StorageMount | 指定的StorageMount不存在 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.SandboxTool | 沙箱工具不可用 |
| UnsupportedOperation | 操作不支持。 |