1. 接口描述
接口请求域名： ags.tencentcloudapi.com 。
更新沙箱实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateSandboxInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2025-09-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 沙箱实例ID 示例值：953e15d3655e4daab120b885c908edf7 |
| Timeout | 否 | String | 新的超时时间（从设置时开始重新计算超时），支持格式：5m、300s、1h等。最小30s，最大24h。如果不指定则保持原有超时设置 示例值：1h |
| Metadata.N | 否 | Array of MetadataVar | 沙箱实例元数据 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 更新实例超时时间
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateSandboxInstance
<公共请求参数>
{
"InstanceId": "gw524aigytlvl2qwzsgw5yud5cjuiq3worjeir57",
"Timeout": "30m"
}输出示例
{
"Response": {
"RequestId": "0846f2dc-f1d2-465a-93a2-d1873c66f715"
}
}示例2 替换实例级访问策略
完整替换当前实例的实例级访问策略。
输入示例
POST / HTTP/1.1
Host: ags.<region>.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateSandboxInstance
<公共请求参数>
{
"InstanceId": "953e15d3655e4daab120b885c908edf7"
}输出示例
{
"Response": {
"RequestId": "6f8be2d7-b47c-4f55-95c8-1739fcd4e7a1"
}
}示例3 撤销实例级访问策略
传入空对象撤销当前实例的实例级访问策略，实例随后仅受 Sandbox Tool 关联的访问策略约束。
输入示例
POST / HTTP/1.1
Host: ags.<region>.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateSandboxInstance
<公共请求参数>
{
"InstanceId": "953e15d3655e4daab120b885c908edf7"
}输出示例
{
"Response": {
"RequestId": "a2c491e8-6db5-4f02-96c3-f710ed025ba4"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DependencyUnavailable | 依赖服务不可用或超时 |
| FailedOperation.RequestInProgress | 请求正在处理中（幂等性检查） |
| InternalError | 内部错误。 |
| InternalError.Unknown | 未分类内部错误 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.Timeout | 超时时间格式错误或超过最大限制 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.SandboxInstance | 沙箱实例不存在 |
| ResourceUnavailable | 资源不可用。 |
| UnsupportedOperation.SandboxInstance | 实例状态不允许修改（只有RUNNING状态的实例可以修改） |
