Ray Job の情報を取得します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /api/v1/workspaces/{workspaceId}/rayJob/{submissionId} HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| workspaceId |
string |
任意 |
ワークスペースの ID。 |
w-d2d82aa09155 |
| submissionId |
string |
任意 |
Ray Job の ID。 |
rj-xxxxxxxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ。 |
||
| requestId |
string |
リクエストの ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| submissionId |
string |
Ray Job の ID。 |
rj-xxxxxxxxxx |
| name |
string |
Ray クラスターの名前。 |
myRayCluster |
| displayReleaseVersion |
string |
Ray DPI エンジンのバージョン。 |
err-1.2.0 (Ray 2.55.1, Python 3.12) |
| tags |
array |
タグ。 |
|
| Tag |
タグ。 |
||
| status |
string |
タスクのステータス。有効な値:
|
Running |
| message |
string |
実行メッセージ。 |
Job finished successfully. |
| entrypoint |
string |
起動コマンド。 |
python main.py |
| submitTime |
integer |
タスクの送信時間。この値はミリ秒単位の UNIX タイムスタンプです。 |
1750327082303 |
| startTime |
integer |
開始時刻。この値はミリ秒単位の UNIX タイムスタンプです。 |
1750327083303 |
| endTime |
integer |
タスクの終了時間。この値はミリ秒単位の UNIX タイムスタンプです。 |
1762949372000 |
| duration |
integer |
タスクの持続時間 (秒単位)。 |
2459764 |
| 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/hello.zip |
| submissionMode |
string |
タスクの送信モード。 |
HTTPMode |
| metadataJson |
string |
タスクメタデータの JSON 文字列。 |
{"owner": "alice"} |
| 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-123456789 |
|
| backoffLimit |
integer |
失敗時のリトライ回数。現在は 0 に固定されています。 |
2 |
| headSpec |
object |
Ray クラスターのヘッドノードパラメーター。 |
|
| replica |
integer |
ノードの数。 |
1 |
| enableAutoScaling |
boolean |
ワーカーノードで auto scaling が有効かどうかを示します。 |
true |
| idleTimeoutSeconds |
integer |
auto scaling が有効な場合のワーカーノードのアイドルタイムアウト (秒単位)。 |
60 |
| queueName |
string |
キューの名前。 |
root_queue |
| cpu |
string |
CPU コアの数。 |
2 |
| memory |
string |
メモリのサイズ (GiB 単位)。 |
8Gi |
| gpuSpec |
string |
GPU のタイプ。 |
ecs.gn6i-c4g1.xlarge |
| workerSpecs |
array<object> |
Ray クラスターのワーカーノード情報構造体。 |
|
|
object |
Ray クラスターのワーカーノード情報構造体。 |
||
| groupName |
string |
ワーカーノードグループの名前。 |
WorkerGroup1 |
| replica |
integer |
ワーカーノードの数。 |
1 |
| minReplica |
integer |
ワーカーの最小値。 |
1 |
| maxReplica |
integer |
ワーカーの最大値。 |
10 |
| queueName |
string |
キューの名前。 |
root_queue |
| cpu |
string |
CPU コアの数。 |
2 |
| memory |
string |
メモリのサイズ (GiB 単位)。 |
8Gi |
| 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"} |
| creatorName |
string |
作成者のニックネーム。 |
Alice |
| dashboardUrl |
string |
Ray クラスターのダッシュボード URL。Ray クラスターが Running 状態の場合、これはランタイム UI です。クラスターが削除された後は、履歴 UI になります。履歴 UI は err-1.2.0 以降のバージョンでのみサポートされています。 |
https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx |
| logBucketName |
string |
ログを保存するバケットの名前。 |
ss-ray-cn-hangzhou |
| logPath |
string |
ログが保存されるパス。 |
w-xxxxxxx/ray/logs/xxxxxx/ |
| cuHours |
number |
消費された CU リソース。この値はクラスターのリリースから 10 分後に返されます。 |
1899 |
| guHours |
object |
消費された GPU 時間。現在は空です。 |
|
| gpuSpec |
string |
GPU のタイプ。 |
ecs.gn6i-c4g1.xlarge |
| gpuHours |
number |
消費された GPU 時間。 |
2.6 |
| dashboardUrlExtra |
array |
追加のダッシュボード UI URL。現在は空です。 |
|
|
string |
追加のダッシュボード UI URL。現在は空です。 |
- |
|
| clusterState |
string |
対応する Ray クラスターのステータス。有効な値:
|
Running |
| taskBizId |
string |
データ開発タスクの ID。 |
TSK-682e0112f6f24d9f9305b92174846985 |
例
成功レスポンス
JSONJSON
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"submissionId": "rj-xxxxxxxxxx",
"name": "myRayCluster",
"displayReleaseVersion": "err-1.2.0 (Ray 2.55.1, Python 3.12)",
"tags": [
{
"key": "workflowId",
"value": "wf-123test"
}
],
"status": "Running",
"message": "Job finished successfully.",
"entrypoint": "python main.py",
"submitTime": 1750327082303,
"startTime": 1750327083303,
"endTime": 1762949372000,
"duration": 2459764,
"networkServiceName": "vpc",
"runtimeEnvJson": "{\"pip\":[\"requests==2.26.0\",\"pendulum==2.1.2\"],\"env_vars\":{\"KEY\":\"VALUE\"}}",
"workingDir": "oss://mybucket/hello.zip",
"submissionMode": "HTTPMode",
"metadataJson": "{\"owner\": \"alice\"}",
"entrypointNumCpus": "1",
"entrypointNumGpus": "0",
"entrypointMemory": "4Gi",
"entrypointResources": "{\"fpu\": 1}",
"shutdownAfterJobFinishes": true,
"ttlSecondsAfterFinished": 60,
"activeDeadlineSeconds": 3600,
"volumeIds": [
"vol-123456789"
],
"backoffLimit": 2,
"headSpec": {
"replica": 1,
"enableAutoScaling": true,
"idleTimeoutSeconds": 60,
"queueName": "root_queue",
"cpu": "2",
"memory": "8Gi",
"gpuSpec": "ecs.gn6i-c4g1.xlarge"
},
"workerSpecs": [
{
"groupName": "WorkerGroup1",
"replica": 1,
"minReplica": 1,
"maxReplica": 10,
"queueName": "root_queue",
"cpu": "2",
"memory": "8Gi",
"gpuSpec": "ecs.gn6i-c4g1.xlarge"
}
],
"extraParam": "{\"userDefinedFiles\": \"oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json\", \"userRequirementsFile\": \"oss://mybucket/requirements.txt\"}",
"creatorName": "Alice",
"dashboardUrl": "https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx",
"logBucketName": "ss-ray-cn-hangzhou",
"logPath": "w-xxxxxxx/ray/logs/xxxxxx/",
"cuHours": 1899,
"guHours": {
"gpuSpec": "ecs.gn6i-c4g1.xlarge",
"gpuHours": 2.6
},
"dashboardUrlExtra": [
"-"
],
"clusterState": "Running",
"taskBizId": "TSK-682e0112f6f24d9f9305b92174846985"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。