iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

* Add `byte` into "Query parameters" for CAT Segment Replication API

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Add a trailing slash to the links

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Correct the parameter name to bytes

Signed-off-by: Tianli Feng <ftianli@amazon.com>

* Change data type of 'bytes' and 'time' parameters to 'Byte unites' and 'Time unites'

Signed-off-by: Tianli Feng <ftianli@amazon.com>

---------

Signed-off-by: Tianli Feng <ftianli@amazon.com>
This commit is contained in:
Tianli Feng 2023-08-10 07:20:24 -07:00 committed by GitHub
parent 1a1a385cf0
commit 4d6106a6ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
_api-reference/cat/cat-segment-replication.md
View File

@ -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