获取Ray集群。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/workspaces/{workspaceId}/rayCluster/{clusterId} HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
否 |
工作空间 ID。 |
w-d2d82aa09155 |
| clusterId |
string |
否 |
集群 ID。 |
ray-xxxxxxxxxx |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| clusterId |
string |
Ray 集群 ID。 |
ray-k7nm8ahl5te4tg91 |
| name |
string |
Ray 集群名称。 |
myRayCluster |
| 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 集群 Head 节点参数。 |
|
| queueName |
string |
队列名称。 |
root_queue |
| cpu |
string |
CPU 核数。 |
2 |
| memory |
string |
内存，单位 Gi。 |
8Gi |
| enableAutoScaling |
boolean |
Worker 节点是否开启自动扩缩容。 |
false |
| idleTimeoutSeconds |
integer |
开启自动扩缩容后 Worker 节点 Idle 时间。 |
60 |
| replica |
integer |
节点数量。 |
1 |
| state |
string |
会话状态。
|
Running |
| creator |
string |
创建集群的用户 UID。 |
202077646755523991 |
| creatorName |
string |
创建者昵称。 |
Alice |
| modifier |
string |
集群更新者 UID。 |
202077646755523991 |
| modifierName |
string |
修改者昵称。 |
Alice |
| userId |
string |
创建者主账号 ID。 |
123456789012 |
| dashboardUrl |
string |
Ray 集群 Dashboard 链接。 |
https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx |
| jobUrl |
string |
提交 Ray Job 的地址（公网）。 |
https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com |
| submitToken |
string |
提交 Ray Job 时的鉴权 Token，需要放到请求头中，"ray-token": "token"。 |
1d06484d3b424f7fa4ab7082a4076da2 |
| modified |
boolean |
配置是否修改过。 |
false |
| extraParam |
string |
额外参数，json 格式。 |
{} |
| message |
string |
状态为 Error 时的错误信息。 |
ok |
| instances |
array<object> |
Ray 集群节点 ID。 |
|
|
object |
Ray 集群节点结构体。 |
||
| type |
string |
节点类型。 |
Head |
| instanceId |
string |
节点 ID。 |
ray-uiulpgow9xljim10-head-7cgta |
| containerState |
string |
主容器状态。 |
Running |
| reason |
string |
节点信息。 |
OOMKilled |
| phase |
string |
节点 Pod 状态。 |
Running |
| message |
string |
节点 Pod 状态信息。 |
ok |
| startTime |
integer |
启动时间。 |
1762946698000 |
| createTime |
integer |
创建时间。 |
1735870116167 |
| containerStateReason |
string |
主容器信息。 |
ok |
| containerStateMessage |
string |
主容器状态信息。 |
ContainerExit |
| containerExitCode |
integer |
主容器退出码。 |
137 |
| instanceId |
string |
Ray 集群节点 ID。 |
ray-k7nm8ahl5te4tg93-xxxxxxx |
| workerSpec |
array<object> |
Ray 集群 Worker 节点信息。 |
|
|
object |
Ray 集群 Worker 节点信息结构体。 |
||
| groupName |
string |
Worker 节点组名称。 |
WorkerGroup1 |
| workerType |
string |
Worker 节点组类型。 |
CPU |
| replica |
integer |
Worker 节点数量。 |
2 |
| queueName |
string |
队列名称。 |
root_queue |
| cpu |
string |
CPU 核数。 |
2 |
| memory |
string |
内存，单位 Gi。 |
8Gi |
| minReplica |
integer |
Worker 最小数量。 |
1 |
| maxReplica |
integer |
Worker 最大数量。 |
10 |
| startTime |
integer |
启动时间，Unix 时间戳，单位毫秒。 |
1750327083303 |
| createTime |
integer |
创建时间，Unix 时间戳，单位毫秒。 |
1750327083303 |
| modifiedTime |
integer |
更新时间，Unix 时间戳，单位毫秒。 |
1754274541693 |
| grpcEndpoint |
string |
gRPC 连接地址（内网），其中的域名也可以用作提交 ray job。 |
ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80 |
示例
正常返回示例
JSON格式
{
"requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
"clusterId": "ray-k7nm8ahl5te4tg91",
"name": "myRayCluster",
"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
},
"state": "Running",
"creator": "202077646755523991",
"creatorName": "Alice",
"modifier": "202077646755523991",
"modifierName": "Alice",
"userId": "123456789012",
"dashboardUrl": "https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx",
"jobUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com",
"submitToken": "1d06484d3b424f7fa4ab7082a4076da2",
"modified": false,
"extraParam": "{}",
"message": "ok",
"instances": [
{
"type": "Head",
"instanceId": "ray-uiulpgow9xljim10-head-7cgta",
"containerState": "Running",
"reason": "OOMKilled",
"phase": "Running",
"message": "ok",
"startTime": 1762946698000,
"createTime": 1735870116167,
"containerStateReason": "ok",
"containerStateMessage": "ContainerExit",
"containerExitCode": 137
}
],
"instanceId": "ray-k7nm8ahl5te4tg93-xxxxxxx",
"workerSpec": [
{
"groupName": "WorkerGroup1",
"workerType": "CPU",
"replica": 2,
"queueName": "root_queue",
"cpu": "2",
"memory": "8Gi",
"minReplica": 1,
"maxReplica": 10
}
],
"startTime": 1750327083303,
"createTime": 1750327083303,
"modifiedTime": 1754274541693,
"grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。