1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
获取RayCluster的YAML内容
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:GetRayClusterYaml。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 集群ID 示例值:raycluster-1778317700-lmxh |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Yaml | String | RayCluster YAML 示例值:---apiVersion: |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取RayCluster的YAML内容
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRayClusterYaml
<公共请求参数>
{
"Id": "raycluster-1778317700-lmxh"
}
输出示例
{
"Response": {
"Yaml": "---\napiVersion: \"ray.io/v1\"\nkind: \"RayCluster\"\nmetadata:\n creationTimestamp: \"2026-05-11T07:30:33Z\"\n generation: 1\n labels:\n app.kubernetes.io/instance: \"raycluster-1778317700-lmxh\"\n app.kubernetes.io/managed-by: \"neutrino-clustermanager\"\n app.kubernetes.io/name: \"neutrino-cluster\"\n kueue.x-k8s.io/priority-class: \"priority-50000\"\n kueue.x-k8s.io/queue-name: \"dlc-ae511d85-default-lq\"\n neutrino.io/appid: \"260090589\"\n neutrino.io/cluster-type: \"cluster\"\n neutrino.io/cluster-uuid: \"raycluster-1778317700-lmxh\"\n queueName: \"default\"\n name: \"raycluster-1778317700-lmxh\"\n namespace: \"dlc-ae511d85\"\n resourceVersion: \"30405449032\"\n uid: \"b03b0966-ed84-4f0d-acb7-c3eeef1e116f\"\nspec:\n autoscalerOptions:\n env: []\n envFrom: []\n idleTimeoutSeconds: 60\n imagePullPolicy: \"IfNotPresent\"\n resources:\n limits:\n cpu: \"1\"\n memory: \"2Gi\"\n requests:\n cpu: \"0\"\n memory: \"0\"\n securityContext: {}\n upscalingMode: \"Default\"\n enableInTreeAutoscaling: false\n headGroupSpec:\n enableIngress: true\n rayStartParams:\n dashboard-host: \"0.0.0.0\"\n disable-usage-stats: \"true\"\n object-store-memory: \"100000000\"\n replicas: 1\n resources:\n cpu: \"0\"\n template:\n metadata:\n annotations:\n prometheus.io/path: \"/metrics\"\n prometheus.io/port: \"8080\"\n prometheus.io/scheme: \"http\"\n prometheus.io/scrape: \"true\"\n labels:\n dlc/app-id: \"260090589\"\n dlc/engine-id: \"raycluster-1778317700-lmxh\"\n dlc/engine-name: \"raycluster-1778317700-lmxh\"\n dlc/pay-mode: \"10\"\n dlc/sub-uin: \"700002467852\"\n dlc/task-id: \"raycluster-1778317700-lmxh\"\n dlc/task-type: \"RAY_CLUSTER\"\n dlc/uin: \"700002467852\"\n neutrino.io/cluster-uuid: \"raycluster-1778317700-lmxh\"\n neutrino.io/node-type: \"head\"\n pod-role: \"header\"\n spec:\n containers:\n - env:\n - name: \"TZ\"\n value: \"Asia/Shanghai\"\n - name: \"RAY_CLUSTER_UUID\"\n value: \"raycluster-1778317700-lmxh\"\n - name: \"RAY_GRAFANA_HOST\"\n value: \"http://grafana.monitor.svc.cluster.local:3000\"\n - name: \"RAY_GRAFANA_IFRAME_HOST\"\n value: \"https://test-tcray-gateway-guangzhou.cloud.tencent.com/grafana\"\n - name: \"RAY_GRAFANA_CLUSTER_FILTER\"\n valueFrom:\n fieldRef:\n fieldPath: \"metadata.labels['ray.io/cluster']\"\n image: \"rayproject/ray:2.53.0\"\n imagePullPolicy: \"IfNotPresent\"\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 resources:\n limits:\n cpu: \"1\"\n memory: \"2Gi\"\n requests:\n cpu: \"1\"\n memory: \"2Gi\"\n securityContext:\n privileged: true\n rayVersion: \"2.53.0\"\n workerGroupSpecs:\n - groupName: \"default-worker\"\n maxReplicas: 1\n minReplicas: 1\n numOfHosts: 1\n rayStartParams: {}\n replicas: 1\n template:\n metadata:\n labels:\n dlc/app-id: \"260090589\"\n dlc/engine-id: \"raycluster-1778317700-lmxh\"\n dlc/engine-name: \"raycluster-1778317700-lmxh\"\n dlc/pay-mode: \"10\"\n dlc/sub-uin: \"700002467852\"\n dlc/task-id: \"raycluster-1778317700-lmxh\"\n dlc/task-type: \"RAY_CLUSTER\"\n dlc/uin: \"700002467852\"\n neutrino.io/cluster-uuid: \"raycluster-1778317700-lmxh\"\n neutrino.io/node-type: \"worker\"\n pod-role: \"worker\"\n spec:\n containers:\n - env:\n - name: \"TZ\"\n value: \"Asia/Shanghai\"\n - name: \"RAY_CLUSTER_UUID\"\n value: \"raycluster-1778317700-lmxh\"\n image: \"rayproject/ray:2.53.0\"\n imagePullPolicy: \"IfNotPresent\"\n name: \"ray-worker\"\n resources:\n limits:\n cpu: \"1\"\n memory: \"2Gi\"\n requests:\n cpu: \"1\"\n memory: \"2Gi\"\n securityContext:\n privileged: true\nstatus:\n availableWorkerReplicas: 1\n conditions:\n - lastTransitionTime: \"2026-05-11T07:37:15Z\"\n message: \"\"\n reason: \"HeadPodRunningAndReady\"\n status: \"True\"\n type: \"HeadPodReady\"\n - lastTransitionTime: \"2026-05-11T07:37:28Z\"\n message: \"All Ray Pods are ready for the first time\"\n reason: \"AllPodRunningAndReadyFirstTime\"\n status: \"True\"\n type: \"RayClusterProvisioned\"\n - lastTransitionTime: \"2026-05-11T07:30:34Z\"\n message: \"\"\n reason: \"RayClusterSuspended\"\n status: \"False\"\n type: \"RayClusterSuspended\"\n - lastTransitionTime: \"2026-05-11T07:30:34Z\"\n message: \"\"\n reason: \"RayClusterSuspending\"\n status: \"False\"\n type: \"RayClusterSuspending\"\n desiredCPU: \"2\"\n desiredGPU: \"0\"\n desiredMemory: \"4Gi\"\n desiredTPU: \"0\"\n desiredWorkerReplicas: 1\n endpoints:\n client: \"10001\"\n dashboard: \"8265\"\n gcs-server: \"6379\"\n metrics: \"8080\"\n head:\n podIP: \"10.1.0.119\"\n podName: \"raycluster-1778317700-lmxh-head-vqfsw\"\n serviceIP: \"10.1.0.119\"\n serviceName: \"raycluster-1778317700-lmxh-head-svc\"\n lastUpdateTime: \"2026-05-11T07:37:28Z\"\n maxWorkerReplicas: 1\n minWorkerReplicas: 1\n observedGeneration: 1\n readyWorkerReplicas: 1\n state: \"ready\"\n stateTransitionTimes:\n ready: \"2026-05-11T07:37:28Z\"\n",
"RequestId": "e7aab6f6-b179-4f34-b1e2-a9e56d176e20"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。