接口描述
查看集群详情信息。
API调用地址
POST /api/bes/cluster/detail
请求参数
| 参数名 |
类型 |
是否必须 |
描述 |
示例值 |
| x-Region |
String |
是 |
区域 |
bd |
Body 参数
| 参数名称 |
必填 |
类型 |
描述 |
示例值 |
| clusterId |
是 |
String |
集群id，超过规定18位会返回500错误 |
572979545519558656 |
示例
{
"clusterId" : "572979545519558656"
}
响应参数
| 参数 |
必填 |
类型 |
描述 |
示例值 |
| success |
否 |
boolean |
请求是否成功 |
true |
| status |
是 |
integer |
状态码 |
200 |
| result |
是 |
Result |
集群详细信息 |
|
Result字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| expireTime |
String |
到期时间 |
2023-07-26T07: 53: 23Z |
| clusterId |
String |
集群ID |
572979545519558656 |
| totalCount |
Integer |
集群个数 |
1 |
| result |
List<DetailResult> |
集群信息列表 |
|
DetailResult字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| clusterId |
String |
集群ID |
572979545519558656 |
| clusterName |
String |
集群名称 |
postpaynew1 |
| adminUsername |
String |
管理员名称 |
superuser |
| actualStatus |
String |
实际状态 |
Running |
| desireStatus |
String |
设备状态 |
Running |
| esUrl |
String |
ES服务器访问路径 |
http: //172.16.16.6:8200 |
| kibanaUrl |
String |
Kibana服务器访问路径 |
https: //172.16.16.7:8080 |
| exporterUrl |
String |
Exporter监控接入地址 |
http: //172.16.16.7:8081 |
| esEip |
String |
ES公网访问IP |
|
| kibanaEip |
String |
Kibana公网访问IP |
|
| modules |
List |
节点信息列表 |
|
| instances |
List |
实例信息列表 |
|
| vpc |
String |
虚拟网络 |
默认私有网络(172.16.0.0/16) |
| vpcId |
String |
虚拟网络ID |
1b9c28ef-0874-414f-8a0c-aa85796ffffb |
| subnet |
String |
子网 |
系统预定义子网B(172.16.16.0/20) |
| availableZone |
String |
可用区 |
zoneB |
| securityGroup |
String |
安全组 |
默认安全组 |
| billing |
Billing |
计费信息 |
|
| network |
List<Network> |
网络信息 |
|
Modules字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| type |
String |
type表示节点的类型；es_node表示es节点、kibana表示kibana节点 |
kibana |
| version |
String |
集群版本 |
7.4.2 |
| slotType |
String |
资源配置类型 |
bes.c3.c1m2 |
| slotDescription |
String |
资源配置类型描述 |
CPU 1核, 内存 2G, SSD 0G |
| actualInstanceNum |
Integer |
实例数量 |
1 |
| actualInstanceNum |
Integer |
实例数量 |
1 |
Instances字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| instanceId |
String |
节点实例id |
572979729246851074 |
| status |
String |
状态 |
Running |
| moduleType |
String |
节点类型 |
kibana |
| moduleVersion |
String |
版本 |
7.4.2 |
| hostIp |
String |
ip地址 |
172.16.16.5 |
Billing字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| paymentType |
String |
计费类型 |
postpay |
Network字段数据结构说明
| 参数 |
参数类型 |
描述 |
示例值 |
| subnetId |
String |
子网ID |
e6c8bc3a-0b17-43ac-a748-98a37e44b39d |
| subnet |
String |
子网 |
系统预定义子网B(172.16.16.0/20) |
| availableZone |
String |
可用区 |
zoneB |
示例
{
"success": true,
"status": 200,
"result": {
"desireStatus": "Running",
"subnet": "系统预定义子网B(172.16.16.0/20)",
"esUrl": "http: //172.16.16.6: 8200",
"kibanaUrl": "https: //172.16.16.7: 8080",
"kibanaEip": "kibanaEip",
"instances": [{
"instanceId": "572979729246851074",
"moduleType": "kibana",
"hostIp": "172.16.16.5",
"moduleVersion": "7.4.2",
"status": "Running"
}, {
"instanceId": "572979729246851074",
"moduleType": "kibana",
"hostIp": "172.16.16.5",
"moduleVersion": "7.4.2",
"status": "Running"
}],
"vpc": "默认私有网络(172.16.0.0/16)",
"clusterId": "572979545519558656",
"securityGroup": "默认安全组",
"modules": [{
"slotDescription": "CPU 1核, 内存 2G, SSD 0G",
"slotType": "bes.c3.c1m2",
"actualInstanceNum": 1,
"type": "kibana",
"version": "7.4.2"
}, {
"slotDescription": "CPU 1核, 内存 2G, SSD 0G",
"slotType": "bes.c3.c1m2",
"actualInstanceNum": 1,
"type": "kibana",
"version": "7.4.2"
}],
"billing": {
"paymentType": "postpay"
},
"network": [{
"subnetId": "e6c8bc3a-0b17-43ac-a748-98a37e44b39d",
"subnet": "系统预定义子网B(172.16.16.0/20)",
"availableZone": "zoneB"
}, {
"subnetId": "e6c8bc3a-0b17-43ac-a748-98a37e44b39d",
"subnet": "系统预定义子网B(172.16.16.0/20)",
"availableZone": "zoneB"
}],
"adminUsername": "superuser",
"availableZone": "zoneB",
"expireTime": "",
"actualStatus": "Running",
"clusterName": "postpaynew1",
"vpcId": "1b9c28ef-0874-414f-8a0c-aa85796ffffb",
"exporterUrl": "http: //172.16.16.7:8081",
"esEip": "esEip",
"region": "bd"
}
}
