查看集群详情信息
接口说明
查看集群详情信息,集群/节点状态优化
请求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 | 资源分组名称 | 默认分组 |
请求示例
POST /api/bes/cluster/v2/detail
<公共请求头>
x-Region: bd
{
"clusterId" : "12345"
}
响应示例
HTTP/1.1 200 OK
<公共响应头>
{
"result" : {
"subnet" : "系统预定义子网B(172.16.16.0/20)",
"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"
} ],
"log" : {
"gcLog" : true,
"mainLog" : true,
"indexSlowLog" : true,
"auditLog" : true,
"searchSlowLog" : true
},
"clusterId" : "572979545519558656",
"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"
} ],
"actualStatus" : "active",
"clusterName" : "postpaynew1",
"vpcId" : "1b9c28ef-0874-414f-8a0c-aa85796ffffb",
"inspectAuthorized" : "true",
"enableKibanaSSL" : false,
"enableEsSSL" : false,
"desireStatus" : "active",
"resGroupList" : [ {
"groupName" : "默认分组",
"groupId" : "RESG-44pvmsruNiy"
}, {
"groupName" : "默认分组",
"groupId" : "RESG-44pvmsruNiy"
} ],
"bdVersion" : "1.7.6",
"esUrl" : "http: //172.16.16.6: 8200",
"kibanaUrl" : "https: //172.16.16.7: 8080",
"vpc" : "默认私有网络(172.16.0.0/16)",
"securityGroup" : "默认安全组",
"clusterHealth" : {
"totalDiskSize" : "1TB",
"usedDiskSize" : "1GB",
"nodeDiskMaxSizeInGB" : {
"es_node" : "25",
"es_cold_tier_node" : "0"
},
"indexDiskSize" : "1MB",
"status" : "GREEN(健康)、YELLOW(亚健康)、RED(不健康)"
},
"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"
} ],
"tags" : [ {
"tagValue" : "111",
"tagKey" : "test"
}, {
"tagValue" : "111",
"tagKey" : "test"
} ],
"adminUsername" : "superuser",
"availableZone" : "zoneB",
"expireTime" : "",
"exporterUrl" : "http://172.16.16.7:8081",
"esEip" : "esEip",
"region" : "bd"
},
"success" : true,
"status" : 200
}
错误码
请参考通用错误码