1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
获取数据实验室Pod的YAML内容
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetLabPodYaml。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 数据实验室ID 示例值:raylab-20260530151529-r6av |
| PodName | 否 | String | Pod名称 示例值:raylab-20260530151529-r6av-head-78mtl |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Yaml | String | Pod YAML 示例值:---apiVersion: "v1"kind: " |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetLabPodYaml
获取实验室pod yaml 文件
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetLabPodYaml
<公共请求参数>
{
"Id": "raylab-20260530151529-r6av",
"PodName": "raylab-20260530151529-r6av-head-78mtl"
}
输出示例
{
"Response": {
"Yaml": "---\napiVersion: \"v1\"\nkind: \"Pod\"\nmetadata:\n annotations:\n kueue.x-k8s.io/workload: \"raycluster-raylab-20260530151529-r6av-9d580\"\n kueue.x-k8s.io/workload-slice-name: \"raycluster-raylab-20260530151529-r6av-9d580\"\n prometheus.io/path: \"/metrics\"\n prometheus.io/port: \"8080\"\n prometheus.io/scheme: \"http\"\n prometheus.io/scrape: \"true\"\n ray.io/ft-enabled: \"false\"\n ray.io/kuberay-version: \"v1.6.0\"\n ray.io/upgrade-strategy-recreate-hash: \"R2CBPBV4LO1VU4076O33SQV0340II8BC\"\n tke.cloud.tencent.com/networks-status: |-\n [{\n \"name\": \"tke-route-eni\",\n \"interface\": \"eth0\",\n \"ips\": [\n \"30.0.1.160\"\n ],\n \"mac\": \"96:47:77:83:98:ec\",\n \"default\": true,\n \"dns\": {}\n }]\n creationTimestamp: \"2026-05-30T07:17:06Z\"\n generateName: \"raylab-20260530151529-r6av-head-\"\n labels:\n app.kubernetes.io/created-by: \"kuberay-operator\"\n app.kubernetes.io/name: \"kuberay\"\n dlc/app-id: \"260200065\"\n dlc/engine-id: \"raylab-20260530151529-r6av\"\n dlc/engine-name: \"raylab-20260530151529-r6av\"\n dlc/pay-mode: \"1\"\n dlc/sub-uin: \"700002655693\"\n dlc/task-id: \"raylab-20260530151529-r6av\"\n dlc/task-type: \"RAY_LAB\"\n dlc/uin: \"700002655693\"\n kueue.x-k8s.io/cluster-queue-name: \"dlc-p-bleurqnv-default-cq\"\n kueue.x-k8s.io/local-queue-name: \"dlc-p-bleurqnv-default-lq\"\n kueue.x-k8s.io/podset: \"head\"\n neutrino.io/cluster-uuid: \"raylab-20260530151529-r6av\"\n neutrino.io/node-type: \"head\"\n neutrino.io/ray-log-collector: \"true\"\n neutrino.io/ray-log-metadata-uuid: \"raylab-20260530151529-r6av\"\n pod-role: \"head\"\n ray.io/cluster: \"raylab-20260530151529-r6av\"\n ray.io/group: \"headgroup\"\n ray.io/identifier: \"raylab-20260530151529-r6av-head\"\n ray.io/is-ray-node: \"yes\"\n ray.io/node-type: \"head\"\n name: \"raylab-20260530151529-r6av-head-78mtl\"\n namespace: \"dlc-p-bleurqnv\"\n ownerReferences:\n - apiVersion: \"ray.io/v1\"\n kind: \"RayCluster\"\n blockOwnerDeletion: true\n controller: true\n name: \"raylab-20260530151529-r6av\"\n uid: \"b0421e5e-5edf-420b-bec8-383d249644dc\"\n resourceVersion: \"32588055430\"\n uid: \"3bf17675-c201-4d4f-80b0-4e646f0260b1\"\nspec:\n containers:\n - args:\n - \"ulimit -n 65536; ray start --head --block --dashboard-agent-listen-port=52365\\\n \\ --dashboard-host=0.0.0.0 --disable-usage-stats --memory=4294967296 --metrics-export-port=8080\\\n \\ --num-cpus=0 --object-store-memory=100000000 \"\n command:\n - \"/bin/bash\"\n - \"-c\"\n - \"--\"\n env:\n - name: \"TZ\"\n value: \"Asia/Shanghai\"\n - name: \"RAY_CLUSTER_UUID\"\n value: \"raylab-20260530151529-r6av\"\n - name: \"RAY_GRAFANA_HOST\"\n value: \"http://grafana.monitor.svc.cluster.local:3000\"\n - name: \"RAY_GRAFANA_IFRAME_HOST\"\n value: \"https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/grafana\"\n - name: \"RAY_GRAFANA_CLUSTER_FILTER\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.labels['ray.io/cluster']\"\n - name: \"RAY_AUTH_MODE\"\n value: \"token\"\n - name: \"RAY_AUTH_TOKEN\"\n value: \"4a8814e5ff70429e82ac5e2f7f3d0ec6\"\n - name: \"RAY_CLUSTER_NAME\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.labels['ray.io/cluster']\"\n - name: \"RAY_CLUSTER_NAMESPACE\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.namespace\"\n - name: \"RAY_CLOUD_INSTANCE_ID\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.name\"\n - name: \"RAY_NODE_TYPE_NAME\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.labels['ray.io/group']\"\n - name: \"KUBERAY_GEN_RAY_START_CMD\"\n value: \"ray start --head --block --dashboard-agent-listen-port=52365 --dashboard-host=0.0.0.0\\\n \\ --disable-usage-stats --memory=4294967296 --metrics-export-port=8080\\\n \\ --num-cpus=0 --object-store-memory=100000000 \"\n - name: \"RAY_PORT\"\n value: \"6379\"\n - name: \"RAY_ADDRESS\"\n value: \"127.0.0.1:6379\"\n - name: \"RAY_USAGE_STATS_KUBERAY_IN_USE\"\n value: \"1\"\n - name: \"RAY_USAGE_STATS_EXTRA_TAGS\"\n value: \"kuberay_version=v1.6.0;kuberay_crd=RayCluster\"\n - name: \"RAY_DASHBOARD_ENABLE_K8S_DISK_USAGE\"\n value: \"1\"\n image: \"ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu\"\n imagePullPolicy: \"IfNotPresent\"\n livenessProbe:\n failureThreshold: 120\n httpGet:\n path: \"/api/healthz\"\n port: 52365\n scheme: \"HTTP\"\n initialDelaySeconds: 30\n periodSeconds: 5\n successThreshold: 1\n timeoutSeconds: 5\n name: \"ray-head\"\n ports:\n - containerPort: 6379\n name: \"gcs-server\"\n protocol: \"TCP\"\n - containerPort: 8265\n name: \"dashboard\"\n protocol: \"TCP\"\n - containerPort: 10001\n name: \"client\"\n protocol: \"TCP\"\n - containerPort: 8080\n name: \"metrics\"\n protocol: \"TCP\"\n readinessProbe:\n failureThreshold: 10\n httpGet:\n path: \"/api/healthz\"\n port: 52365\n scheme: \"HTTP\"\n initialDelaySeconds: 10\n periodSeconds: 5\n successThreshold: 1\n timeoutSeconds: 5\n resources:\n limits:\n cpu: \"1\"\n memory: \"4Gi\"\n tke.cloud.tencent.com/eni-ip: \"1\"\n requests:\n cpu: \"400m\"\n memory: \"1638Mi\"\n tke.cloud.tencent.com/eni-ip: \"1\"\n securityContext:\n privileged: true\n terminationMessagePath: \"/dev/termination-log\"\n terminationMessagePolicy: \"File\"\n volumeMounts:\n - mountPath: \"/tmp/ray\"\n name: \"ray-tmp\"\n - mountPath: \"/dev/shm\"\n name: \"shared-mem\"\n - mountPath: \"/var/run/secrets/kubernetes.io/serviceaccount\"\n name: \"kube-api-access-8lnqx\"\n readOnly: true\n - args:\n - \"/usr/local/bin/lab/lab-entrypoint.sh\"\n command:\n - \"/bin/bash\"\n - \"-lc\"\n env:\n - name: \"TZ\"\n value: \"Asia/Shanghai\"\n - name: \"RAY_CLUSTER_UUID\"\n value: \"raylab-20260530151529-r6av\"\n - name: \"WORKDIR\"\n value: \"/workspace\"\n - name: \"ENABLE_JUPYTER\"\n value: \"true\"\n - name: \"ENABLE_WEBSHELL\"\n value: \"true\"\n - name: \"ENABLE_VSCODE\"\n value: \"true\"\n - name: \"JUPYTER_TOKEN\"\n - name: \"VSCODE_AUTH\"\n value: \"none\"\n - name: \"VSCODE_PASSWORD\"\n - name: \"JUPYTER_PORT\"\n value: \"8888\"\n - name: \"WEBSHELL_PORT\"\n value: \"8889\"\n - name: \"VSCODE_PORT\"\n value: \"8890\"\n - name: \"CODE_ARCHIVE_URL\"\n - name: \"XDG_DATA_HOME\"\n value: \"/tmp/xdg-data\"\n - name: \"JUPYTER_BASE_URL\"\n value: \"/dlc-p-bleurqnv/raylab-20260530151529-r6av/lab/jupyter\"\n - name: \"MY_POD_IP\"\n valueFrom:\n fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"status.podIP\"\n - name: \"RAY_NODE_IP_ADDRESS\"\n value: \"$(MY_POD_IP)\"\n - name: \"RAY_AUTH_MODE\"\n value: \"token\"\n - name: \"RAY_AUTH_TOKEN\"\n value: \"4a8814e5ff70429e82ac5e2f7f3d0ec6\"\n image: \"ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-lab\"\n imagePullPolicy: \"IfNotPresent\"\n livenessProbe:\n exec:\n command:\n - \"/usr/local/bin/lab/healthcheck.sh\"\n - \"--timeout\"\n - \"5\"\n failureThreshold: 3\n periodSeconds: 30\n successThreshold: 1\n timeoutSeconds: 20\n name: \"lab\"\n ports:\n - containerPort: 8888\n name: \"jupyter\"\n protocol: \"TCP\"\n - containerPort: 8889\n name: \"webshell\"\n protocol: \"TCP\"\n - containerPort: 8890\n name: \"vscode\"\n protocol: \"TCP\"\n readinessProbe:\n exec:\n command:\n - \"/usr/local/bin/lab/healthcheck.sh\"\n - \"--timeout\"\n - \"3\"\n failureThreshold: 3\n periodSeconds: 10\n successThreshold: 1\n timeoutSeconds: 10\n resources:\n limits:\n cpu: \"2\"\n memory: \"4Gi\"\n requests:\n cpu: \"0\"\n memory: \"0\"\n startupProbe:\n exec:\n command:\n - \"/usr/local/bin/lab/healthcheck.sh\"\n - \"--timeout\"\n - \"5\"\n failureThreshold: 30\n initialDelaySeconds: 10\n periodSeconds: 10\n successThreshold: 1\n timeoutSeconds: 20\n terminationMessagePath: \"/dev/termination-log\"\n terminationMessagePolicy: \"File\"\n volumeMounts:\n - mountPath: \"/tmp/ray\"\n name: \"ray-tmp\"\n - mountPath: \"/workspace\"\n name: \"volume-1\"\n subPath: \"raylab-20260530151529-r6av\"\n - mountPath: \"/var/run/secrets/kubernetes.io/serviceaccount\"\n name: \"kube-api-access-8lnqx\"\n readOnly: true\n dnsPolicy: \"ClusterFirst\"\n enableServiceLinks: true\n nodeName: \"30.0.0.30\"\n nodeSelector:\n instance_type: \"sv_dlc_standard_cu_standard_cu\"\n preemptionPolicy: \"PreemptLowerPriority\"\n priority: 0\n restartPolicy: \"Always\"\n schedulerName: \"default-scheduler\"\n securityContext: {}\n serviceAccount: \"default\"\n serviceAccountName: \"default\"\n shareProcessNamespace: true\n terminationGracePeriodSeconds: 30\n tolerations:\n - effect: \"NoExecute\"\n key: \"node.kubernetes.io/not-ready\"\n operator: \"Exists\"\n tolerationSeconds: 300\n - effect: \"NoExecute\"\n key: \"node.kubernetes.io/unreachable\"\n operator: \"Exists\"\n tolerationSeconds: 300\n volumes:\n - emptyDir: {}\n name: \"ray-tmp\"\n - name: \"volume-1\"\n persistentVolumeClaim:\n claimName: \"raylab-20260530151529-r6av-cos-ea42a9657cb4a266f40406bc9fc8530d-pvc\"\n - emptyDir:\n medium: \"Memory\"\n sizeLimit: \"4Gi\"\n name: \"shared-mem\"\n - name: \"kube-api-access-8lnqx\"\n projected:\n defaultMode: 420\n sources:\n - serviceAccountToken:\n expirationSeconds: 3607\n path: \"token\"\n - configMap:\n items:\n - key: \"ca.crt\"\n path: \"ca.crt\"\n name: \"kube-root-ca.crt\"\n - downwardAPI:\n items:\n - fieldRef:\n apiVersion: \"v1\"\n fieldPath: \"metadata.namespace\"\n path: \"namespace\"\nstatus:\n containerStatuses:\n - containerID: \"containerd://b57f64ec35a17496ca63a5e1ee1a530feb649485c16d2ea5a07e46473911bfc7\"\n image: \"ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-lab\"\n imageID: \"ccr.ccs.tencentyun.com/emr-image/tcray@sha256:2efd05b25896a4e68e746533ab1bc9700b643980b2e4d80f565ff22792ffdd0c\"\n lastState: {}\n name: \"lab\"\n ready: true\n restartCount: 0\n started: true\n state:\n running:\n startedAt: \"2026-05-30T07:17:27Z\"\n - containerID: \"containerd://c8706b987a4071e67f6987fed5f6c8e8405dab2f5cf1051688d4cdbadf43d01c\"\n image: \"ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu\"\n imageID: \"ccr.ccs.tencentyun.com/emr-image/tcray@sha256:d08437e48d567274b6478d31429dd27c7fe72394d99aa6221c1a10658352abbd\"\n lastState: {}\n name: \"ray-head\"\n ready: true\n restartCount: 0\n started: true\n state:\n running:\n startedAt: \"2026-05-30T07:17:22Z\"\n hostIP: \"30.0.0.30\"\n hostIPs:\n - ip: \"30.0.0.30\"\n phase: \"Running\"\n podIP: \"30.0.1.160\"\n podIPs:\n - ip: \"30.0.1.160\"\n qosClass: \"Burstable\"\n startTime: \"2026-05-30T07:17:17Z\"\n",
"RequestId": "b9290ecf-dc01-47c6-96a6-92a963e68894"
}
}
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.LabNotFound | 数据实验室不存在:数据实验室不存在,请检查数据实验室标识 |