API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > Cloud Studio（云端 IDE） > 工作空间相关接口 > 修改工作空间

修改工作空间

最近更新时间：2024-03-12 01:17:55

我的收藏

本页目录：

1. 接口描述

接口请求域名： cloudstudio.tencentcloudapi.com 。

修改工作空间

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ModifyWorkspace。
Version 是 String 公共参数，本接口取值：2023-05-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
SpaceKey 是 String 工作空间 SpaceKey. 更新该工作空间的属性
示例值：ubbyfp
Name 否 String 工作空间名称
示例值：workspace-name
Description 否 String 工作空间描述
示例值：this is a worksapce
Specs 否 String 工作空间规格。STANDARD: 2C4G, CALCULATION: 4C8G, PROFESSION: 8C16G. 默认是 STANDARD。
示例值：STANDARD
Envs.N 否 Array of Env 环境变量. 会被注入到工作空间中
示例值：[{"name": "test", "value": "test"}]
Extensions.N 否 Array of String 预装插件. 工作空间启动时, 会自动安装这些插件
示例值：["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" } ] }

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改工作空间

修改工作空间

输入示例

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

{
    "SpaceKey": "ubbyfp",
    "Name": "openapi_test_m1",
    "Description": "api-test-midofy",
    "Specs": "Calculation"
}

输出示例

{
    "Response": {
        "RequestId": "437093fd-a231-4ec9-83f3-ae38ea917f8e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.WorkspaceNameDuplicate 工作空间名称重复
InvalidParameterValue 参数取值错误。
中国站