1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
启动实验室
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:StartLab。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 工作区ID 示例值:raylab-20260602155816-6cmm |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ExampleId | String | 案例模板ID(startMode=EXAMPLE 时使用) 示例值:example-001-ray-core-basics |
| CodeArchiveUrl | String | 代码包/工程归档地址 示例值:https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/models/examples/example-001-ray-core-basics.zip |
| Services | Array of TypeKVPair | 数据实验室服务入口(服务类型 -> 访问地址) |
| LabImage | String | Lab 镜像地址(必填,用于开发工具如 Jupyter/VSCode/WebShell)。前端在"内置 / 自定义"两态中选择此值;当 Image 字段未显式传入时,后端会基于该字段按 R1(镜像表命中)/R2(同值 fallback)派生 Ray 集群镜像。 示例值:ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-extra-lab |
| Id | String | 集群ID 示例值:raylab-20260602155816-6cmm |
| Type | String | 资源类型:CLUSTER-普通集群;WORKSPACE-数据实验室(开发入口) 示例值:RAY_LAB |
| Name | String | 集群名称 示例值:leionwu_test |
| Description | String | 集群描述 示例值:测试测试 |
| ResourcePartitionId | String | 所属资源分区ID 示例值:dlc-p-bleurqnv |
| ResourcePartitionName | String | 默认资源分区名称 示例值:test_andrewmao |
| Queue | String | 所属队列名称 示例值:default |
| AppId | Integer | 应用ID 示例值:260200065 |
| Uin | String | 用户UIN 示例值:700002655693 |
| SubAccountUin | String | 子用户UIN 示例值:700002655693 |
| Status | String | 集群状态 示例值:STARTING |
| CreateTime | Integer | 创建时间 示例值:1780391421602 |
| GroupName | String | 所属集群组名称 示例值:group_test_sunny |
| GroupId | String | 计算组 ID 示例值:rayclustergroup-tfh4u6-bcqz |
| ResourceConfig | String | 资源配置(JSON) 示例值:{"Head":{"Name":"default-head","PodCpu":4,"PodMem":2,"GpuType":null,"GpuNum":null, |
| ResourceConfigId | String | 资源配置ID 示例值:11 |
| Image | String | Ray 集群镜像地址(可选,OpenAPI/SDK 高级控制入口)。前端不再传递此字段;为空时后端按 R1(镜像表查询命中)→ R2(同值 fallback)顺序自动派生。非空时直接作为 Ray 集群镜像,跳过派生(EXPLICIT),且后端不校验其与 LabImage 的兼容性。 示例值:ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu |
| Catalog | String | 存储卷和挂载卷配置(JSON) 示例值:{"CFSVolumes":[],"CFSTurboVolumes":null,"COSVolumes":null,"GooseFSVolumes":null} |
| HistoryUrl | String | Dashboard URL / 历史记录链接 示例值:https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-nsnqhoqi/raylab-20260529125726-xais/ |
| ImagePullPolicy | String | 镜像拉取策略 示例值:Always |
| AdvancedOptions | String | 高级参数(扁平 Key-Value 的 JSON 字符串),Key 以 spec. 开头,按 RayCluster CRD 下钻;详见 ADVANCED_CLUSTER_OPTIONS_DESIGN.md 示例值:{"spec.headGroupSpec.rayStartParams.dashboard-host":"0.0.0.0"} |
| Priority | Integer | 优先级(1-9,数字越大优先级越高) 示例值:6 |
| StartTime | Integer | 启动时间(最近一次启动) 示例值:1780030654517 |
| Tags | Array of Tag | 标签列表(TagKey-TagValue) |
| PersistentWorkDir | PersistentWorkDir | 持久化工作目录配置(可选)。启用后将 COS/CFS 指定路径挂载到容器内 /workspace 工作目录,与现有 Catalog 的卷配置互斥(不允许同时在 Catalog 中显式声明 MountPath=/workspace)。 |
| EnableToken | Boolean | 是否开启token认证 示例值:false |
| LabImagePullType | String | Lab sidecar 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR) 示例值:BuiltIn |
| SubAccountName | String | 子用户名称(由聚合层通过 CAM 接口回填) 示例值:700002744585 |
| ImagePullType | String | 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR) 示例值:BuiltIn |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 StartLab
启动实验室
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartLab
<公共请求参数>
{
"Id": "raylab-20260602155816-6cmm"
}
输出示例
{
"Response": {
"AdvancedOptions": "{\"spec.headGroupSpec.rayStartParams.dashboard-host\":\"0.0.0.0\"}",
"AppId": 260200065,
"Catalog": "{\"CFSVolumes\":[],\"CFSTurboVolumes\":null,\"COSVolumes\":null,\"GooseFSVolumes\":null}",
"CodeArchiveUrl": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/models/examples/example-001-ray-core-basics.zip\n",
"CreateTime": 1780391421602,
"Description": "测试测试",
"EnableToken": false,
"ExampleId": "example-001-ray-core-basics",
"GroupId": "rayclustergroup-tfh4u6-bcqz",
"GroupName": "group_test_sunny",
"Id": "raylab-20260602155816-6cmm",
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
"ImagePullPolicy": "Always",
"Name": "leionwu_test",
"Priority": 6,
"Queue": "default",
"ResourceConfig": "{\"Head\":{\"Name\":\"default-head\",\"PodCpu\":4,\"PodMem\":2,\"GpuType\":null,\"GpuNum\":null,\"Envs\":null,\"Labels\":null,\"ResourcesLabels\":null,\"Tolerations\":null,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null,\"BillingItem\":null,\"VideoMemory\":null,\"PodNum\":1,\"HighAvailability\":null},\"Worker\":[{\"Name\":\"default-worker\",\"PodCpu\":1,\"PodMem\":2,\"GpuType\":null,\"GpuNum\":null,\"Envs\":null,\"Labels\":null,\"ResourcesLabels\":null,\"Tolerations\":null,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null,\"BillingItem\":null,\"VideoMemory\":null,\"MinPodNum\":4,\"MaxPodNum\":4}]}",
"ResourceConfigId": "11",
"ResourcePartitionId": "dlc-p-bleurqnv",
"ResourcePartitionName": "test_andrewmao",
"Services": [
{
"Key": "JUPYTER"
}
],
"Status": "STARTING",
"SubAccountUin": "700002655693",
"Tags": [
{
"TagKey": "env",
"TagValue": "dev"
}
],
"Type": "RAY_LAB",
"Uin": "700002655693",
"RequestId": "3cae4ed0-7f61-404f-8337-e47cc106daac"
}
}
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.ExternalService | 外部服务异常 |
| FailedOperation.LabNotFound | 数据实验室不存在:数据实验室不存在,请检查数据实验室标识 |