すべてのプロダクト
Search
ドキュメントセンター

:GetRayJob

最終更新日:Sep 03, 2026

Ray タスクのフォーマット情報を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

emr-serverless-spark:GetRayJob

get

*すべてのリソース。

*

なし なし

リクエスト構文

GET /api/v1/workspaces/{workspaceId}/rayJob/{submissionId} HTTP/1.1

パスパラメーター

パラメーター

型

必須 / 任意

説明

例

workspaceId

string

任意

ワークスペースの ID。

w-d2d82aa09155

submissionId

string

任意

Ray タスクの ID。

rj-xxxxxxxxxx

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

requestId

string

リクエスト ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944

submissionId

string

Ray タスクの 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

タスクのステータス。有効な値:

  • Submitted: タスクが送信されました。

  • Pending: クラスターを作成中です。

  • Running: タスクは実行中です。

  • Succeeded: タスクは成功しました。

  • Failed: タスクは失敗しました。

  • Cancelling: タスクをキャンセル中です。

  • Cancelled: タスクはキャンセルされました。

  • Timeout: タスクがタイムアウトし、キャンセルされました。

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

ワーカーノードで自動スケーリングが有効かどうかを示します。

true

idleTimeoutSeconds

integer

自動スケーリングが有効な場合のワーカーノードのアイドルタイムアウト時間。

60

queueName

string

キューの名前。

root_queue

cpu

string

CPU コアの数。

2

memory

string

メモリのサイズ(GiB 単位)。

8Gi

gpuSpec

string

GPU のタイプ。

ecs.gn6i-c4g1.xlarge

displayReleaseVersion

string

Ray DPI エンジンのバージョン。

err-1.3.0 (Ray 2.55.1, Python 3.12)

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

displayReleaseVersion

string

DPI エンジンのバージョン。

ray-1.2.0 (Ray 2.55.1, Python 3.12)

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 クラスターが実行中の場合、これはランタイム 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 クラスターのステータス。有効な値:

  • Deleted: 削除済み。

  • Submitted: 送信済みだが作成は開始されていない。

  • Pending: 作成中。

  • Running: 実行中。

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",
    "displayReleaseVersion": "err-1.3.0 (Ray 2.55.1, Python 3.12)"
  },
  "workerSpecs": [
    {
      "groupName": "WorkerGroup1",
      "replica": 1,
      "minReplica": 1,
      "maxReplica": 10,
      "queueName": "root_queue",
      "cpu": "2",
      "memory": "8Gi",
      "gpuSpec": "ecs.gn6i-c4g1.xlarge",
      "displayReleaseVersion": "ray-1.2.0 (Ray 2.55.1, Python 3.12)"
    }
  ],
  "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"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。