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

:GetRayCluster

最終更新日:Mar 23, 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:GetRayCluster

get

*All Resource

*

なし なし

リクエスト構文

GET /api/v1/workspaces/{workspaceId}/rayCluster/{clusterId} HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

workspaceId

string

任意

ワークスペースの ID です。

w-d2d82aa09155

clusterId

string

任意

クラスターの ID です。

ray-xxxxxxxxxx

リクエストパラメーター

パラメーター

必須 / 任意

説明

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

レスポンスフィールド

フィールド

説明

object

応答スキーマです。

requestId

string

リクエスト ID です。

DD6B1B2A-5837-5237-ABE4-FF0C8944

clusterId

string

Ray クラスターの ID です。

ray-k7nm8ahl5te4tg91

name

string

Ray クラスターの名前です。

myRayCluster

displayReleaseVersion

string

Ray エンジンのバージョンです。

ray-1.0.0 (Ray 2.47.1, Python 3.12)

description

string

説明文です。

Ray Cluster for dev.

networkServiceName

string

ネットワーク接続の名前です。

vpc

headSpec

object

Ray クラスターのヘッドノードのパラメーターです。

queueName

string

キューの名前です。

root_queue

cpu

string

CPU コア数です。

2

memory

string

メモリサイズです。単位:Gi。

8Gi

enableAutoScaling

boolean

ワーカーノードに対する自動スケーリングの有効化状態です。

false

idleTimeoutSeconds

integer

自動スケーリングが有効な場合の、ワーカーノードのアイドルタイムアウト(秒)です。

60

replica

integer

ノード数です。

1

gpuSpec

string

ecs.gn6i-c4g1.xlarge

state

string

セッションの状態です。

  • Starting:セッション起動中です。

  • Running:セッション実行中です。

  • Stopping:セッション停止中です。

  • Stopped:セッションは停止しています。

  • Error:セッションに失敗しました。

Running

creator

string

クラスターを作成したユーザーの UID です。

202077646755523991

creatorName

string

作成者のニックネームです。

Alice

modifier

string

クラスターを更新したユーザーの UID です。

202077646755523991

modifierName

string

更新者のニックネームです。

Alice

userId

string

作成者の Alibaba Cloud アカウントの ID です。

123456789012

dashboardUrl

string

Ray クラスターダッシュボードの URL です。

https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx

jobUrl

string

Ray ジョブを送信するためのパブリックエンドポイントです。

https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com

submitToken

string

Ray ジョブを送信するための認証トークンです。「ray-token」: 「token」という形式でリクエストヘッダーに追加してください。

1d06484d3b424f7fa4ab7082a4076da2

modified

boolean

構成が変更されたかどうかを示します。

false

extraParam

string

JSON 形式の追加パラメーターです。

{}

message

string

state が Error の場合に返されるエラーメッセージです。

ok

instances

array<object>

Ray クラスターノードの ID です。

object

Ray クラスターノードのデータ構造です。

type

string

ノードタイプです。

Head

instanceId

string

ノード ID です。

ray-uiulpgow9xljim10-head-7cgta

containerState

string

メインコンテナの状態です。

Running

reason

string

ノード情報です。

OOMKilled

phase

string

ノード Pod のステータスです。

Running

message

string

ノード Pod のステータスメッセージです。

ok

startTime

integer

開始時刻です。

1762946698000

createTime

integer

作成時刻です。

1735870116167

containerStateReason

string

メインコンテナに関する情報です。

ok

containerStateMessage

string

メインコンテナのステータスメッセージです。

ContainerExit

containerExitCode

integer

メインコンテナの終了コードです。

137

instanceId

string

Ray クラスターノードの ID です。

ray-k7nm8ahl5te4tg93-xxxxxxx

workerSpec

array<object>

Ray クラスターのワーカーノードに関する情報です。

object

Ray クラスターのワーカーノード情報のデータ構造です。

groupName

string

ワーカーノードグループの名前です。

WorkerGroup1

workerType

string

ワーカーノードグループのタイプです。

CPU

replica

integer

ワーカーノードの数です。

2

queueName

string

キューの名前です。

root_queue

cpu

string

CPU コア数です。

2

memory

string

メモリサイズです。単位:Gi。

8Gi

minReplica

integer

ワーカーノードの最小数です。

1

maxReplica

integer

ワーカーノードの最大数です。

10

gpuSpec

string

ecs.gn6i-c4g1.xlarge

startTime

integer

開始時刻です。UNIX タイムスタンプ(ミリ秒)です。

1750327083303

createTime

integer

作成時刻です。UNIX タイムスタンプ(ミリ秒)です。

1750327083303

modifiedTime

integer

更新時刻です。UNIX タイムスタンプ(ミリ秒)です。

1754274541693

grpcEndpoint

string

内部ネットワーク向けの gRPC エンドポイントです。このエンドポイントのドメイン名を使用して、Ray ジョブを送信することもできます。

ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80

volumeIds

array

string

vol-123456789

jobUrlInner

string

http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com

成功レスポンス

JSONJSON

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "clusterId": "ray-k7nm8ahl5te4tg91",
  "name": "myRayCluster",
  "displayReleaseVersion": "ray-1.0.0 (Ray 2.47.1, Python 3.12)",
  "description": "Ray Cluster for dev.",
  "networkServiceName": "vpc",
  "headSpec": {
    "queueName": "root_queue",
    "cpu": "2",
    "memory": "8Gi",
    "enableAutoScaling": false,
    "idleTimeoutSeconds": 60,
    "replica": 1,
    "gpuSpec": "ecs.gn6i-c4g1.xlarge"
  },
  "state": "Running",
  "creator": "202077646755523991",
  "creatorName": "Alice",
  "modifier": "202077646755523991",
  "modifierName": "Alice",
  "userId": "123456789012",
  "dashboardUrl": "https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx",
  "jobUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com",
  "submitToken": "1d06484d3b424f7fa4ab7082a4076da2",
  "modified": false,
  "extraParam": "{}",
  "message": "ok",
  "instances": [
    {
      "type": "Head",
      "instanceId": "ray-uiulpgow9xljim10-head-7cgta",
      "containerState": "Running",
      "reason": "OOMKilled",
      "phase": "Running",
      "message": "ok",
      "startTime": 1762946698000,
      "createTime": 1735870116167,
      "containerStateReason": "ok",
      "containerStateMessage": "ContainerExit",
      "containerExitCode": 137
    }
  ],
  "instanceId": "ray-k7nm8ahl5te4tg93-xxxxxxx",
  "workerSpec": [
    {
      "groupName": "WorkerGroup1",
      "workerType": "CPU",
      "replica": 2,
      "queueName": "root_queue",
      "cpu": "2",
      "memory": "8Gi",
      "minReplica": 1,
      "maxReplica": 10,
      "gpuSpec": "ecs.gn6i-c4g1.xlarge"
    }
  ],
  "startTime": 1750327083303,
  "createTime": 1750327083303,
  "modifiedTime": 1754274541693,
  "grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80",
  "volumeIds": [
    "vol-123456789"
  ],
  "jobUrlInner": "http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com"
}

エラーコード

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

変更履歴

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