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

added some of the params undisclosed in the API. still missing more i… (#3380) 

* added some of the params undisclosed in the API. still missing more info for missing and searchString

Signed-off-by: Barak Atias <brookatlas@gmail.com>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Added tick marks to parameters

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>

* Update api.md

---------

Signed-off-by: Barak Atias <brookatlas@gmail.com>
Signed-off-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: root <root@MARAK-PC.localdomain>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
This commit is contained in:
Barak Atias 2023-10-23 20:48:45 +03:00 committed by GitHub
parent 84e4ab158e
commit 0119986eb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
_observing-your-data/alerting/api.md
View File

@ -1344,6 +1344,20 @@ Introduced 1.0
Returns an array of all alerts.
**Path parameters**
The following table lists the available path parameters. All path parameters are optional.
Parameter | Data type | Description
:--- | :--- | :---
`sortString` | String | Determines how to sort the results. Defaults to `monitor_name.keyword`.
`sortOrder` | String | Determines the order of the results. Options are `asc` or `desc`. Defaults to `asc`.
`missing` | String | Optional.
`size` | String | Determines the size of the request to be returned. Defaults to `20`.
`startIndex` | String | The index to start from. Used for paginating results. Defaults to `0`.
`searchString` | String | A search string used to look for a specific alert. Defaults to an empty string.
`severityLevel` | String | The severity level to filter for. Defaults to `ALL`.
`alertState` | String | The alert state to filter for. Defaults to `ALL`.
`monitorId` | String | Filters by monitor ID.
#### Request
```json