Ray タスクを送信します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
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 DPI エンジンのバージョン番号。 |
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 実行環境の 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 クラスターのヘッドノードのパラメーター。 |
|
| queueName |
string |
任意 |
キューの名前。 |
root_queue |
| cpu |
string |
任意 |
CPU のコア数。 |
2 |
| memory |
string |
任意 |
メモリのサイズ。単位: Gi。 |
8Gi |
| enableAutoScaling |
boolean |
任意 |
ワーカーの自動スケーリングを有効にするかどうかを指定します。 |
true |
| idleTimeoutSeconds |
integer |
任意 |
自動スケーリングが有効な場合のワーカーのアアイドルタイムアウト期間。 |
60 |
| gpuSpec |
string |
任意 |
GPU のインスタンスタイプ。 |
ecs.gn6i-c4g1.xlarge |
| workerSpec |
array<object> |
任意 |
Ray クラスターのワーカーノードのパラメーター。 |
|
|
object |
任意 |
ワーカーノードの構造体。 |
||
| groupName |
string |
任意 |
ワーカグループの名前。 |
WorkerGroup1 |
| workerType |
string |
任意 |
ワーカーのタイプ。 |
CPU |
| replica |
integer |
任意 |
ワーカーの数。 |
2 |
| queueName |
string |
任意 |
キューの名前。 |
root_queue |
| cpu |
string |
任意 |
CPU のコア数。 |
4 |
| memory |
string |
任意 |
メモリのサイズ。単位: Gi。 |
16Gi |
| minReplica |
integer |
任意 |
自動スケーリングが有効な場合のワーカーの最小値。 |
1 |
| maxReplica |
integer |
任意 |
自動スケーリングが有効な場合のワーカーの最大値。 |
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 |
応答スキーマ。 |
||
| requestId |
string |
リクエストの ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| submissionId |
string |
Ray タスクの ID。 |
rj-k7nm8ahl5te4tg91 |
例
成功レスポンス
JSONJSON
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"submissionId": "rj-k7nm8ahl5te4tg91"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。