ListRayCluster - E-MapReduce - Alibaba Cloud Documentation Center

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

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 to return on each page. Default value: 20. Minimum value: 1. Maximum value: 100.	20
pageNum	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944
rayClusters	array<object>	The list of Ray clusters.
	array<object>	The Ray cluster structure.
clusterId	string	The cluster ID.	ray-uiulpgow9xljimm1
name	string	The name of the Ray cluster.	testRayCluster
displayReleaseVersion	string	The Ray DPI engine version.	ray-1.0.0 (Ray 2.47.1, Python 3.12)
description	string	The description.	Ray Cluster for dev.
networkServiceName	string	The network connectivity name.	vpc
headSpec	object	The head node information of the Ray cluster.
queueName	string	The name of the queue.	root_queue
cpu	string	The number of CPU cores.	2
memory	string	The memory size, in GiB.	8Gi
enableAutoScaling	boolean	Specifies whether auto scaling is enabled for worker nodes.	false
idleTimeoutSeconds	integer	The idle timeout for worker nodes, in seconds.	60
replica	integer	The number of nodes.	1
gpuSpec	string	The GPU instance type.	ecs.gn6i-c4g1.xlarge
workerSpec	array<object>	The worker information of the Ray cluster.
	object	The worker information structure of the Ray cluster.
groupName	string	The name of the worker group.	Group1
workerType	string	The type of the worker. Valid values: CPU : CPU worker.	CPU
replica	integer	The number of nodes.	2
queueName	string	The name of the queue.	root_queue
cpu	string	The number of CPU cores.	2
memory	string	The memory size, in GiB.	8Gi
minReplica	integer	The minimum number of workers when auto scaling is enabled.	1
maxReplica	integer	The maximum number of workers when auto scaling is enabled.	10
gpuSpec	string	The GPU instance type.	ecs.gn6i-c4g1.xlarge
state	string	The cluster status. Valid values: 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. Valid values: Stopped : Stopped. Starting : Starting. Running : Running. Error : Error. Stopping : Stopping.	Running
createTime	integer	The creation time. The value is a UNIX timestamp in milliseconds.	1723722279800
modifiedTime	integer	The modification time. The value is a UNIX timestamp in milliseconds.	1723722279800
creator	string	The UID of the creator.	202077646755123991
creatorName	string	The nickname of the creator.	Alice
modifier	string	The UID of the last updater.	202077646755123991
modifierName	string	The nickname of the modifier.	Alice
userId	string	The Alibaba Cloud account ID.	1234567890
dashboardUrl	string	The URL of the Ray cluster dashboard.	https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx
modified	boolean	Specifies whether the configuration has been modified.	false
message	string	The error message.	ok
instanceId	string	The instance ID of the Ray cluster.	ray-uiulpgow9xljimm1-xxxxxxx
startTime	integer	The start time. The value is a UNIX timestamp in milliseconds.	1723722279800
grpcEndpoint	string	The internal gRPC endpoint. You can also use the domain name 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.