列出Ray集群。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/workspaces/{workspaceId}/rayCluster HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
否 |
工作空间 ID。 |
w-d2d82aa09155 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| pageSize |
integer |
否 |
返回结果的分页数。默认值：20，最小 1，最大 100。 |
20 |
| pageNum |
integer |
否 |
页码。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID。 |
DD6B1B2A-5837-5237-ABE4-FF0C8944 |
| rayClusters |
array<object> |
Ray 集群列表。 |
|
|
array<object> |
Ray 集群结构体。 |
||
| clusterId |
string |
集群 ID。 |
ray-uiulpgow9xljimm1 |
| name |
string |
Ray 集群名称。 |
testRayCluster |
| 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 |
| workerSpec |
array<object> |
Ray 集群 Worker 信息。 |
|
|
object |
Ray 集群 Worker 信息结构体。 |
||
| groupName |
string |
Worker 组名称。 |
Group1 |
| workerType |
string |
Worker 类型。 |
CPU |
| replica |
integer |
节点数量。 |
2 |
| queueName |
string |
队列名称。 |
root_queue |
| cpu |
string |
CPU 核数。 |
2 |
| memory |
string |
内存，单位 Gi。 |
8Gi |
| minReplica |
integer |
开启自动扩缩容后最小 Worker 数量。 |
1 |
| maxReplica |
integer |
开启自动扩缩容后最大 Worker 数量。 |
10 |
| state |
string |
集群状态。
|
Running |
| createTime |
integer |
创建时间。 |
1723722279800 |
| modifiedTime |
integer |
修改时间。 |
1723722279800 |
| creator |
string |
创建用户 UID。 |
202077646755123991 |
| creatorName |
string |
创建者昵称。 |
Alice |
| modifier |
string |
最后更新者 UID。 |
202077646755123991 |
| modifierName |
string |
修改者昵称。 |
Alice |
| userId |
string |
主账号 ID。 |
1234567890 |
| dashboardUrl |
string |
Ray 集群 Dashboard 链接。 |
https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx |
| modified |
boolean |
配置是否修改过。 |
false |
| message |
string |
错误信息。 |
ok |
| instanceId |
string |
Ray 集群实例 ID。 |
ray-uiulpgow9xljimm1-xxxxxxx |
| startTime |
integer |
启动时间。 |
1723722279800 |
| grpcEndpoint |
string |
gRPC 连接地址（内网），其中域名也可以提交 ray job。 |
ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80 |
示例
正常返回示例
JSON格式
{
"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
},
"workerSpec": [
{
"groupName": "Group1",
"workerType": "CPU",
"replica": 2,
"queueName": "root_queue",
"cpu": "2",
"memory": "8Gi",
"minReplica": 1,
"maxReplica": 10
}
],
"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"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。