Get a cluster's live status
curl --request GET \
--url https://api.ridergy.com/v1/clusters/{clusterId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.ridergy.com/v1/clusters/{clusterId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.ridergy.com/v1/clusters/{clusterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ridergy.com/v1/clusters/{clusterId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ridergy.com/v1/clusters/{clusterId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ridergy.com/v1/clusters/{clusterId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ridergy.com/v1/clusters/{clusterId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or inactive API key",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}{
"error": {
"code": "FEATURE_NOT_ENABLED",
"message": "The Energy Management API is not enabled for your account. Contact RiDERgy to enable this feature.",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}{
"error": {
"code": "CLUSTER_NOT_FOUND",
"message": "Cluster clst_20260612_a1b2c3d4 not found",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}集群
获取集群的实时状态
返回集群信息以及一个 liveStatus 数据块:实际总 kW
用电量、成员位置限制之和,以及经过比例缩放
(scale = min(1, clusterLimitKw / sumLocationLimits))后每个位置的
{setLimitKw, effectiveLimitKw, actualKw}。
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>'import requests
url = "https://api.ridergy.com/v1/clusters/{clusterId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.ridergy.com/v1/clusters/{clusterId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ridergy.com/v1/clusters/{clusterId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ridergy.com/v1/clusters/{clusterId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ridergy.com/v1/clusters/{clusterId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ridergy.com/v1/clusters/{clusterId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or inactive API key",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}{
"error": {
"code": "FEATURE_NOT_ENABLED",
"message": "The Energy Management API is not enabled for your account. Contact RiDERgy to enable this feature.",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}{
"error": {
"code": "CLUSTER_NOT_FOUND",
"message": "Cluster clst_20260612_a1b2c3d4 not found",
"requestId": "b1f6e6b0-1234-4abc-9def-000000000000"
}
}授权
按租户分配的 API 密钥。租户信息从密钥中获取——绝不来自请求本身。
路径参数
响应
集群详情及实时状态
⌘I

