You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rs/references/rest-api/requests/shards/_index.md
+71-3Lines changed: 71 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ Get information about all shards in the cluster.
40
40
41
41
| Field | Type | Description |
42
42
|-------|------|-------------|
43
-
| extra_info_keys | list of strings |A list of extra keys to be fetched (optional)|
43
+
| extra_info_keys | list of strings |An optional list of extra keys to be fetched from the Redis [`INFO`]({{< relref "/commands/info" >}}) command. See [extra_info_keys](#extra_info_keys) for common keys to include.|
44
44
45
45
### Response {#get-all-response}
46
46
@@ -68,7 +68,7 @@ Returns a JSON array of [shard objects]({{<relref "/operate/rs/references/rest-a
68
68
"status": "active"
69
69
},
70
70
{
71
-
"uid": 2,
71
+
"uid": "2",
72
72
"role": "slave",
73
73
// additional fields...
74
74
}
@@ -110,7 +110,7 @@ Gets information about a single shard.
110
110
111
111
| Field | Type | Description |
112
112
|-------|------|-------------|
113
-
| extra_info_keys | list of strings |A list of extra keys to be fetched (optional)|
113
+
| extra_info_keys | list of strings |An optional list of extra keys to be fetched from the Redis [`INFO`]({{< relref "/commands/info" >}}) command. See [extra_info_keys](#extra_info_keys) for common keys to include.|
114
114
115
115
### Response {#get-response}
116
116
@@ -144,3 +144,71 @@ Returns a [shard object]({{<relref "/operate/rs/references/rest-api/objects/shar
144
144
|------|-------------|
145
145
|[200 OK](https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok)| No error. |
146
146
|[404 Not Found](https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found)| Shard UID does not exist. |
147
+
148
+
## extra_info_keys
149
+
150
+
You can include any Redis [`INFO`]({{< relref "/commands/info" >}}) command key for shard requests using the `extra_info_keys` query parameter. The requested keys are returned in the `redis_info` object of the response.
151
+
152
+
See the following tables for common keys to include.
153
+
154
+
### Client keys
155
+
156
+
| Key | Type | Description |
157
+
|-----|------|-------------|
158
+
| blocked_clients | integer | Number of clients pending on a blocking call |
159
+
| client_recent_max_input_buffer | integer | Biggest input buffer among current client connections |
160
+
| client_recent_max_output_buffer | integer | Biggest output buffer among current client connections |
161
+
| connected_clients | integer | Number of client connections, excluding connections from replicas |
162
+
163
+
### Memory keys
164
+
165
+
| Key | Type | Description |
166
+
|-----|------|-------------|
167
+
| maxmemory | integer | Value of the maxmemory configuration directive |
168
+
| used_memory | integer | Total number of bytes allocated by Redis |
169
+
| used_memory_dataset | integer | Size in bytes of the dataset |
170
+
| used_memory_lua | integer | Number of bytes used by the Lua engine |
171
+
| used_memory_overhead | integer | Sum of all overheads that the server allocated for managing its internal data structures |
172
+
| used_memory_peak | integer | Peak memory in bytes consumed by Redis |
173
+
| used_memory_rss | integer | Number of bytes that Redis allocated as seen by the operating system |
174
+
175
+
### Persistence keys
176
+
177
+
| Key | Type | Description |
178
+
|-----|------|-------------|
179
+
| aof_enabled | integer | Flag indicating append-only file (AOF) logging is activated |
180
+
| aof_rewrite_in_progress | integer | Flag indicating an AOF rewrite operation is on-going |
181
+
| rdb_bgsave_in_progress | integer | Flag indicating an RDB save is on-going |
182
+
| rdb_changes_since_last_save | integer | Number of changes since the last dump |
183
+
| rdb_last_bgsave_status | string | Status of the last RDB save operation |
184
+
| rdb_last_save_time | integer | Epoch-based timestamp of last successful RDB save |
185
+
186
+
### Replication keys
187
+
188
+
| Key | Type | Description |
189
+
|-----|------|-------------|
190
+
| master_last_io_seconds_ago | integer | Number of seconds since the last interaction with the primary shard |
191
+
| master_repl_offset | integer | The server's current replication offset |
192
+
| slave_repl_offset | integer | Replication offset of the replica instance |
193
+
194
+
### Server keys
195
+
196
+
| Key | Type | Description |
197
+
|-----|------|-------------|
198
+
| configured_hz | integer | Server's configured frequency setting |
199
+
| hz | integer | Server's current frequency setting |
200
+
| redis_version | string | Version of the Redis server |
201
+
| uptime_in_days | integer | Number of days since Redis server start |
202
+
| uptime_in_seconds | integer | Number of seconds since Redis server start |
203
+
204
+
### Statistics keys
205
+
206
+
| Key | Type | Description |
207
+
|-----|------|-------------|
208
+
| instantaneous_ops_per_sec | integer | Number of commands processed per second |
209
+
| keyspace_hits | integer | Number of successful lookup of keys in the main dictionary |
210
+
| keyspace_misses | integer | Number of failed lookup of keys in the main dictionary |
211
+
| total_commands_processed | integer | Total number of commands processed by the server |
212
+
| total_connections_received | integer | Total number of connections accepted by the server |
213
+
| total_net_input_bytes | integer | Total number of bytes read from the network |
214
+
| total_net_output_bytes | integer | Total number of bytes written to the network |
0 commit comments