提交Ray Job。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/workspaces/{workspaceId}/rayJob HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
否 |
工作空间 ID。 |
w-d2d82aa09155 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求结构体。 |
|
| entrypoint |
string |
否 |
启动命令。 |
python -c "print('hello ray job')" |
| name |
string |
否 |
任务名称。 |
my-job |
| displayReleaseVersion |
string |
否 |
Ray 引擎版本号。 |
err-1.2.0 (Ray 2.55.1, Python 3.12) |
| tags |
array<object> |
否 |
标签。 |
|
|
object |
否 |
|||
| key |
string |
否 |
键。 |
jobname |
| value |
string |
否 |
值。 |
test |
| networkServiceName |
string |
否 |
网络连接名称。 |
vpc |
| runtimeEnvJson |
string |
否 |
Ray runtime environment JSON 字符串。 |
{"pip":["requests==2.26.0","pendulum==2.1.2"],"env_vars":{"KEY":"VALUE"}} |
| workingDir |
string |
否 |
任务代码工作目录 URL。 |
oss://mybucket/rayjob.zip |
| metadataJson |
string |
否 |
任务元数据 JSON 字符串。 |
{"resourceName": "test"} |
| submissionMode |
string |
否 |
提交作业方式。 |
HTTPMode |
| entrypointNumCpus |
string |
否 |
入口任务申请的 CPU 数量。 |
1 |
| entrypointNumGpus |
string |
否 |
入口任务申请的 GPU 数量。 |
0 |
| entrypointMemory |
string |
否 |
入口任务申请的内存大小。 |
4Gi |
| entrypointResources |
string |
否 |
入口任务自定义资源请求 JSON 字符串。 |
{"fpu": 1} |
| shutdownAfterJobFinishes |
boolean |
否 |
任务完成后是否自动销毁临时集群，默认 true。 |
true |
| ttlSecondsAfterFinished |
integer |
否 |
集群销毁前等待秒数，shutdownAfterJobFinishes 为 true 时有效。 |
60 |
| activeDeadlineSeconds |
integer |
否 |
任务超时时间，包含集群创建和任务运行时间，超过该时间任务会被取消。 |
3600 |
| volumeIds |
array |
否 |
挂载卷 ID 列表。 |
|
|
string |
否 |
纳管文件 id。 |
vol-12345678 |
|
| headSpec |
object |
否 |
Ray 集群 Head 节点参数。 |
|
| queueName |
string |
否 |
队列名称。 |
root_queue |
| cpu |
string |
否 |
CPU 核数。 |
2 |
| memory |
string |
否 |
内存，单位 Gi。 |
8Gi |
| enableAutoScaling |
boolean |
否 |
是否开启 Worker 自动扩缩容。 |
true |
| idleTimeoutSeconds |
integer |
否 |
开启自动扩缩容后 Worker Idle 时间。 |
60 |
| gpuSpec |
string |
否 |
gpu 机型。 |
ecs.gn6i-c4g1.xlarge |
| workerSpec |
array<object> |
否 |
Ray 集群 Worker 节点参数。 |
|
|
object |
否 |
Worker 节点结构体。 |
||
| groupName |
string |
否 |
Worker 组名。 |
WorkerGroup1 |
| workerType |
string |
否 |
Worker 类型。 |
CPU |
| replica |
integer |
否 |
Worker 数量。 |
2 |
| queueName |
string |
否 |
队列名称。 |
root_queue |
| cpu |
string |
否 |
CPU 核数。 |
4 |
| memory |
string |
否 |
内存，单位 Gi。 |
16Gi |
| minReplica |
integer |
否 |
开启自动扩缩容后最小 Worker 数量。 |
1 |
| maxReplica |
integer |
否 |
开启自动扩缩容后最大 Worker 数量。 |
10 |
| gpuSpec |
string |
否 |
gpu 机型。 |
ecs.gn6i-c4g1.xlarge |
| extraParam |
string |
否 |
额外参数 JSON 字符串。 |
{"userDefinedFiles": "oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json", "userRequirementsFile": "oss://mybucket/requirements.txt"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| submissionId |
string |
Ray Job ID。 |
rj-k7nm8ahl5te4tg91 |
示例
正常返回示例
JSON格式
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"submissionId": "rj-k7nm8ahl5te4tg91"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。