13 API Gruppen

Die OpenSearch API ist in verschiedene Gruppen von Endpunkten unterteilt, die jeweils spezifische Funktionen des Systems ansprechen. Hier sind die wichtigsten Kategorien:

Offizielle Dokumentation

1. Cluster-Management APIs
   • Überwachung und Verwaltung des Cluster-Zustands.
   • Beispiele:
     • GET /_cluster/health
     • GET /_cluster/stats
     • PUT /_cluster/settings
2. Index-Management APIs
   • Verwaltung von Indizes und deren Einstellungen.
   • Beispiele:
     • PUT /<index>
     • GET /<index>/_settings
     • DELETE /<index>
3. Dokumenten-APIs
   • Erstellung, Abruf, Aktualisierung und Löschung von Dokumenten.
   • Beispiele:
     • POST /<index>/_doc
     • GET /<index>/_doc/<id>
     • DELETE /<index>/_doc/<id>
4. Such-APIs
   • Durchführung von Abfragen und Analysen.
   • Beispiele:
     • GET /<index>/_search
     • POST /<index>/_search
     • POST /_msearch
5. Bulk-APIs
   • Verarbeitung mehrerer Operationen in einem Schritt.
   • Beispiele:
     • POST /_bulk
6. Mapping APIs
   • Definition und Verwaltung der Struktur von Dokumenten.
   • Beispiele:
     • GET /<index>/_mapping
     • PUT /<index>/_mapping
7. Ingest-APIs
   • Verarbeitung und Transformation von Daten vor der Indexierung.
   • Beispiele:
     • PUT /_ingest/pipeline/<pipeline_id>
     • POST /_ingest/pipeline/<pipeline_id>/_simulate
8. Cat-APIs
   • Einfache, menschenlesbare Ansichten auf verschiedene Cluster-Daten.
   • Beispiele:
     • GET /_cat/indices
     • GET /_cat/nodes
     • GET /_cat/shards
9. Snapshot und Restore APIs
   • Sicherung und Wiederherstellung von Daten.
   • Beispiele:
     • PUT /_snapshot/<repository>
     • POST /_snapshot/<repository>/<snapshot>/_restore
10. Security APIs (bei aktivierter Sicherheitskonfiguration)
    • Verwaltung von Benutzern, Rollen und Sicherheitsfunktionen.
    • Beispiele:
      • GET /_plugins/_security/roles
      • PUT /_plugins/_security/roles/<role_name>
      • POST /_plugins/_security/api_key
11. Tasks APIs
    • Verfolgung und Verwaltung von laufenden Aufgaben.
    • Beispiele:
      • GET /_tasks
      • DELETE /_tasks/<task_id>
12. Aggregationen und Analytics APIs
    • Durchführung von Datenanalysen.
    • Beispiele:
      • POST /<index>/_search (mit Aggregations-Body)
13. Reindexing APIs
    • Reindexierung von Daten zwischen Indizes.
    • Beispiele:
      • POST /_reindex