跳转到主要内容
POST
/
clusters
Create a cluster
curl --request POST \
  --url https://api.ridergy.com/v1/clusters \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "North Campus",
  "locationIds": [
    "3632155",
    "3632156"
  ],
  "limitKw": 200
}
'
{ "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" }

授权

​
x-api-key
string
header
必填

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

请求体

application/json
​
name
string
必填
示例:

"North Campus"

​
locationIds
string[]
必填
Minimum array length: 1
示例:
["3632155", "3632156"]
​
limitKw
number<float> | null

可选的集群级 kW 上限。

示例:

200

响应

集群已创建

​
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>