Sure, you can handle it. But should you?
Let our experts manage the tech maintenance while you focus on your business.
Let our experts manage the tech maintenance while you focus on your business.
Schnittstellenbeschreibung
api.v3.admin.SnapshotService
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 13.09.2024.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet.
Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Einleitung
Das aktuelle Dokument beschreibt die Mindbreeze InSpire api.v3.admin.SnapshotService Anwendungsfälle und API-Schnittstelle.
Mittels Konfigurationsparametern und sogenannten Entwickler Snapshots können Anpassungen an …
- der Mindbreeze Service Konfiguration (Hinzufügen/Entfernen und Anpassen von Connectoren, Indizes, Filter, Client Services, …)
- der Semantik Pipeline
- der Query Transformation Pipeline
- InSpire Insight Apps
- Beliebiger Resource-Files wie Boostings, Relevanzparameter
… als Snapshot exportiert werden und dann automatisch in die Produktion übernommen werden. Dabei können beliebige Einstellungen (wie zB die zu indizierenden Quellsysteme) als Parameter auf der jeweiligen Umgebung lokal überschrieben werden. Damit kann sichergestellt werden, dass produktiv die Produktionsquellen indiziert werden und im Entwicklungssystem die Entwicklerquellen. Credentials, Zertifikate werden nicht abgelegt und werden erhalten.
Mit der API api.v3.admin.SnapshotService sind Operationen mit Mindbreeze InSpire-Snapshots möglich.
Snapshot Konzepte
Snapshot
Ein Mindbreeze InSpire-Snapshot beinhalten den Zustand der Appliance-Konfiguration und der Daten. Dieser Zustand kann die Mindbreeze InSpire-Konfiguration, installierte Erweiterungen, Insight Apps usw. enthalten.
Snapshot Archive
Ein Snapshot Archive ist ein transportabler Snapshot. Um einen Snapshot auf einer anderen Appliance wiederherzustellen, muss ein Archiv durch Export des Snapshots erstellt werden. Dieses Archiv wird auf die Ziel-Appliance importiert. Nach dem Importieren des Archivs ist der Snapshot auf der Ziel-Appliance von Mindbreeze InSpire verfügbar und kann dort wiederhergestellt werden. Das Anwenden eines Snapshots stellt die Konfiguration und die optionalen Daten im Zustand des Snapshots zum Zeitpunkt der Snapshot-Erstellung wieder her.
Authentifizierungs- und Service Calling Convention
Die Mindbreeze InSpire Administration API ist unter dem Pfad (/api/v3/admin/) verfügbar, welcher auch den SnapshotService enthält. Die API wird über die OAuth Bearer Token-Authentifizierung authentifiziert. Einzelheiten zu unserer Service Calling Convention finden Sie in unserem SnapshotClient Java Sample im Mindbreeze SDK.
Snapshot Erzeugen
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/createSnapshot
CreateSnapshotRequest
Feld | Beschreibung |
name: string | Name, um verwandte Snapshots zu gruppieren |
description: string | Textuelle Detailinformationen |
dry_run: bool | Ausführung, ohne tatsächlich den Schnappschuss zu erstellen |
options: CreateSnapshotOptions | Optionen zum Erstellen des Snapshots. (siehe Tabelle unten) |
CreateSnapshotOptions
Feld | Beschreibung |
include_contents: SnapshotContentsSelector | Aufnahme der Service-Konfiguration in den Snapshot (siehe Tabelle unten) |
profile: CUSTOM | APPLIANCE_MIGRATION | DEVELOPMENT | SEARCH_EXPERIENCE | COMPLETE | Die oben genannten Include-Optionen werden nur für das Profil CUSTOM verwendet. |
SnapshotContentsSelector
Feld | Beschreibung |
service_config_and_search_apps: ServiceConfigAndSearchApps | Optionen zur Einbeziehung von Serverkonfiguration und Insight Apps (siehe Tabelle unten) |
service_credentials: ServiceCredentials | Optionen für die Einbeziehung von Service-Credentials (siehe Tabelle unten) |
search_experience: SearchExperience | Optionen für die Einbeziehung von Search-Experience (siehe Tabelle unten) |
reporting: Reporting | Optionen für die Einbeziehung des Reportings (siehe Tabelle unten) |
resources: Resources | Optionen für die Einbeziehung von Resources (siehe Tabelle unten) |
persisted_resources: PersistedResources | Optionen für die Einbeziehung Persisted Resources (siehe Tabelle unten) |
plugins: Plugins | Optionen für die Einbeziehung von Plugins (siehe Tabelle unten) |
ServiceConfigAndSearchApps
Feld | Beschreibung |
service_config: bool | Einbeziehen der Service Konfiguration |
referenced_search_apps: bool | Referenzierte Insight Apps einbeziehen |
all_search_apps: bool | Alle Insight Apps einbeziehen |
authenticators: bool | Authenticators einbeziehen |
ServiceCredentials
Feld | Beschreibung |
service_credentials: bool | Einbeziehen von Service Credentials |
kerberos_data: bool | Einbeziehen von Kerberos-Daten |
SearchExperience
Feld | Beschreibung |
synonyms: bool | Synonyme einbeziehen |
replacements: bool | Replacements einbeziehen |
vocabulary: bool | Vocabulary einbeziehen |
relevance_query_boostings: bool | Relevance Query Boostings einbeziehen |
relevance_options: bool | Relevanz Options einbeziehen |
Reporting
Feld | Beschreibung |
apptelemetry_config: bool | app.telemetry Konfiguration einbeziehen |
apptelemetry_data: bool | app.telemetry Daten einbeziehen |
all_apptelemetry_data: bool | Alle app.telemetry Daten einbeziehen |
Resources
Feld | Beschreibung |
default_resources: bool | Standard-Ressourcen einbeziehen |
resource_patterns: string | Regulärer Ausdruck, der einbezogene Ressourcen definiert |
PersistedResources
Feld | Beschreibung |
referenced_resources: bool | referenzierte Ressourcen einbeziehen |
Plugins
Feld | Beschreibung |
custom_plugins: bool | benutzerdefinierte (nicht builtin) Plugins einbeziehen |
CreateSnapshotResponse
Property | Beschreibung |
snapshot_id : string | Id des erstellten Snapshots |
Snapshot Anwenden
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ applySnapshot
ApplySnapshotRequest
Feld | Beschreibung |
snapshot_id: string | ID des anzuwendenden Snapshots |
reset: bool | Wenn auf true gesetzt, werden alle alten Ressourcen gelöscht, wenn eine Insight App importiert wird. |
ApplySnapshotResponse
Feld | Beschreibung |
snapshot_id: string | ID des angewendeten Schnappschusses |
Snapshot Archive Exportieren
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/ exportSnapshot
ExportSnapshotRequest
Feld | Beschreibung |
snapshot_id: string | ID des Snapshots, der exportiert werden soll |
ExportSnapshotResponse
Feld | Beschreibung |
snapshot_archive_id: string | Archiv ID des exportierten Schnappschusses |
snapshot_archive_url: string | Archiv URL des exportierten Snapshots |
Import Snapshot
HTTP POST https://myinspire.com:8443/api/v3/admin/mindbreeze.api.v3.admin.SnapshotService/importSnapshot
ImportSnapshotRequest
Feld | Beschreibung |
snapshot_archive_id: string | ID des Snapshot Archives (alternativ zu snapshot_archive_url) |
snapshot_archive_url: string | URL des Snapshot Archives (alternativ zu snapshot_archive_id) |
import_options: ImportSnapshotOptions | Optionen für den Import (siehe Tabelle unten) |
ImportSnapshotOptions
Feld | Beschreibung |
exclude_contents: SnapshotContentsSelector | Definiert, welcher Inhalt importiert wird (siehe Tabelle oben) |
node_id_mapping : NodeIdMapping | Mapping der Node IDs <alte Node ID, neue Node ID> (siehe Tabelle unten) |
configuration_parameters: ConfigurationParametersEntry | Setzt die konkreten Werte von parametrisierten Optionen (siehe Tabelle unten) |
NodeIdMapping
Feld | Beschreibung |
mapping: MappingEntry | Liste der MappingEntrys (siehe Tabelle unten) |
MappingEntry
Feld | Beschreibung |
key: string | Alte Node ID |
value: string | Neue Node ID |
ConfigurationParametersEntry
Feld | Beschreibung |
key: string | Name des Parameters |
value: string | Wert des Parameters |
ImportSnapshotResponse
Feld | Description |
snapshot_id: string | ID des Snapshots |