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
opensearch-docs-cn/_api-reference/index.md

46 lines
2.2 KiB
Markdown
Raw Normal View History

Breaks site
2021-05-28 13:48:19 -04:00
---
layout: default
title: REST API reference
Make API reference top level (#1637) * Make API reference top level Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix typo on Drag and Drop page (#1633) * Fix typo on Drag and Drop page * Update _dashboards/drag-drop-wizard.md Co-authored-by: Nate Bower <nbower@amazon.com> * Update drag-drop-wizard.md Co-authored-by: Nate Bower <nbower@amazon.com> * Putting all the Docker install material on a single page (#1452) * Putting all the Docker install material on a single page Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Making room for revamp Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Intro added Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Continuing to flesh out the intro section and overview Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Overview finalized Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Introducing docker compose Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Added link to compose Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Continuing docker image commentary Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Sometimes I wonder if anyone reads these Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Adding notes on installing compose with pip Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Adding prereqs Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Magnets - how do they work? Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Almonds and peaches are part of the same plant subgenus, Amygdalus Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * There are 293 ways to make change for a dollar Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * A shark is the only known fish that can blink with both eyes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * A crocodile cannot stick its tongue out Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * wording Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Reorganizing a couple paragraphs to make it flow better Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Forgot a word Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Add tip about pruning stopped containers Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Cleaning up Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Add blurb about container ls Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Adding the Docker Compose stuff Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Working on compose Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Continuing work on the compose section - it's a lot of info Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Added important settings Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Updates to settings that need configured Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Still working through compose things Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Fixed wording Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Working through compose commands and guidance Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Reordering/rewording Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * More phrasing Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * More wording in steps Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * More wording in steps Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Organizing Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Adding stuff and things Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Continuing to work through the configuration steps Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Fixes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Fixes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Still working on the configuration steps Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Changes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * More work Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Removed perf analyzer - refer to GH issue 1555 Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Fixing things Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Adding guidance on passing settings in compose Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Working through dockerfile materials now Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * wording Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Finalized the sample dev compose file Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Continuing work with configuration Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Finished - ready for reviews Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Fixed a link I forgot to change before Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Changes from first proofread Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Changed heading Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Addressed reviewer comments and made some changes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Forgot to incorporate one change. Fixed. Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Final editorial changes Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * fix#1584-custom_attr_allowlist (#1636) Signed-off-by: cwillum <cwmmoore@amazon.com> Signed-off-by: cwillum <cwmmoore@amazon.com> * Update TERMS.md with definition for Setting (#1632) * fix#1631-Terms-setting Signed-off-by: cwillum <cwmmoore@amazon.com> * fix#1631-Terms-setting Signed-off-by: cwillum <cwmmoore@amazon.com> Signed-off-by: cwillum <cwmmoore@amazon.com> * Add disclaimer about remote fs usage and an example of setting env var (#1644) * Add disclaimer about remote fs usage and an example of setting env var Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * Enhanced wording a little bit Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> * [DOC] New documentation: Self-host maps server (#1625) * Add new page self-host maps server Signed-off-by: vagimeli <vagimeli@amazon.com> * Added new content Signed-off-by: vagimeli <vagimeli@amazon.com> * Copy edit Signed-off-by: vagimeli <vagimeli@amazon.com> * Tech review edits Signed-off-by: vagimeli <vagimeli@amazon.com> * Doc review edits Signed-off-by: vagimeli <vagimeli@amazon.com> * Editorial review changes Signed-off-by: vagimeli <vagimeli@amazon.com> * Final edits Signed-off-by: vagimeli <vagimeli@amazon.com> Signed-off-by: vagimeli <vagimeli@amazon.com> * Add feedback. Signed-off-by: Naarcha-AWS <naarcha@amazon.com> * Fix links Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: Naarcha-AWS <naarcha@amazon.com> Signed-off-by: JeffH-AWS <jeffhuss@amazon.com> Signed-off-by: cwillum <cwmmoore@amazon.com> Signed-off-by: vagimeli <vagimeli@amazon.com> Co-authored-by: Nate Bower <nbower@amazon.com> Co-authored-by: Jeff Huss <jeffhuss@amazon.com> Co-authored-by: Chris Moore <107723039+cwillum@users.noreply.github.com> Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
2022-10-27 12:50:39 -04:00
nav_order: 1
Adds list to REST API reference page (#4128) * adds list to rest api reference page Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaked wording Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaks Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-19 14:33:20 -04:00
has_toc: false
has_children: true
Adds collections landing page configuration and navigation header linking (#3812) * Adds collections landing page configuration and navigation header linking Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes unnecessary collection property from the configuration. Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds links to navigation collection headers to collection index pages based on the collection name Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Hide index pages from view and add info to formatting guide Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
2023-05-11 13:56:08 -04:00
nav_exclude: true
Perhaps I can redirect myself out of this long nightmare
2021-06-10 18:09:17 -04:00
redirect_from:
More redirect fixes - index and ingestion APIs (#3975) * more redirect fixes to index and ingest apis Signed-off-by: Heather Halter <hdhalter@amazon.com> * one more Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-05-04 13:44:02 -04:00
- /opensearch/rest-api/index/
Breaks site
2021-05-28 13:48:19 -04:00
---
# REST API reference
Adds list to REST API reference page (#4128) * adds list to rest api reference page Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaked wording Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaks Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-19 14:33:20 -04:00
You can use REST APIs for most operations in OpenSearch. In this reference, we provide a description of the API, and details that include the paths and HTTP methods, supported parameters, and example requests and responses.
Update index.md
2021-06-10 15:48:49 -04:00
Adds list to REST API reference page (#4128) * adds list to rest api reference page Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaked wording Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaks Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-19 14:33:20 -04:00
Most REST APIs supported by OpenSearch are included in this reference. If you know of any that are missing, feel free to enter feedback or submit a pull request.
Update index.md
2021-06-10 15:48:49 -04:00
{: .tip }
Adds list to REST API reference page (#4128) * adds list to rest api reference page Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaked wording Signed-off-by: Heather Halter <hdhalter@amazon.com> * tweaks Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com>
2023-05-19 14:33:20 -04:00
## Related articles
- [Alias]({{site.url}}{{site.baseurl}}/api-reference/alias/)
- [Analyze API]({{site.url}}{{site.baseurl}}/api-reference/analyze-apis/index/)
- [CAT APIs]({{site.url}}{{site.baseurl}}/api-reference/cat/index/)
- [Cluster APIs]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/index/)
- [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters)
- [Count]({{site.url}}{{site.baseurl}}/api-reference/count/)
- [Document]({{site.url}}{{site.baseurl}}/api-reference/document-apis/index/)
- [Explain]({{site.url}}{{site.baseurl}}/api-reference/explain/)
- [Index APIs]({{site.url}}{{site.baseurl}}/api-reference/index-apis/index/)
- [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/)
- [Multi-search]({{site.url}}{{site.baseurl}}/api-reference/multi-search/)
- [Nodes APIs]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/index/)
- [Popular APIs]({{site.url}}{{site.baseurl}}/api-reference/popular-api/)
- [Ranking evaluation]({{site.url}}{{site.baseurl}}/api-reference/rank-eval/)
- [Reload search analyzer]({{site.url}}{{site.baseurl}}/api-reference/reload-search-analyzer/)
- [Remove cluster information]({{site.url}}{{site.baseurl}}/api-reference/remote-info/)
- [Script APIs]({{site.url}}{{site.baseurl}}/api-reference/script-apis/index/)
- [Scroll]({{site.url}}{{site.baseurl}}/api-reference/scroll/)
- [Search]({{site.url}}{{site.baseurl}}/api-reference/search/)
- [Snapshot APIs]({{site.url}}{{site.baseurl}}/api-reference/snapshots/index/)
- [Supported units]({{site.url}}{{site.baseurl}}/api-reference/units/)
- [Tasks]({{site.url}}{{site.baseurl}}/api-reference/tasks/)