1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
创建集群
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateRayCluster。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Name | 否 | String | 集群名称(可选,不填写则默认使用集群ID) 示例值:aidanyxu-test |
| Description | 否 | String | 集群描述 示例值:测试计算组 |
| GroupId | 否 | String | 所属计算组 ID 示例值:rayclustergroup-tfh4u6-bcqz |
| ResourcePartitionId | 否 | String | 所属资源分区ID 示例值:dlc-p-ikzmoqyv |
| Queue | 否 | String | 所属队列名称 示例值:default |
| Image | 否 | String | 镜像地址 示例值:ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu |
| ImagePullPolicy | 否 | String | 镜像拉取策略(Always, IfNotPresent, Never) 示例值:IfNotPresent |
| ImagePullType | 否 | String | 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR) 示例值:BuiltIn |
| ResourceConfig | 否 | String | 资源配置 示例值:{"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":[]}]} |
| ResourceConfigId | 否 | String | 资源配置ID 示例值:cf82820d-22a9-458f-ae3f-108137ab55af |
| Catalog | 否 | String | 存储卷和挂载卷配置 示例值:{"CFSVolumes":[],"COSVolumes":[]} |
| AdvancedOptions | 否 | String | 高级参数(规范化后的扁平 KV JSON) 示例值:{"spec.suspend": "true"} |
| Priority | 否 | Integer | 优先级(1-9,数字越大优先级越高) 示例值:5 |
| Tags.N | 否 | Array of Tag | 标签列表(TagKey-TagValue),用于将资源与腾讯云标签系统中的标签绑定 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 集群ID 示例值: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 | 集群状态 示例值:INIT |
| CreateTime | Integer | 创建时间 示例值:1780398810514 |
| GroupId | String | 计算组 ID 示例值:rayclustergroup-tfh4u6-bcqz |
| ResourceConfig | String | 资源配置(JSON) 示例值:{"Head":{},"Worker":[{}]} |
| ResourceConfigId | String | 资源配置ID 示例值:cf82820d-22a9-458f-ae3f-108137ab55af |
| Image | String | 镜像地址 示例值:ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu |
| Catalog | String | 存储卷和挂载卷配置(JSON) 示例值:{"CFSVolumes":[],"COSVolumes":[]} |
| ImagePullPolicy | String | 镜像拉取策略 示例值:IfNotPresent |
| ImagePullType | String | 镜像拉取类型(BuiltIn: 内置, Custom: 自定义-TCR, CustomCcr: 自定义-CCR) 示例值:BuiltIn |
| AdvancedOptions | String | 高级参数(规范化后的扁平 KV JSON) 示例值:{"spec.suspend": "true"} |
| Priority | Integer | 优先级(1-9,数字越大优先级越高) 示例值:5 |
| 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: CreateRayCluster
<公共请求参数>
{
"Name": "aidanyxu-test",
"GroupId": "",
"ResourcePartitionId": "dlc-p-ikzmoqyv",
"Queue": "default",
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
"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",
"AdvancedOptions": "{\"spec.suspend\": \"true\"}",
"Priority": 5
}
输出示例
{
"Response": {
"AdvancedOptions": "{\"spec.suspend\": \"true\"}",
"AppId": 260200065,
"CreateTime": 1780398810514,
"GroupId": "",
"Id": "raycluster-20260602191330-yej4",
"Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
"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": "INIT",
"SubAccountUin": "700002655693",
"Type": "RAY_CLUSTER",
"Uin": "700002655693",
"RequestId": "bc2f8a0a-7861-4165-b4ad-5d83f3577ee0"
}
}
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.ExternalService | 外部服务异常 |