1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
停止集群
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：StopRayCluster。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Id | 是 | String | 集群ID 示例值：raycluster-20260527110617-96zt |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 集群ID 示例值：raycluster-20260527110617-96zt |
| Type | String | 资源类型：CLUSTER-普通集群；WORKSPACE-数据实验室（开发入口） 示例值：RAY_CLUSTER |
| Name | String | 集群名称 示例值：mao |
| ResourcePartitionId | String | 所属资源分区ID 示例值：dlc-p-bleurqnv |
| ResourcePartitionName | String | 资源分区名称 示例值：test_andrewmao |
| Queue | String | 所属队列名称 示例值：mao-group |
| AppId | Integer | 应用ID 示例值：260200065 |
| Uin | String | 用户UIN 示例值：700002655693 |
| SubAccountUin | String | 子账号UIN 示例值：700002655693 |
| Status | String | 集群状态 示例值：STOPPED |
| CreateTime | Integer | 创建时间 示例值：1779851177634 |
| GroupId | String | 计算组 ID 示例值：rayclustergroup-tfodxh-vwro |
| GroupName | String | 所属集群组名称 示例值：group-mao |
| 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":[],"CFSTurboVolumes":[],"COSVolumes":[]} |
| HistoryUrl | String | Dashboard URL / 历史记录链接 示例值：https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-bleurqnv/raycluster-20260527110617-96zt/ |
| ImagePullPolicy | String | 镜像拉取策略 示例值：IfNotPresent |
| ImagePullType | String | 镜像拉取类型（BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR） 示例值：Builtin |
| Priority | Integer | 优先级（1-9，数字越大优先级越高） 示例值：1 |
| StartTime | Integer | 启动时间（最近一次启动） 示例值：1780112019613 |
| StopTime | Integer | 停止时间（最近一次停止/休眠） 示例值：1780111979837 |
| Tags | Array of Tag | 标签列表（TagKey-TagValue） |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 停止集群
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StopRayCluster
<公共请求参数>
{
"Id": "raycluster-20260527110617-96zt"
}输出示例
{
"Response": {
"AppId": 260200065,
"Catalog": "{\"CFSVolumes\":[],\"CFSTurboVolumes\":[],\"COSVolumes\":[{\"Region\":\"ap-guangzhou\",\"Bucket\":\"qzzhu-260200065\",\"VolumeSubPath\":\"/\",\"SubPathMode\":\"subPath\",\"SubPath\":\"\",\"MountPath\":\"/mnt/data\",\"PersistVolumeName\":\"raycluster-20260527110617-96zt-cos-df101a90c4f8e6ca5bce44d009081a69\",\"VolumeMountMode\":\"ReadOnly\"}],\"GooseFSVolumes\":[]}",
"CreateTime": 1779851177634,
"GroupId": "rayclustergroup-tfodxh-vwro",
"GroupName": "group-mao",
"HistoryUrl": "https://cls-pdb9lgk2.tcray-gateway.ap-guangzhou.cloud.tencent.com/dlc-p-bleurqnv/raycluster-20260527110617-96zt/",
"Id": "raycluster-20260527110617-96zt",
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
"Name": "mao",
"Queue": "mao-group",
"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",
"StartTime": 1780112019613,
"Status": "STOPPED",
"StopTime": 1780111979837,
"SubAccountUin": "700002655693",
"Tags": [
{
"TagKey": "env",
"TagValue": "dev"
}
],
"Type": "RAY_CLUSTER",
"Uin": "700002655693",
"RequestId": "ff8c29bc-c676-43ba-9071-18ca8c18d4b8"
}
}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.OtherException | 其他异常：服务遇到未知问题，请稍后再试。 |
