帮你快速理解、总结文档立即下载

停止实验室

最近更新时间:2026-08-04 01:50:02

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

停止实验室

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:StopLab。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
Id String

工作区ID


示例值:raylab-20260530120338-ikaa

3. 输出参数

参数名称 类型 描述
ExampleId String

案例模板ID(startMode=EXAMPLE 时使用)


示例值:example-005-raydp-raydata
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-lab
Id String

集群ID


示例值:raylab-20260530120338-ikaa
Type String

资源类型:CLUSTER-普通集群;WORKSPACE-数据实验室(开发入口)


示例值:RAY_LAB
Name String

集群名称


示例值:dlc_mao_shiyanshi_1
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

集群状态


示例值:STOPPED
CreateTime Integer

创建时间


示例值:1780113822930
ResourceConfig String

资源配置(JSON)


示例值:{"Head":{"Name":"Head","PodCpu":1,"PodMem":4,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[],"ResourcesLabels":[],"Tolerations":null,"ResourceType":"CPU","InstanceType":"","Spec":1,"BillingItem":"sv_dlc_standard_cu_standard_cu","VideoMemory":null,"PodNum":1,
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":[]}
HistoryUrl String

Dashboard URL / 历史记录链接


示例值:https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-bleurqnv/raylab-20260530120338-ikaa/
AdvancedOptions String

高级参数(扁平 Key-Value 的 JSON 字符串),Key 以 spec. 开头,按 RayCluster CRD 下钻;详见 ADVANCED_CLUSTER_OPTIONS_DESIGN.md


示例值:{"spec.suspend":"true"}
Priority Integer

优先级(1-9,数字越大优先级越高)


示例值:4
StartTime Integer

启动时间(最近一次启动)


示例值:1780121753305
Tags Array of Tag

标签列表(TagKey-TagValue)

PersistentWorkDir PersistentWorkDir

持久化工作目录配置(可选)。启用后将 COS/CFS 指定路径挂载到容器内 /workspace 工作目录,与现有 Catalog 的卷配置互斥(不允许同时在 Catalog 中显式声明 MountPath=/workspace)。

EnableToken Boolean

是否开启token认证


示例值:true
Token String

Token 认证密钥(开启 token 认证时由系统生成)


示例值:c22308e26c2645a4a5d1c562bae5467d
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 StopLab

停止实验室

输入示例

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

{
    "Id": "raylab-20260530120338-ikaa"
}

输出示例

{
    "Response": {
        "AdvancedOptions": "{\"spec.suspend\":\"true\"}",
        "AppId": 260200065,
        "Catalog": "{\"CFSVolumes\":[],\"CFSTurboVolumes\":[],\"COSVolumes\":[{\"Region\":\"ap-guangzhou\",\"Bucket\":\"qzzhu-260200065\",\"VolumeSubPath\":\"/\",\"SubPathMode\":\"subPath\",\"SubPath\":\"\",\"MountPath\":\"/mnt/data\",\"PersistVolumeName\":\"raylab-20260530120338-ikaa-cos-df101a90c4f8e6ca5bce44d009081a69\",\"VolumeMountMode\":\"ReadWrite\"}],\"GooseFSVolumes\":[]}",
        "CreateTime": 1780113822930,
        "EnableToken": true,
        "HistoryUrl": "https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-bleurqnv/raylab-20260530120338-ikaa/",
        "Id": "raylab-20260530120338-ikaa",
        "Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
        "LabImage": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-lab",
        "Name": "dlc_mao_shiyanshi_1",
        "PersistentWorkDir": {
            "Bucket": "qzzhu-260200065",
            "Enabled": true,
            "Type": "COS",
            "VolumeSubPath": "/"
        },
        "Queue": "default",
        "ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":4,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourcesLabels\":[],\"Tolerations\":null,\"ResourceType\":\"CPU\",\"InstanceType\":\"\",\"Spec\":1,\"BillingItem\":\"sv_dlc_standard_cu_standard_cu\",\"VideoMemory\":null,\"PodNum\":1,\"HighAvailability\":false},\"Worker\":[{\"Name\":\"WorkerGroup01\",\"PodCpu\":1,\"PodMem\":4,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourcesLabels\":[],\"Tolerations\":null,\"ResourceType\":\"CPU\",\"InstanceType\":\"\",\"Spec\":1,\"BillingItem\":\"sv_dlc_standard_cu_standard_cu\",\"VideoMemory\":null,\"MinPodNum\":1,\"MaxPodNum\":1}]}",
        "ResourcePartitionId": "dlc-p-bleurqnv",
        "ResourcePartitionName": "test_andrewmao",
        "Services": [
            {
                "Key": "JUPYTER",
                "Value": "https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-bleurqnv/raylab-20260530120338-ikaa/lab/jupyter"
            }
        ],
        "StartTime": 1780121753305,
        "Status": "STOPPED",
        "SubAccountUin": "700002655693",
        "Tags": [
            {
                "TagKey": "env",
                "TagValue": "dev"
            }
        ],
        "Token": "c22308e26c2645a4a5d1c562bae5467d",
        "Type": "RAY_LAB",
        "Uin": "700002655693",
        "RequestId": "d5360db5-3b33-4775-8b86-726db3fce0a0"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ExternalService 外部服务异常
FailedOperation.LabNotFound 数据实验室不存在:数据实验室不存在,请检查数据实验室标识