DocsICP FilingConsole
官方文档
首页

ListRayCluster

更新时间：
复制 MD 格式
产品详情
我的收藏

Lists Ray clusters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr-serverless-spark:ListRayCluster

none

*All Resource

*

 None None

Request syntax

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

Path Parameters

Parameter

Type

Required

Description

Example
workspaceId

string

No

The workspace ID.

w-d2d82aa09155

Request parameters

Parameter

Type

Required

Description

Example
pageSize

integer

No

The number of entries per page. Default value: 20. Valid values: 1 to 100.

20
pageNum

integer

No

The page number.

1

Response elements

Element

Type

Description

Example

object

The response schema.

requestId

string

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944
rayClusters

array<object>

The list of Ray clusters.

array<object>

The Ray cluster struct.

clusterId

string

The cluster ID.

ray-uiulpgow9xljimm1
name

string

The name of the Ray cluster.

testRayCluster
displayReleaseVersion

string

The Ray engine version.

ray-1.0.0 (Ray 2.47.1, Python 3.12)
description

string

The description.

Ray Cluster for dev.
networkServiceName

string

The name of the network connectivity service.

vpc
headSpec

object

The information about the head node of the Ray cluster.

queueName

string

The queue name.

root_queue
cpu

string

The number of CPU cores.

2
memory

string

The memory size. Unit: Gi.

8Gi
enableAutoScaling

boolean

Indicates whether automatic scaling is enabled for worker nodes.

false
idleTimeoutSeconds

integer

The idle timeout period for worker nodes.

60
replica

integer

The number of nodes.

1
gpuSpec

string

ecs.gn6i-c4g1.xlarge
workerSpec

array<object>

The information about the worker nodes of the Ray cluster.

object

The struct of the worker node information for the Ray cluster.

groupName

string

The name of the worker group.

Group1
workerType

string

The worker type.

CPU
replica

integer

The number of nodes.

2
queueName

string

The queue name.

root_queue
cpu

string

The number of CPU cores.

2
memory

string

The memory size. Unit: Gi.

8Gi
minReplica

integer

The minimum number of worker nodes after automatic scaling is enabled.

1
maxReplica

integer

The maximum number of worker nodes after automatic scaling is enabled.

10
gpuSpec

string

ecs.gn6i-c4g1.xlarge
state

string

The cluster state.

  • Starting: The cluster is starting.

  • Running: The cluster is running.

  • Stopping: The cluster is stopping.

  • Stopped: The cluster is stopped.

  • Error: The cluster has failed.

Running
createTime

integer

The time when the cluster was created.

1723722279800
modifiedTime

integer

The time when the cluster was last modified.

1723722279800
creator

string

The UID of the user who created the cluster.

202077646755123991
creatorName

string

The nickname of the creator.

Alice
modifier

string

The UID of the user who last updated the cluster.

202077646755123991
modifierName

string

The nickname of the modifier.

Alice
userId

string

The ID of the Alibaba Cloud account.

1234567890
dashboardUrl

string

The URL of the Ray cluster dashboard.

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

boolean

Indicates whether the configuration has been modified.

false
message

string

The error message.

ok
instanceId

string

The ID of the Ray cluster instance.

ray-uiulpgow9xljimm1-xxxxxxx
startTime

integer

The startup time.

1723722279800
grpcEndpoint

string

The gRPC endpoint for the internal network. The domain name can also be used to submit Ray jobs.

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

Examples

Success response

JSON format

{
  "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"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.