1. 接口描述
接口请求域名： cloudstudio.tencentcloudapi.com 。
创建工作空间
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateWorkspace。 |
| Version | 是 | String | 公共参数，本接口取值：2023-05-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Name | 是 | String | 工作空间名称, 长度限制 2~64 示例值：workspace-name |
| Description | 否 | String | 工作空间描述, 长度限制 0~255 示例值：this is a workspace |
| Specs | 否 | String | 工作空间规格。Standard: 2C4G, Calculation: 4C8G, Profession: 8C16G. 默认是 Standard。 示例值：Standard |
| Image | 否 | String | 工作空间基础镜像名称, 默认会使用 All In One 镜像, 长度限制 1~255 示例值：cloudstudio-devops-docker.pkg.coding.net/artifacts/workspace/go-1.20:2023-04-25.0943 |
| Repository | 否 | GitRepository | Git 仓库. 工作空间启动时会自动克隆该仓库 示例值：{ "url": "https://github.com/koajs/koa.git", "branch": "v0.0.1" } |
| Envs.N | 否 | Array of Env | 环境变量. 会被注入到工作空间中 示例值：[{"name": "test", "value": "test"}] |
| Extensions.N | 否 | Array of String | 预装插件. 工作空间启动时, 会自动安装这些插件。长度限制: 0~10 示例值：["cloudstudio.tencent-cloud-toolkit@1.3.0"] |
| Lifecycle | 否 | LifeCycle | 工作空间生命周期钩子. 分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段. 用户可以自定义 shell 命令. 示例值：{ "init": [ { "name": "init", "command": "echo init" } ], "start": [ { "name": "start", "command": "echo start" } ], "destroy": [ { "name": "shutdown", "command": "echo shutdown" } ] } |
| TenantAppId | 否 | Integer | 应用名称 示例值：1303697168 |
| TenantUin | 否 | String | 用户UIN 示例值：100015915015 |
| TenantUniqVpcId | 否 | String | VPCID 示例值：vpc-rdfkabjj |
| TenantSubnetId | 否 | String | 子网ID 示例值：subnet-bx88somq |
| Region | 否 | String | 地域 示例值：ap-shanghai |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SpaceKey | String | 工作空间 SpaceKey 示例值：ubbyfp |
| Name | String | 工作空间名称 示例值：workspace-name |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建工作空间
创建工作空间
输入示例
POST / HTTP/1.1
Host: cloudstudio.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWorkspaceByTemplate
<公共请求参数>
{
"Name": "workspace-name"
}输出示例
{
"Response": {
"Name": "workspace-name",
"SpaceKey": "tfyiyw",
"RequestId": "26881c75-375d-48ad-9a24-7270176e4fab"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.WorkspaceNameDuplicate | 工作空间名称重复 |
| InvalidParameterValue | 参数取值错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
