すべてのプロダクト
Search

このプロダクト

    :ListRayCluster

    ドキュメントセンター

    :ListRayCluster

    最終更新日: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:ListRayCluster

    none

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    workspaceId

    string

    任意

    ワークスペース ID。

    w-d2d82aa09155

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    pageSize

    integer

    任意

    ページあたりのエントリ数。デフォルト値：20。有効値の範囲：1～100。

    20
    pageNum

    integer

    任意

    ページ番号。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    requestId

    string

    リクエスト ID。

    DD6B1B2A-5837-5237-ABE4-FF0C8944
    rayClusters

    array<object>

    Ray クラスターのリスト。

    array<object>

    Ray クラスターの構造体。

    clusterId

    string

    クラスター ID。

    ray-uiulpgow9xljimm1
    name

    string

    Ray クラスターの名前。

    testRayCluster
    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
    workerSpec

    array<object>

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

    object

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

    groupName

    string

    ワーカーグループの名前。

    Group1
    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
    state

    string

    クラスターの状態。

    • Starting：クラスターは起動中です。

    • Running：クラスターは実行中です。

    • Stopping：クラスターは停止中です。

    • Stopped：クラスターは停止済みです。

    • Error：クラスターは失敗しました。

    Running
    createTime

    integer

    クラスターが作成された時間。

    1723722279800
    modifiedTime

    integer

    クラスターが最後に変更された時間。

    1723722279800
    creator

    string

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

    202077646755123991
    creatorName

    string

    作成者のニックネーム。

    Alice
    modifier

    string

    クラスターを最後に更新したユーザーの UID。

    202077646755123991
    modifierName

    string

    更新者のニックネーム。

    Alice
    userId

    string

    Alibaba Cloud アカウントの ID。

    1234567890
    dashboardUrl

    string

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

    https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx
    modified

    boolean

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

    false
    message

    string

    エラーメッセージ。

    ok
    instanceId

    string

    Ray クラスターインスタンスの ID。

    ray-uiulpgow9xljimm1-xxxxxxx
    startTime

    integer

    起動時間。

    1723722279800
    grpcEndpoint

    string

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

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

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "rayClusters": [
    {
      "clusterId": "ray-uiulpgow9xljimm1",
      "name": "testRayCluster",
      "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"
      },
      "workerSpec": [
        {
          "groupName": "Group1",
          "workerType": "CPU",
          "replica": 2,
          "queueName": "root_queue",
          "cpu": "2",
          "memory": "8Gi",
          "minReplica": 1,
          "maxReplica": 10,
          "gpuSpec": "ecs.gn6i-c4g1.xlarge"
        }
      ],
      "state": "Running",
      "createTime": 1723722279800,
      "modifiedTime": 1723722279800,
      "creator": "202077646755123991",
      "creatorName": "Alice",
      "modifier": "202077646755123991",
      "modifierName": "Alice",
      "userId": "1234567890",
      "dashboardUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx",
      "modified": false,
      "message": "ok",
      "instanceId": "ray-uiulpgow9xljimm1-xxxxxxx",
      "startTime": 1723722279800,
      "grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80"
    }
  ]
}

    エラーコード

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

    変更履歴

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