Env
环境变量
被如下接口引用：CreateWorkspace, ModifyWorkspace。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 环境变量 key 示例值：env_key |
| Value | String | 是 | 环境变量 value 示例值：env_value |
GitRepository
Git 仓库
被如下接口引用：CreateWorkspace。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Url | String | 是 | Git 仓库地址 示例值：https://github.com/koajs/koa.git |
| Branch | String | 否 | Git 仓库分支名或 Tag 名 示例值：main |
Image
基础镜像
被如下接口引用：DescribeImages。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 镜像名称 示例值：All In One |
| Repository | String | 镜像仓库 示例值：cloudstudio-devops-docker.pkg.coding.net/artifacts/workspace/full-1.0.0 |
| Tags | Array of String | tag 列表 示例值：2023-04-25.0943 |
LifeCycle
工作空间生命周期自动执行脚本
被如下接口引用：CreateWorkspace, ModifyWorkspace。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Init | Array of LifeCycleCommand | 否 | 工作空间首次初始化时执行 示例值：[{"Name": "init", "Command": "echo 'init workspace'"}] |
| Start | Array of LifeCycleCommand | 否 | 每次工作空间启动时执行 示例值：[{"Name": "start", "Command": "echo 'start workspace'"}] |
| Destroy | Array of LifeCycleCommand | 否 | 每次工作空间关闭时执行 示例值：[{"Name": "destroy", "Command": "echo 'destroy workspace'"}] |
LifeCycleCommand
工作空间生命周期执行指令
被如下接口引用：CreateWorkspace, ModifyWorkspace。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 指令描述 示例值：init |
| Command | String | 是 | 具体命令 示例值：echo 'init workspace' |
WorkspaceStatusInfo
获取用户工作空间返回信息
被如下接口引用：DescribeWorkspaces。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 工作空间 ID 示例值：1 |
| Name | String | 工作空间名称 示例值：workspace-name |
| SpaceKey | String | 工作空间标识 示例值：ubbyfp |
| Status | String | 工作空间状态 示例值：Running |
| Cpu | Integer | CPU数量 示例值：2 |
| Memory | Integer | 内存 示例值：4 |
| Icon | String | 工作空间图标 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://cs-res-1258344699.file.myqcloud.com/workspace/assets/icons/all-in-one.svg |
| StatusReason | String | 工作空间状态, 异常原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：OK |
| Description | String | 工作空间描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a workspace |
| WorkspaceType | String | 工作空间类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：NORMAL |
| VersionControlUrl | String | Git 仓库 HTTPS 地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：https://github.com/example/example.git |
| VersionControlRef | String | Git 仓库引用。指定分支使用 /refs/heads/{分支名}, 指定 Tag 用 /refs/tags/{Tag名} 注意：此字段可能返回 null，表示取不到有效值。 示例值：/refs/heads/main |
| LastOpsDate | String | 最后操作时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-05-11T08:37:43.109+00:00 |
| CreateDate | String | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-05-11T08:37:43.109+00:00 |