Creates a Ray cluster.
Creates a Ray cluster.
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
No authorization for this operation. If you encounter issues with this operation, contact technical support.
Request syntax
POST /api/v1/workspaces/{workspaceId}/rayCluster HTTP/1.1Path parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | No | The workspace ID. | w-d2d82aa09155 |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| body | object | No | The request body. | — |
| name | string | No | The name of the Ray cluster. The name must be 1 to 64 characters in length. | testRayCluster |
| displayReleaseVersion | string | No | The engine version of the Ray cluster. | ray-1.0.0 (Ray 2.47.1, Python 3.12) |
| description | string | No | The description of the Ray cluster. | Ray Cluster for dev. |
| networkServiceName | string | No | The name of the network connection. | vpc |
| headSpec | object | No | The configuration of the head node. | — |
| headSpec.queueName | string | No | The queue name. | root_queue |
| headSpec.cpu | string | No | The number of CPU cores for the head node. | 2 |
| headSpec.memory | string | No | The memory size of the head node, in GiB. | 8Gi |
| headSpec.enableAutoScaling | boolean | No | Specifies whether to enable automatic scaling for worker nodes. | false |
| headSpec.idleTimeoutSeconds | integer | No | The idle timeout period in seconds for worker nodes when automatic scaling is enabled. | 60 |
| headSpec.gpuSpec | string | No | — | ecs.gn6i-c4g1.xlarge |
| workerSpec | array<object> | No | The configuration of worker nodes. You can specify up to 50 worker groups. | — |
| workerSpec[].groupName | string | No | The name of the worker group. | WorkerGroup1 |
| workerSpec[].workerType | string | No | The worker type. | CPU |
| workerSpec[].replica | integer | No | The number of worker nodes. Minimum value: 1. | 2 |
| workerSpec[].queueName | string | No | The queue name. | root_queue |
| workerSpec[].cpu | string | No | The number of CPU cores for each worker node. | 4 |
| workerSpec[].memory | string | No | The memory size of each worker node, in GiB. | 16Gi |
| workerSpec[].minReplica | integer | No | The minimum number of worker nodes for automatic scaling. Minimum value: 1. This value must be less than or equal to maxReplica. | 1 |
| workerSpec[].maxReplica | integer | No | The maximum number of worker nodes for automatic scaling. Minimum value: 1. | 10 |
| workerSpec[].gpuSpec | string | No | — | ecs.gn6i-c4g1.xlarge |
| workerSpec[].extraParam | string | No | Additional parameters in JSON format. | {} |
| volumeIds | array | No | — | — |
| volumeIds[] | string | No | — | vol-1234567890 |
Response elements
| Element | Type | Description | Example |
|---|---|---|---|
| requestId | string | The request ID. | DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| clusterId | string | The ID of the Ray cluster. | ray-k7nm8ahl5te4tg91 |
Examples
Sample success response in JSON format:
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"clusterId": "ray-k7nm8ahl5te4tg91"
}Error codes
For a complete list of error codes, see Error codes.
Release notes
For a complete list of release notes, see Release notes.