1)接口功能介绍
查看区域集群编码列表。
2)接口约束
无。
3)URI
GET /v1/describeRegionClusters。
4)请求参数
Query参数
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | ||
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionClusterList | 是 | List | 获取可用的边缘池id | regionClusterList |
表 regionClusterList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 区域名 | 云南 | |
clusterList | 是 | List | 集群信息表 | clusterList |
表 clusterList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cnName | 是 | String | 集群中文名 | 丽江1 | |
nodeCode | 是 | String | 集群编码 | yn-lijiang-1 |
6)请求示例
GET https://{host}/v1/describeRegionClusters
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"regionClusterList": [
{
"clusterList": [
{
"nodeCode": "yn-lincang-1",
"cnName": "临沧1"
},
{
"nodeCode": "yn-lijiang-1",
"cnName": "丽江1"
},
{
"nodeCode": "yn-baoshan-1",
"cnName": "保山1"
}
],
"name": "云南"
},
{
"clusterList": [
{
"nodeCode": "nm-huhehaote-1",
"cnName": "呼和浩特1"
},
{
"nodeCode": "nm-huhehaote-2",
"cnName": "呼和浩特2"
},
{
"nodeCode": "nm-huhehaote-3",
"cnName": "呼和浩特3"
}
],
"name": "内蒙古"
},
{
"clusterList": [
{
"nodeCode": "jx-pingxiang-1",
"cnName": "萍乡1"
},
{
"nodeCode": "jx-jian-1",
"cnName": "吉安1"
}
],
"name": "江西"
},
{
"clusterList": [
{
"nodeCode": "hn-huaihua-1",
"cnName": "怀化1"
},
{
"nodeCode": "hn-changde-1",
"cnName": "常德1"
}
],
"name": "湖南"
}
]
},
"requestId": "e770bf7e-36a5-496f-8561-396649767a34"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |