查看集群详情信息
更新时间:2025-04-01
接口说明
查看集群详情信息,集群/节点状态优化
请求URI
POST /api/bes/cluster/v2/detail
请求头参数
参数名 | 参数类型 | 是否必须 | 描述 | 示例值 |
---|---|---|---|---|
x-Region | String | 是 | 区域 | bd |
请求体参数
请求体字段数据结构说明
参数名称 | 必填 | 参数类型 | 描述 | 示例值 |
---|---|---|---|---|
clusterId | 是 | String | 集群id,超过规定18位会返回500错误 | 12345 |
响应体参数
响应体字段数据结构说明
参数名称 | 参数类型 | 描述 | 参数类型 |
---|---|---|---|
success | Boolean | 操作是否成功 | true |
status | Integer | 状态码 | 200 |
result | Result | 集群详细信息 |
Result字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
expireTime | ModelNull | 终止时间 | |
clusterId | String | 集群ID | 572979545519558656 |
clusterName | String | 集群名称 | postpaynew1 |
adminUsername | String | 管理员名称 | superuser |
actualStatus | String | 实际状态,active:正常,activating:生效中,invalid:失效 | active |
desireStatus | String | 目标状态 | active |
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 |
enableEsSSL | Boolean | es是否开启https | false |
enableKibanaSSL | Boolean | kibana是否开启https | false |
esEip | String | String | |
kibanaEip | String | Kibana公网访问IP | |
modules | List |
节点信息列表 | |
instances | List |
2 | |
region | String | 区域 | bd |
inspectAuthorized | String | 是否已开通巡检授权 | true |
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 | 安全组 | 默认安全组 |
clusterHealth | ClusterHealth | ||
billing | Billing | 计费信息 | |
network | List |
网络信息 | |
tags | List |
标签信息 | |
log | Log | 当前日志设置 | |
resGroupList | List |
资源分组 | |
bdVersion | String | 内核版本 | 1.7.6 |
ModulesItem字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
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 |
InstancesItem字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
instanceId | String | 节点实例id | 572979729246851074 |
status | String | 状态 | Running |
moduleType | String | 节点类型 | kibana |
moduleVersion | String | 版本 | 7.4.2 |
hostIp | String | ip地址 | 172.16.16.5 |
ClusterHealth字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
status | String | 健康状态 | GREEN(健康)、YELLOW(亚健康)、RED(不健康) |
totalDiskSize | String | 磁盘总大小 | 1TB |
usedDiskSize | String | 磁盘已使用大小 | 1GB |
nodeDiskMaxSizeInGB | NodeDiskMaxSizeInGB | 节点所占磁盘 | |
indexDiskSize | String | 索引大小 | 1MB |
NodeDiskMaxSizeInGB字段数据结构说明
参数名称 | 参数类型 | 描述 | 参数类型 |
---|---|---|---|
es_node | String | 数据节点 | 25 |
es_cold_tier_node | String | 冷数据节点 | 0 |
Billing字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
paymentType | String | 计费类型 | postpay |
NetworkItem字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
subnetId | String | 子网ID | e6c8bc3a-0b17-43ac-a748-98a37e44b39d |
subnet | String | 子网 | 系统预定义子网B(172.16.16.0/20) |
availableZone | String | 可用区 | zoneB |
TagsItem字段数据结构说明
参数名称 | 参数类型 | 描述 | |
---|---|---|---|
tagKey | String | 标签key | test |
tagValue | String | 标签value | 111 |
Log字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
mainLog | Boolean | 主日志是否开启 | true |
gcLog | Boolean | gc日志是否开启 | true |
indexSlowLog | Boolean | 索引慢日志是否开启 | true |
searchSlowLog | Boolean | 查询慢日志是否开启 | true |
auditLog | Boolean | 访问日志是否开启 | true |
ResGroupListItem字段数据结构说明
参数名称 | 参数类型 | 描述 | 示例值 |
---|---|---|---|
groupId | String | 资源分组id | RESG-44pvmsruNiy |
groupName | String | 资源分组名称 | 默认分组 |
请求示例
Plain Text
1POST /api/bes/cluster/v2/detail
2<公共请求头>
3x-Region: bd
4
5
6{
7 "clusterId" : "12345"
8}
响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "result" : {
6 "subnet" : "系统预定义子网B(172.16.16.0/20)",
7 "kibanaEip" : "kibanaEip",
8 "instances" : [ {
9 "instanceId" : "572979729246851074",
10 "moduleType" : "kibana",
11 "hostIp" : "172.16.16.5",
12 "moduleVersion" : "7.4.2",
13 "status" : "Running"
14 }, {
15 "instanceId" : "572979729246851074",
16 "moduleType" : "kibana",
17 "hostIp" : "172.16.16.5",
18 "moduleVersion" : "7.4.2",
19 "status" : "Running"
20 } ],
21 "log" : {
22 "gcLog" : true,
23 "mainLog" : true,
24 "indexSlowLog" : true,
25 "auditLog" : true,
26 "searchSlowLog" : true
27 },
28 "clusterId" : "572979545519558656",
29 "billing" : {
30 "paymentType" : "postpay"
31 },
32 "network" : [ {
33 "subnetId" : "e6c8bc3a-0b17-43ac-a748-98a37e44b39d",
34 "subnet" : "系统预定义子网B(172.16.16.0/20)",
35 "availableZone" : "zoneB"
36 }, {
37 "subnetId" : "e6c8bc3a-0b17-43ac-a748-98a37e44b39d",
38 "subnet" : "系统预定义子网B(172.16.16.0/20)",
39 "availableZone" : "zoneB"
40 } ],
41 "actualStatus" : "active",
42 "clusterName" : "postpaynew1",
43 "vpcId" : "1b9c28ef-0874-414f-8a0c-aa85796ffffb",
44 "inspectAuthorized" : "true",
45 "enableKibanaSSL" : false,
46 "enableEsSSL" : false,
47 "desireStatus" : "active",
48 "resGroupList" : [ {
49 "groupName" : "默认分组",
50 "groupId" : "RESG-44pvmsruNiy"
51 }, {
52 "groupName" : "默认分组",
53 "groupId" : "RESG-44pvmsruNiy"
54 } ],
55 "bdVersion" : "1.7.6",
56 "esUrl" : "http: //172.16.16.6: 8200",
57 "kibanaUrl" : "https: //172.16.16.7: 8080",
58 "vpc" : "默认私有网络(172.16.0.0/16)",
59 "securityGroup" : "默认安全组",
60 "clusterHealth" : {
61 "totalDiskSize" : "1TB",
62 "usedDiskSize" : "1GB",
63 "nodeDiskMaxSizeInGB" : {
64 "es_node" : "25",
65 "es_cold_tier_node" : "0"
66 },
67 "indexDiskSize" : "1MB",
68 "status" : "GREEN(健康)、YELLOW(亚健康)、RED(不健康)"
69 },
70 "modules" : [ {
71 "slotDescription" : "CPU 1核, 内存 2G, SSD 0G",
72 "slotType" : "bes.c3.c1m2",
73 "actualInstanceNum" : 1,
74 "type" : "kibana",
75 "version" : "7.4.2"
76 }, {
77 "slotDescription" : "CPU 1核, 内存 2G, SSD 0G",
78 "slotType" : "bes.c3.c1m2",
79 "actualInstanceNum" : 1,
80 "type" : "kibana",
81 "version" : "7.4.2"
82 } ],
83 "tags" : [ {
84 "tagValue" : "111",
85 "tagKey" : "test"
86 }, {
87 "tagValue" : "111",
88 "tagKey" : "test"
89 } ],
90 "adminUsername" : "superuser",
91 "availableZone" : "zoneB",
92 "expireTime" : "",
93 "exporterUrl" : "http://172.16.16.7:8081",
94 "esEip" : "esEip",
95 "region" : "bd"
96 },
97 "success" : true,
98 "status" : 200
99}
错误码
请参考通用错误码