1. 接口描述
接口请求域名： ags.tencentcloudapi.com 。
创建 Deployment
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDeployment。 |
| Version | 是 | String | 公共参数，本接口取值：2025-09-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-chongqing, ap-hongkong, ap-shanghai 。 |
| DeploymentName | 是 | String | 唯一的 Deployment 名称，必须符合 DNS-1123 命名规范，创建后不可修改。 示例值：workspace-service |
| ToolId | 否 | String | 用于关联 Sandbox Tool 的标识，格式为 sdt- 加 8 位小写 base36 字符。 示例值：sdt-a1b2c3d4 |
| ScalingConfiguration | 否 | ScalingConfiguration | 伸缩配置；省略的成员由服务端补全默认值。 |
| LifecycleConfiguration | 否 | LifecycleConfiguration | 空闲生命周期配置；省略的成员由服务端补全默认值。 |
| AffinityConfiguration | 否 | AffinityConfiguration | Affinity 配置；省略或空 Mode 表示不启用。 |
| Tags.N | 否 | Array of Tag | 标签 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Deployment | Deployment | 已创建并完成默认值物化的 Deployment。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建 Deployment
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeployment
<公共请求参数>
{
"DeploymentName": "workspace-service",
"ToolId": "sdt-a1b2c3d4",
"LifecycleConfiguration": {
"IdleTimeoutSeconds": 300,
"IdleAction": "PAUSE"
},
"AffinityConfiguration": {
"Mode": "EXCLUSIVE"
}
}输出示例
{
"Response": {
"Deployment": {
"DeploymentId": "dpl-a1b2c3d4",
"DeploymentName": "workspace-service",
"ToolId": "sdt-a1b2c3d4",
"ScalingConfiguration": {
"MinInstanceCount": 0,
"MaxInstanceCount": 10,
"MaxInstanceRequestConcurrency": 100
},
"LifecycleConfiguration": {
"IdleTimeoutSeconds": 300,
"IdleAction": "PAUSE"
},
"AffinityConfiguration": {
"Mode": "EXCLUSIVE",
"HeaderName": "X-Tencent-Agr-Affinity-Id"
},
"Status": "ACTIVE",
"CreatedTime": "2026-08-06T08:00:00Z",
"UpdatedTime": "2026-08-06T08:00:00Z"
},
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}示例2 创建 Deployment - 2
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeployment
<公共请求参数>
{
"DeploymentName": "hello",
"ToolId": "sdt-95hq0b7k"
}输出示例
{
"Response": {
"Deployment": {
"CreatedTime": "2026-08-18T03:08:11Z",
"DeploymentId": "dpl-amfzcemg",
"DeploymentName": "hello",
"LifecycleConfiguration": {
"IdleAction": "STOP",
"IdleTimeoutSeconds": 300
},
"ScalingConfiguration": {
"MaxInstanceCount": 10,
"MaxInstanceRequestConcurrency": 100,
"MinInstanceCount": 0
},
"Status": "ACTIVE",
"ToolId": "sdt-95hq0b7k",
"UpdatedTime": "2026-08-18T03:08:11Z"
},
"RequestId": "2fda2af5-a50e-465e-bc71-849828d9b1f2"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.AffinityConfiguration | InvalidParameter.AffinityConfiguration |
| InvalidParameter.DeploymentName | InvalidParameter.DeploymentName |
| InvalidParameter.LifecycleConfiguration | InvalidParameter.LifecycleConfiguration |
| InvalidParameter.ScalingConfiguration | InvalidParameter.ScalingConfiguration |
| InvalidParameter.ToolId | InvalidParameter.ToolId |
| LimitExceeded.Deployment | LimitExceeded.Deployment |
| ResourceInUse.DeploymentName | ResourceInUse.DeploymentName |
| ResourceNotFound.SandboxTool | 沙箱工具不存在 |
