帮你快速理解、总结文档立即下载
文档中心>数据湖计算 DLC>API 文档>AI DLC 计算集群相关接口>获取集群详情

获取集群详情

最近更新时间：2026-08-04 01:49:58

我的收藏

本页目录：

1. 接口描述

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

获取Ray集群详情请求

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

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

2. 输入参数

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

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

集群ID


示例值：raycluster-20260602191330-yej4

3. 输出参数

参数名称 类型 描述
Id String

获取Ray集群详情请求


示例值：raycluster-20260602191330-yej4
Type String

资源类型：CLUSTER-普通集群；WORKSPACE-数据实验室（开发入口）


示例值：RAY_CLUSTER
Name String

集群名称


示例值：aidanyxu-test
Description String

集群描述


示例值：测试集群
ResourcePartitionId String

所属资源分区ID


示例值：dlc-p-ikzmoqyv
ResourcePartitionName String

默认资源分区名称


示例值：test-pool-luke
Queue String

所属队列名称


示例值：default
AppId Integer

应用ID


示例值：260200065
Uin String

用户UIN


示例值：700002655693
SubAccountUin String

子用户UIN


示例值：700002655693
SubAccountName String

子用户名称（由聚合层通过 CAM 接口回填）


示例值：700002744585
Status String

集群状态


示例值：CREATED
StatusMessage String

状态详情/错误信息


示例值：VPC对等连接打通失败:
CreateTime Integer

创建时间


示例值：1780398810495
GroupId String

计算组 ID


示例值：rayclustergroup-tfh4u6-bcqz
GroupName String

所属集群组名称


示例值：group_test_sunny
ResourceConfig String

资源配置(JSON)


示例值：{"Head":{"Name":"default-head","PodCpu":1,"PodMem":2,"PodNum":1,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[]},"Worker":[{"Name":"default-worker","PodCpu":1,"PodMem":2,"MinPodNum":1,"MaxPodNum":1,"GpuType":"","GpuNum":0,"Envs":[],"Labels":[]}]}
Image String

镜像地址


示例值：ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu
Catalog String

存储卷和挂载卷配置(JSON)


示例值：{"CFSVolumes":[],"COSVolumes":[]}
HistoryUrl String

Dashboard URL / 历史记录链接


示例值：https://test-tcray-gateway-guangzhou.cloud.tencent.com/dlc-ae511d85/raycluster-1778317700-lmxh/
ImagePullPolicy String

镜像拉取策略


示例值：Always
ImagePullType String

镜像拉取类型（BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR）


示例值：BuiltIn
AdvancedOptions String

高级参数（规范化后的扁平 KV JSON）


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

优先级（1-9，数字越大优先级越高）


示例值：5
StartTime Integer

启动时间（最近一次启动）


示例值：1778484634154
StopTime Integer

停止时间（最近一次停止/休眠）


示例值：1780048345408
Tags Array of Tag

标签列表（TagKey-TagValue）
ResourceConfigId String

资源配置ID


示例值：cf82820d-22a9-458f-ae3f-108137ab55af
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取集群详情

输入示例

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

{
    "Id": "raycluster-20260602191330-yej4"
}

输出示例

{
    "Response": {
        "AdvancedOptions": "{\"spec.suspend\": \"true\"}",
        "AppId": 260200065,
        "Catalog": "{\"CFSVolumes\":[{\"FileSystemId\":\"cfs-eikhdf8b\",\"VolumeSubPath\":\"/\",\"SubPathMode\":\"subPath\",\"SubPath\":\"\",\"MountPath\":\"/d\",\"FSId\":\"enyuf3td\",\"Host\":\"10.0.0.2\",\"PersistVolumeName\":\"raycluster-20260602191330-yej4-cfs-ed05d9b0567ba7c87a52af666bcc09f3\",\"VpcId\":\"vpc-nocygw15\",\"SubnetId\":\"subnet-p1zbl2ns\",\"Uin\":\"700002655693\",\"Region\":\"ap-guangzhou\",\"VolumeMountMode\":\"ReadOnly\"}],\"CFSTurboVolumes\":[],\"COSVolumes\":[],\"GooseFSVolumes\":[]}",
        "CreateTime": 1780398810495,
        "Description": "测试集群",
        "GroupId": "rayclustergroup-tfh4u6-bcqz",
        "GroupName": "group_test_sunny",
        "Id": "raycluster-20260602191330-yej4",
        "Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
        "ImagePullPolicy": "Always",
        "Name": "aidanyxu-test",
        "Priority": 5,
        "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},{\"Name\":\"WorkerGroup02\",\"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}]}",
        "ResourceConfigId": "cf82820d-22a9-458f-ae3f-108137ab55af",
        "ResourcePartitionId": "dlc-p-ikzmoqyv",
        "ResourcePartitionName": "test-pool-luke",
        "Status": "CREATED",
        "SubAccountUin": "700002655693",
        "Tags": [],
        "Type": "RAY_CLUSTER",
        "Uin": "700002655693",
        "RequestId": "c86998d5-ceee-4bd7-b0d2-91721fb97a76",
        "StatusMessage": ""
    }
}

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 外部服务异常
中国站