跳转到主要内容
GET
/
clusters
/
{clusterId}
Get a cluster's live status
curl --request GET \
  --url https://api.ridergy.com/v1/clusters/{clusterId} \
  --header 'x-api-key: <api-key>'
{
  "clusterId": "clst_20260612_a1b2c3d4",
  "tenantUuid": "<string>",
  "name": "North Campus",
  "locationIds": [
    "3632155",
    "3632156"
  ],
  "limitKw": 200,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "liveStatus": {
    "actualTotalKw": 130.8,
    "clusterLimitKw": 200,
    "sumLocationLimits": 200,
    "withinLimit": true,
    "locations": [
      {
        "locationId": "3632155",
        "setLimitKw": 100,
        "effectiveLimitKw": 80,
        "actualKw": 65.4
      }
    ]
  }
}

授权

x-api-key
string
header
必填

按租户分配的 API 密钥。租户信息从密钥中获取——绝不来自请求本身。

路径参数

clusterId
string
必填

响应

集群详情及实时状态

clusterId
string
示例:

"clst_20260612_a1b2c3d4"

tenantUuid
string
name
string
示例:

"North Campus"

locationIds
string[]
示例:
["3632155", "3632156"]
limitKw
number | null
示例:

200

status
enum<string>
可用选项:
ACTIVE,
INACTIVE
createdAt
string<date-time>
updatedAt
string<date-time>
liveStatus
object