forked from opensearch-project/opensearch-api-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcluster.health.yaml
167 lines (167 loc) · 5.22 KB
/
cluster.health.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
openapi: 3.1.0
info:
title: Schemas of cluster.health category
description: Schemas of cluster.health category
version: 1.0.0
paths: {}
components:
schemas:
HealthResponseBody:
type: object
properties:
active_primary_shards:
description: The number of active primary shards.
type: number
active_shards:
description: The total number of active primary and replica shards.
type: number
active_shards_percent:
$ref: '_common.yaml#/components/schemas/PercentageString'
active_shards_percent_as_number:
$ref: '_common.yaml#/components/schemas/PercentageNumber'
awareness_attributes:
description: Cluster health information for each awareness attribute.
type: object
x-version-added: '2.5'
additionalProperties:
$ref: '#/components/schemas/AwarenessAttributeStats'
cluster_name:
$ref: '_common.yaml#/components/schemas/Name'
delayed_unassigned_shards:
description: The number of shards whose allocation has been delayed by the timeout settings.
type: number
discovered_master:
description: True if the master node has been discovered.
type: boolean
x-version-deprecated: '2.0'
discovered_cluster_manager:
description: True if the cluster manager node has been discovered.
type: boolean
x-version-added: '2.0'
indices:
type: object
additionalProperties:
$ref: '#/components/schemas/IndexHealthStats'
initializing_shards:
description: The number of shards that are under initialization.
type: number
number_of_data_nodes:
description: The number of nodes that are dedicated data nodes.
type: number
number_of_in_flight_fetch:
description: The number of unfinished fetches.
type: number
number_of_nodes:
description: The number of nodes within the cluster.
type: number
number_of_pending_tasks:
description: The number of cluster-level changes that have not yet been executed.
type: number
relocating_shards:
description: The number of shards that are under relocation.
type: number
status:
$ref: '_common.yaml#/components/schemas/HealthStatus'
task_max_waiting_in_queue:
$ref: '_common.yaml#/components/schemas/Duration'
task_max_waiting_in_queue_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
timed_out:
description: If false the response returned within the period of time that is specified by the timeout parameter (30s by default).
type: boolean
unassigned_shards:
description: The number of shards that are not allocated.
type: number
required:
- active_primary_shards
- active_shards
- active_shards_percent_as_number
- cluster_name
- delayed_unassigned_shards
- initializing_shards
- number_of_data_nodes
- number_of_in_flight_fetch
- number_of_nodes
- number_of_pending_tasks
- relocating_shards
- status
- task_max_waiting_in_queue_millis
- timed_out
- unassigned_shards
IndexHealthStats:
type: object
properties:
active_primary_shards:
type: number
active_shards:
type: number
initializing_shards:
type: number
number_of_replicas:
type: number
number_of_shards:
type: number
relocating_shards:
type: number
shards:
type: object
additionalProperties:
$ref: '#/components/schemas/ShardHealthStats'
status:
$ref: '_common.yaml#/components/schemas/HealthStatus'
unassigned_shards:
type: number
required:
- active_primary_shards
- active_shards
- initializing_shards
- number_of_replicas
- number_of_shards
- relocating_shards
- status
- unassigned_shards
Level:
type: string
enum:
- awareness_attributes
- cluster
- indices
- shards
AwarenessAttributeStats:
type: object
x-version-added: '2.5'
properties:
active_shards:
type: number
initializing_shards:
type: number
relocating_shards:
type: number
unassigned_shards:
type: number
data_nodes:
type: number
weight:
type: number
ShardHealthStats:
type: object
properties:
active_shards:
type: number
initializing_shards:
type: number
primary_active:
type: boolean
relocating_shards:
type: number
status:
$ref: '_common.yaml#/components/schemas/HealthStatus'
unassigned_shards:
type: number
required:
- active_shards
- initializing_shards
- primary_active
- relocating_shards
- status
- unassigned_shards