列举所有可选巡检项
更新时间：2025-04-01
接口说明
可选巡检项包括：集群健康状态(ClusterHealth)、集群负载(ClusterPayload)、节点分片数(NodeShardNum)、节点负载(NodePayload)、节点计算资源(NodeCompute)、节点堆内存(NodeHeap)、节点存储资源(NodeDisk)、数据节点负载均衡(NodePayloadBalance)、节点离群(NodeOffline)、集群写入拒绝率(ClusterWriteReject)、查询队列堆积(NodeSearchQueue)、索引副本合理性(IndexReplicaNum)、索引分片合理性(IndexShardSize)、查询耗时(SearchTime)
请求URI
POST /api/bes/cluster/inspect/list_items
请求头参数
| 参数名称 | 参数类型 | 是否必须 | 描述 | 示例值 |
|---|---|---|---|---|
| x-Region | String | 是 | 区域 | bd |
响应体参数
响应体字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| success | String | 请求是否成功 | true |
| status | Integer | 状态码 | 200 |
| result | Result | 返回信息 |
Result字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| items | List |
巡检项列表 |
ItemsItem字段数据结构说明
| 参数名称 | 参数类型 | 描述 | 示例值 |
|---|---|---|---|
| id | String | 巡检项id，即英文名 | ClusterHealth |
| type | String | 巡检项类型。目前包括"cluster"、“node”、“index”、“search” | cluster |
请求示例
Plain Text
1POST /api/bes/cluster/inspect/list_items
2<公共请求头>
3x-Region: bd
4
5
6{ }响应示例
Plain Text
1HTTP/1.1 200 OK
2<公共响应头>
3
4{
5 "success": true,
6 "status": 200,
7 "result": {
8 "items": [
9 {
10 "id": "ClusterHealth",
11 "type": "cluster"
12 },
13 {
14 "id": "ClusterPayload",
15 "type": "cluster"
16 },
17 {
18 "id": "NodeShardNum",
19 "type": "node"
20 },
21 {
22 "id": "NodePayload",
23 "type": "node"
24 },
25 {
26 "id": "NodeCompute",
27 "type": "node"
28 },
29 {
30 "id": "NodeHeap",
31 "type": "node"
32 },
33 {
34 "id": "NodeDisk",
35 "type": "node"
36 },
37 {
38 "id": "NodePayloadBalance",
39 "type": "node"
40 },
41 {
42 "id": "NodeOffline",
43 "type": "node"
44 },
45 {
46 "id": "ClusterWriteReject",
47 "type": "cluster"
48 },
49 {
50 "id": "NodeSearchQueue",
51 "type": "node"
52 },
53 {
54 "id": "IndexReplicaNum",
55 "type": "index"
56 },
57 {
58 "id": "IndexShardSize",
59 "type": "index"
60 },
61 {
62 "id": "SearchTime",
63 "type": "search"
64 }
65 ]
66 }
67}错误码
请参考通用错误码