Engine-, Fast-Reset- und General-Structure-APIs für die Neptune-Datenebene - Amazon Neptune
getEngineStatusExecuteFastReset________________________QueryLanguageVersionFastResetToken

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Engine-, Fast-Reset- und General-Structure-APIs für die Neptune-Datenebene

Engine-Operationen:

Strukturen der Engine-Operationen:

GetEngineStatus (Aktion)

        Der AWS CLI-Name für diese API lautet: get-engine-status.

Ruft den Status der Graphdatenbank auf dem Host ab.

Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:GetEngineStatus in diesem Cluster zulässt.

Anforderung

  • Keine Anforderungsparameter.

Antwort

  • dbEngineVersion   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Stellen Sie die Version der Neptune-Engine ein, die in Ihrem DB-Cluster ausgeführt wird. Wenn diese Engine-Version nach ihrer Freigabe manuell gepatcht wurde, wird der Versionsnummer der Zusatz Patch- vorangestellt.

  • dfeQueryEngine   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Wird auf enabled gesetzt, wenn die DFE-Engine vollständig aktiviert ist, oder auf viaQueryHint (Standardeinstellung), wenn die DFE-Engine nur für Abfragen verwendet wird, bei denen der useDFE-Abfragehinweis auf true festgelegt ist.

  • features   – Ein Map-Array von Schlüssel-Wert-Paaren, wobei Folgendes gilt:

        Jeder Schlüssel ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

        Jeder Wert ist ein Dokument vom Typ document (protokollunabhängiger offener Inhalt, der durch ein JSON-ähnliches Datenmodell repräsentiert wird).

    Enthält Statusinformationen zu den im DB-Cluster aktivierten Funktionen.

  • gremlin   – Ein QueryLanguageVersion-Objekt.

    Enthält Informationen zur Gremlin-Abfragesprache, die im Cluster verfügbar ist. Insbesondere enthält es ein Versionsfeld, in dem die aktuelle von der Engine verwendete TinkerPop-Version angegeben ist.

  • labMode   – Ein Map-Array von Schlüssel-Wert-Paaren, wobei Folgendes gilt:

        Jeder Schlüssel ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

        Jeder Wert ist eine Zeichenfolge vom Typ string (eine UTF-8-kodierte Zeichenfolge).

    Enthält Einstellungen des Labor-Modus, die von der Engine verwendet werden.

  • opencypher   – Ein QueryLanguageVersion-Objekt.

    Enthält Informationen über die openCypher-Abfragesprache, die im Cluster verfügbar ist. Insbesondere enthält es ein Versionsfeld, in dem die aktuelle von der Engine verwendete operCypher-Version angegeben ist.

  • role   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Dieses Feld wird auf reader festgelegt, wenn die Instance ein Read Replica ist, oder auf writer, wenn es sich um die primäre Instance handelt.

  • rollingBackTrxCount   – eine Ganzzahl vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

    Wenn Transaktionen rückgängig gemacht werden, wird dieses Feld auf die Anzahl solcher Transaktionen festgelegt. Wenn keine Transaktionen vorhanden sind, wird das Feld nicht angezeigt.

  • rollingBackTrxEarliestStartTime   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Wird auf die Startzeit der frühesten Transaktion festgelegt, die rückgängig gemacht wird. Wenn keine Transaktionen zurückgesetzt werden, wird dieses Feld nicht im Status angezeigt.

  • settings   – Ein Map-Array von Schlüssel-Wert-Paaren, wobei Folgendes gilt:

        Jeder Schlüssel ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

        Jeder Wert ist eine Zeichenfolge vom Typ string (eine UTF-8-kodierte Zeichenfolge).

    Enthält Informationen über die aktuellen Einstellungen des DB-Clusters. Enthält beispielsweise die aktuelle Einstellung für den Timeout von Cluster-Abfragen (clusterQueryTimeoutInMs).

  • sparql   – Ein QueryLanguageVersion-Objekt.

    Enthält Informationen über die SPARQL-Abfragesprache, die im Cluster verfügbar ist. Insbesondere enthält es ein Versionsfeld, in dem die aktuelle von der Engine verwendete SPARQL-Version angegeben ist.

  • startTime   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ist auf die UTC-Zeit eingestellt, zu der der aktuelle Serverprozess gestartet wird.

  • status   – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Wird auf healthy gesetzt, wenn bei der Instance keine Probleme auftreten. Wenn die Instance nach einem Ausfall oder Neustart wiederhergestellt wird und noch aktive Transaktionen vom letzten Herunterfahren des Servers ausgeführt werden, wird als Status recovery festgelegt.

Fehler

ExecuteFastReset (Aktion)

        Der AWS CLI-Name für diese API lautet: execute-fast-reset.

Mit der Fast-Reset-REST-API können Sie ein Neptune-Diagramm schnell und einfach zurücksetzen und dabei alle seine Daten entfernen.

Der Neptune-Fast-Reset für einen Cluster ist ein zweistufiger Prozess. Rufen Sie zuerst ExecuteFastReset auf, wobei action auf initiateDatabaseReset festgelegt sein muss. Dies gibt ein UUID-Token zurück, das Sie dann einbinden, wenn Sie ExecuteFastReset erneut aufrufen und action auf performDatabaseReset festgelegt ist. Siehe Leeren eines Amazon Neptune-DB-Clusters mithilfe der Fast-Reset-API.

Wenn diese Operation in einem Neptune-Cluster mit aktivierter IAM-Authentifizierung aufgerufen wird, muss mit dem IAM-Benutzer oder der Rolle, die die Anforderung gestellt hat, eine Richtlinie verknüpft sein, die die IAM-Aktion neptune-db:ResetDatabase in diesem Cluster zulässt.

Anforderung

  • action  (in der CLI: --action) – Erforderlich: Eine Aktion vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die Fast-Reset-Aktion. Einer der folgenden Werte:

    • initiateDatabaseReset  –   Durch diese Aktion wird ein eindeutiges Token generiert, das für die tatsächliche Ausführung des Fast Reset benötigt wird.

    • performDatabaseReset   –   Diese Aktion verwendet das von der initiateDatabaseReset-Aktion generierte Token, um den Fast Reset tatsächlich auszuführen.

  • token   (in der CLI: --token) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Das Fast-Reset-Token zur Einleitung des Reset.

Antwort

  • payload   – Ein FastResetToken-Objekt.

    Die payload wird nur von der initiateDatabaseReset-Aktion zurückgegeben und enthält das eindeutige Token, das zusammen mit der performDatabaseReset-Aktion verwendet werden soll, um den Reset auszuführen.

  • status   – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der status wird nur für die performDatabaseReset-Aktion zurückgegeben und gibt an, ob die Fast-Reset-Anforderung akzeptiert wurde oder nicht.

Fehler

Strukturen der Engine-Operationen:

QueryLanguageVersion (Struktur)

Struktur zum Ausdrücken der Version der Abfragesprache.

Felder

  • version – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die Version der Abfragesprache.

FastResetToken (Struktur)

Eine Struktur, die das Fast-Reset-Token enthält, mit dem ein Fast-Reset initiiert wird.

Felder

  • token – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Eine UUID, die von der Datenbank in der initiateDatabaseReset-Aktion generiert und dann von der performDatabaseReset verwendet wird, um die Datenbank zurückzusetzen.