Updates 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 is required for this operation. If you encounter issues, contact technical support.
Request syntax
POST /api/v1/workspaces/{workspaceId}/rayCluster/{clusterId} HTTP/1.1Path parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | No | The workspace ID. | w-d2d82aa09155 |
| clusterId | string | No | The cluster ID. | ray-uiulpgow9xljimm1 |
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. | myRayCluster |
| displayReleaseVersion | string | No | The Ray engine version. | 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 service. | vpc |
| headSpec | object | No | The information about the head node of the Ray cluster. | |
| headSpec.queueName | string | No | The name of the queue. | root_queue |
| headSpec.cpu | string | No | The number of CPU cores. | 2 |
| headSpec.memory | string | No | The memory size. Unit: Gi. | 8Gi |
| headSpec.enableAutoScaling | boolean | No | Specifies whether to enable automatic scaling. | false |
| headSpec.idleTimeoutSeconds | integer | No | The idle timeout period for workers, in seconds. This parameter takes effect only when automatic scaling is enabled. | 60 |
| headSpec.gpuSpec | string | No | ecs.gn6i-c4g1.xlarge | |
| workerSpec | array\<object\> | No | The information about the worker nodes of the Ray cluster. You can specify up to 50 worker groups. | |
| workerSpec[].groupName | string | No | The name of the worker group. | WorkerGroup1 |
| workerSpec[].workerType | string | No | The type of worker. | CPU |
| workerSpec[].replica | integer | No | The number of workers. Minimum value: 1. | 2 |
| workerSpec[].queueName | string | No | The name of the queue. | root_queue |
| workerSpec[].cpu | string | No | The number of CPU cores. | 2 |
| workerSpec[].memory | string | No | The memory size. Unit: Gi. | 8Gi |
| workerSpec[].minReplica | integer | No | The minimum number of workers. Minimum value: 1. This value must be less than or equal to maxReplica. |
1 |
| workerSpec[].maxReplica | integer | No | The maximum number of workers. 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 cluster ID. | ray-xxxxxxxxxxx |
Examples
Success response
JSON format
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"clusterId": "ray-xxxxxxxxxxx"
}Error codes
See Error codes for a complete list.
Release notes
See Release notes for a complete list.