Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bytes into "Query parameters" for CAT Segment Replication API #4731

Merged
merged 4 commits into from
Aug 10, 2023
Merged

Add bytes into "Query parameters" for CAT Segment Replication API #4731

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
815116c
Add `byte` into "Query parameters" for CAT Segment Replication API
Aug 9, 2023
a8486c0
Add a trailing slash to the links
Aug 9, 2023
e562be3
Correct the parameter name to bytes
Aug 10, 2023
89f57af
Change data type of 'bytes' and 'time' parameters to 'Byte unites' an…
Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions _api-reference/cat/cat-segment-replication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,18 @@ Parameter | Type | Description

The CAT segment replication API operation supports the following optional query parameters.

Parameter | Data type | Description
:--- |:---| :---
`active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`.
[`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`.
`shards` | String | A comma-separated list of shards to display.
`format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`.
`h` | String | A comma-separated list of column names to display.
`help` | Boolean | If `true`, the response includes help information. Defaults to `false`.
`time` | Time value | [Units]({{site.url}}{{site.baseurl}}/opensearch/units) used to display time values. Defaults to `ms` (milliseconds).
`v` | Boolean | If `true`, the response includes column headings. Defaults to `false`.
`s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order.
Parameter | Data type | Description
:--- |:-----------| :---
`active_only` | Boolean | If `true`, the response only includes active segment replications. Defaults to `false`.
[`detailed`](#additional-detailed-response-metrics) | String | If `true`, the response includes additional metrics for each stage of a segment replication event. Defaults to `false`.
`shards` | String | A comma-separated list of shards to display.
`bytes` | Byte units | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display byte size values.
`format` | String | A short version of the HTTP accept header. Valid values include `JSON` and `YAML`.
`h` | String | A comma-separated list of column names to display.
`help` | Boolean | If `true`, the response includes help information. Defaults to `false`.
`time` | Time units | [Units]({{site.url}}{{site.baseurl}}/opensearch/units/) used to display time values.
`v` | Boolean | If `true`, the response includes column headings. Defaults to `false`.
`s` | String | Specifies to sort the results. For example, `s=shardId:desc` sorts by shardId in descending order.

## Examples

Expand Down