1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
提交新的Ray任务到指定集群
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitRayJob。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| Entrypoint | 是 | String | 入口命令 示例值:sleep 1 |
| ClusterId | 否 | String | 集群ID 示例值:ray-cluster |
| ResourcePartitionId | 否 | String | 资源分区ID 示例值:dlc-p |
| Queue | 否 | String | 队列名称 示例值:default |
| JobName | 否 | String | 任务名称 示例值:testhaha |
| RuntimeEnv | 否 | String | 运行时环境 示例值:{"py_modules":["/path/to/my_module","s3://bucket/my_lib.zip"],"working_dir":"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip"} |
| Image | 否 | String | 镜像名称 示例值:ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-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":[]}]} |
| Catalog | 否 | String | 目录 示例值:{"CFSVolumes":[],"COSVolumes":[]} |
| AutoscalerOptions | 否 | String | 弹性伸缩配置 示例值:{"upscalingMode":"Default","idleTimeoutSeconds":60,"resourceSpec":"small","resources":{"cpu":"500m","memory":"512Mi"}} |
| AdvancedOptions | 否 | String | 高级参数,JSON 字符串(透传到 Neutrino) 示例值:{"spec.submitterPodTemplate.metadata.labels.test":"test"} |
| GroupId | 否 | String | 计算组ID;与 ClusterId 互斥。组成员展开为候选集群后由 neutrino 侧路由 示例值:rayclustergroup-tfsceo-s2fb |
| DispatchStrategy | 否 | String | 集群分派策略,本期仅支持 RANDOM;大小写不敏感 示例值:RANDOM |
| Priority | 否 | Integer | 作业优先级(1-9,数字越大优先级越高) 示例值:5 |
| Tags.N | 否 | Array of Tag | 标签列表(TagKey-TagValue),用于将资源与腾讯云标签系统中的标签绑定 |
| JobPackage | 否 | String | 作业包 URL 示例值:https:cos.com |
| JobPackageName | 否 | String | 作业包名称 示例值:作业包名称 |
| JobPackageSource | 否 | String | 作业包来源类型(Local: 本地上传, Cos: 用户自有 COS 桶地址);缺省时按 Local 处理 示例值:Local |
| JobSource | 否 | String | 业务来源标识,只为调用上下文,不落盘 JobSpec 示例值:workflow |
| FlowId | 否 | String | 外部工作流引擎业务键 flowId 示例值:flow-001 |
| ExecutionId | 否 | String | 外部工作流引擎业务键 executionId 示例值:exec-001 |
| NetworkConfig | 否 | String | 用户网络配置 JSON 字符串 示例值:{"AppId":"1305424723","Uin":"100018379117","UniqVpcId":"vpc-c9wbgd6b","SubnetId":"subnet-7vmpcxoo","ConnectionId":"nc-229e38ddb80949acb89207b99ff92de1","ConnectionName":"lyr_test_one"} |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 任务ID 示例值:rayjob-20260325152655-2py2 |
| ClusterId | String | 所属集群ID 示例值:ray-cluster |
| ResourcePartitionId | String | 所属资源分区ID 示例值:dlc-p |
| ResourcePartitionName | String | 默认资源分区名称 示例值:test0701 |
| Queue | String | 所属队列名称 示例值:default |
| SubmissionId | String | Ray Submission ID 示例值:exec-001 |
| Status | String | 任务状态 示例值:SUBMITTED |
| Entrypoint | String | 入口命令 示例值:sleep 1 |
| JobName | String | 任务名称 示例值:testhaha |
| AppId | Integer | 应用ID 示例值:260090589 |
| Uin | String | 用户UIN 示例值:700002467852 |
| SubAccountUin | String | 子用户UIN 示例值:700002467852 |
| SubAccountName | String | 子用户名称(由聚合层通过 CAM 接口回填) 示例值:700002744585 |
| HistoryUrl | String | 历史记录链接 示例值:https:url |
| RunningTime | Integer | 运行时间(ms) 示例值:13 |
| FinishTime | Integer | 完成时间 示例值:1780029643351 |
| CreateTime | Integer | 创建时间 示例值:1780029643351 |
| ErrorMessage | String | 失败原因/错误信息 示例值:error |
| RuntimeEnv | String | 运行时环境配置(JSON) 示例值:{"py_modules":["/path/to/my_module","s3://bucket/my_lib.zip"],"working_dir":"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip"} |
| Image | String | 镜像地址 示例值:ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu |
| 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":[]}]} |
| Catalog | String | 存储卷和挂载卷配置(JSON) 示例值:{"CFSVolumes":[],"COSVolumes":[]} |
| ImagePullPolicy | String | 镜像拉取策略 示例值:IfNotPresent |
| AutoscalerOptions | String | 弹性伸缩配置(JSON) 示例值:{"upscalingMode":"Default","idleTimeoutSeconds":60,"resourceSpec":"small","resources":{"cpu":"500m","memory":"512Mi"}} |
| SpecId | String | 来源配置ID 示例值:jobspec |
| SpecName | String | 来源配置名称 示例值:jobspec名称 |
| AdvancedOptions | String | 高级参数,JSON 字符串(透传到 Neutrino) 示例值:{"spec.submitterPodTemplate.metadata.labels.test":"test"} |
| Priority | Integer | 作业优先级(1-9,数字越大优先级越高) 示例值:5 |
| Tags | Array of Tag | 标签列表(TagKey-TagValue),用于将资源与腾讯云标签系统中的标签绑定 |
| JobSource | String | 业务来源标识(调用上下文) 示例值:workflow |
| ClusterName | String | 集群名称 示例值:raycluster-20260529142346-h56t |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交Ray任务
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitRayJob
<公共请求参数>
{
"ClusterId": "ray-cluster",
"Entrypoint": "sleep 1",
"ResourcePartitionId": "dlc-p",
"Queue": "default",
"JobName": "testhaha",
"RuntimeEnv": "{\"py_modules\":[\"/path/to/my_module\",\"s3://bucket/my_lib.zip\"],\"working_dir\":\"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip\"}",
"Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
"ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"PodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"HighAvailability\":false,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":1,\"MaxPodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null}]}",
"Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
"AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
"ImagePullPolicy": "IfNotPresent"
}
输出示例
{
"Response": {
"AppId": 260090589,
"AutoscalerOptions": "{\"upscalingMode\":\"Default\",\"idleTimeoutSeconds\":60,\"resourceSpec\":\"small\",\"resources\":{\"cpu\":\"500m\",\"memory\":\"512Mi\"}}",
"Catalog": "{\"CFSVolumes\":[],\"COSVolumes\":[]}",
"ClusterId": "ray-cluster",
"CreateTime": 1774423615823,
"Entrypoint": "sleep 1",
"Id": "rayjob-20260325152655-2py2",
"Image": "ccr.ccs.tencentyun.com/tcray-xpark/xpark:0.0.0.dev0-ray2.54.0-py312-cpu",
"ImagePullPolicy": "IfNotPresent",
"JobName": "testhaha",
"Queue": "default",
"ResourceConfig": "{\"Head\":{\"Name\":\"Head\",\"PodCpu\":1,\"PodMem\":2,\"PodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"HighAvailability\":false,\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null},\"Worker\":[{\"Name\":\"Worker01\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":1,\"MaxPodNum\":1,\"GpuType\":\"\",\"GpuNum\":0,\"Envs\":[],\"Labels\":[],\"ResourceType\":null,\"InstanceType\":null,\"Spec\":null}]}",
"ResourcePartitionId": "dlc-p",
"RunningTime": 13,
"RuntimeEnv": "{\"py_modules\":[\"/path/to/my_module\",\"s3://bucket/my_lib.zip\"],\"working_dir\":\"https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/job-packages/260090589/20260324210556/b765a3a7-d630-46a5-bba3-866212d027d4.zip\"}",
"Status": "SUBMITTED",
"SubAccountUin": "700002467852",
"Uin": "700002467852",
"RequestId": "b71be97e-3007-46d2-be52-0969ec691b78"
}
}
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 | 外部服务异常 |