APIs für Neptune-Datenebenenstatistiken und -Diagrammübersichten

Aktionen für die Statistik von Eigenschaftsdiagrammen:

• GetPropertygraphStatistics (Aktion)

• ManagePropertygraphStatistics (Aktion)

• DeletePropertygraphStatistics (Aktion)

• GetPropertygraphSummary (Aktion)

Statistikstrukturen:

• Statistics (Struktur)

• StatisticsSummary (Struktur)

• DeleteStatisticsValueMap (Struktur)

• RefreshStatisticsIdMap (Struktur)

• NodeStructure (Struktur)

• EdgeStructure (Struktur)

• SubjectStructure (Struktur)

• PropertygraphSummaryValueMap (Struktur)

• PropertygraphSummary (Struktur)

GetPropertygraphStatistics (Aktion)

        Der AWS CLI-Name für diese API lautet: get-propertygraph-statistics.

Ruft Statistiken zu Eigenschaftsdiagrammen ab (Gremlin und openCypher).

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:GetStatisticsStatus in diesem Cluster zulässt.

Anforderung

• Keine Anforderungsparameter.

Antwort

• payload – Erforderlich: Ein Statistiken-Objekt.

  Statistiken für Daten in Eigenschaftsdiagrammen.

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

  Der HTTP-Rückgabecode der Anforderung. Wenn die Anforderung erfolgreich ist, lautet der Code 200. Eine Liste der häufigsten Fehler finden Sie unter Häufige Fehlercodes für DFE-Statistikanforderungen.

Fehler

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

ManagePropertygraphStatistics (Aktion)

        Der AWS CLI-Name für diese API lautet: manage-propertygraph-statistics.

Verwaltet die Generierung und Verwendung der Statistiken von Eigenschaftsdiagrammen.

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:ManageStatistics in diesem Cluster zulässt.

Anforderung

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

  Der Modus der Statistikgenerierung. Es kann sich um einen der folgenden Modi handeln: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE oder REFRESH, wobei letzterer die Generierung von DFE-Statistiken manuell auslöst.

Antwort

• payload   – Ein RefreshStatisticsIdMap-Objekt.

  Dies wird nur für den Aktualisierungsmodus zurückgegeben.

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

  Der HTTP-Rückgabecode der Anforderung. Wenn die Anforderung erfolgreich ist, lautet der Code 200.

Fehler

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

DeletePropertygraphStatistics (Aktion)

        Der AWS CLI-Name für diese API lautet: delete-propertygraph-statistics.

Löscht Statistiken für Gremlin- und openCypher(-Eigenschaftsdiagramm)-Daten.

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:DeleteStatistics in diesem Cluster zulässt.

Anforderung

• Keine Anforderungsparameter.

Antwort

• payload   – Ein DeleteStatisticsValueMap-Objekt.

  Die Nutzlast des Löschvorgangs.

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

  Der Abbruchstatus.

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

  HTTP-Antwortcode 200, wenn das Löschen erfolgreich war, oder 204, wenn keine Statistiken zum Löschen vorhanden waren.

Fehler

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

GetPropertygraphSummary (Aktion)

        Der AWS CLI-Name für diese API lautet: get-propertygraph-summary.

Ruft eine Diagrammübersicht für ein Eigenschaftsdiagramm 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:GetGraphSummary in diesem Cluster zulässt.

Anforderung

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

  Der Modus kann einen der folgenden beiden Werte annehmen: BASIC (Standard) und DETAILED.

Antwort

• payload   – Ein PropertygraphSummaryValueMap-Objekt.

  Nutzlast, die Antwort der Eigenschaftsdiagrammübersicht enthält.

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

  Der HTTP-Rückgabecode der Anforderung. Wenn die Anforderung erfolgreich ist, lautet der Code 200.

Fehler

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

Statistikstrukturen:

Statistics (Struktur)

Enthält statistische Informationen. Die DFE-Engine verwendet Informationen zu den Daten in Ihrem Neptune-Diagramm, um bei der Planung der Abfrageausführung effektive Kompromisse einzugehen. Bei diesen Informationen handelt es sich um Statistiken, die sogenannte Merkmalssätze und Prädikatstatistiken umfassen, die als Anleitung für die Abfrageplanung dienen können. Siehe Verwalten von Statistiken, die die Neptune-DFE-Engine verwenden soll.

Felder

• active   – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Gibt an, ob die automatische Generierung von DFE-Statistiken aktiviert ist oder nicht.

• autoCompute   – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Gibt an, ob die automatische Generierung von Statistiken aktiviert ist oder nicht.

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

  Die UTC-Zeit, zu der die DFE-Statistiken zuletzt generiert wurden.

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

  Ein Hinweis zu Problemen in dem Fall, dass Statistiken ungültig sind.

• signatureInfo – Dies ist ein StatisticsSummary-Objekt.

  Eine StatisticsSummary-Struktur, die Folgendes enthält:

  • signatureCount – Gesamtzahl der Signaturen für alle Merkmalsätze.

  • instanceCount – Gesamtzahl der Merkmalsatz-Instances.

  • predicateCount – Gesamtzahl der eindeutigen Prädikate.

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

  Meldet die ID der aktuellen Statistikgenerierungsausführung. Der Wert -1 gibt an, dass keine Statistiken generiert wurden.

StatisticsSummary (Struktur)

Informationen zu den in der Statistik generierten Merkmalssätzen.

Felder

• instanceCount   – Dies ist eine Ganzzahl vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

  Gesamtzahl der Merkmalsatz-Instances.

• predicateCount   – Dies ist eine Ganzzahl vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

  Gesamtzahl der eindeutigen Prädikate.

• signatureCount   – Dies ist eine Ganzzahl vom Typ integer (32-Bit-Ganzzahl mit Vorzeichen).

  Gesamtzahl der Signaturen für alle Merkmalsätze.

DeleteStatisticsValueMap (Struktur)

Die Nutzlast für DeleteStatistics.

Felder

• active   – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

  Aktueller Status der Statistik.

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

  Die ID der Statistikgenerierung, die zurzeit ausgeführt wird.

RefreshStatisticsIdMap (Struktur)

Statistiken für den Modus REFRESH.

Felder

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

  Die ID der Statistikgenerierung, die zurzeit ausgeführt wird.

NodeStructure (Struktur)

Eine Knotenstruktur.

Felder

• count – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Anzahl der Knoten, die diese spezifische Struktur aufweisen.

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

  Liste der eindeutigen Kantenbezeichnungen, die in dieser spezifischen Struktur vorhanden sind.

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

  Liste der Knoteneigenschaften, die in dieser spezifischen Struktur vorhanden sind.

EdgeStructure (Struktur)

Eine Edge-Struktur.

Felder

• count – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Anzahl der Kanten, die diese spezifische Struktur aufweisen.

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

  Liste der Kanteneigenschaften, die in dieser spezifischen Struktur vorhanden sind.

SubjectStructure (Struktur)

Eine Subjektstruktur.

Felder

• count – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Anzahl der Vorkommen dieser spezifischen Struktur.

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

  Liste der Prädikate, die in dieser spezifischen Struktur vorhanden sind.

PropertygraphSummaryValueMap (Struktur)

Nutzlast für die Antwort der Eigenschaftsdiagrammübersicht.

Felder

• graphSummary – Dies ist ein PropertygraphSummary-Objekt.

  Die Diagrammübersicht.

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

  Zeitstempel nach ISO 8601 für den Zeitpunkt, an dem Neptune die Statistiken zuletzt berechnet hat.

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

  Version dieser Diagrammübersichtsantwort.

PropertygraphSummary (Struktur)

Die Diagrammübersichts-API gibt eine schreibgeschützte Liste von Knoten- und Kantenbezeichnungen und Eigenschaftsschlüsseln sowie die Anzahl der Knoten, Kanten und Eigenschaften zurück. Siehe Diagrammübersichtantwort für ein Eigenschaftsdiagramm (PG).

Felder

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

  Eine Liste der eindeutigen Kantenbezeichnungen im Diagramm.

• edgeProperties – Dies sind LongValuedMap-Objekte. Es handelt sich um 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 Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Eine Liste der eindeutigen Kanteneigenschaften im Diagramm zusammen mit der Zahl der Kanten, bei denen die einzelnen Eigenschaften jeweils verwendet werden.

• edgeStructures – Dies ist ein Array von EdgeStructure-Objekten.

  Dieses Feld ist nur vorhanden, wenn der angeforderte Modus DETAILED lautet. Es enthält eine Liste von Kantenstrukturen.

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

  Eine Liste der eindeutigen Knotenbezeichnungen im Diagramm.

• nodeProperties – Dies sind LongValuedMap-Objekte. Es handelt sich um 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 Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der eindeutigen Knoteneigenschaften im Diagramm.

• nodeStructures – Dies ist ein Array von NodeStructure-Objekten.

  Dieses Feld ist nur vorhanden, wenn der angeforderte Modus DETAILED lautet. Es enthält eine Liste von Knotenstrukturen.

• numEdgeLabels – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der eindeutigen Kantenbezeichnungen im Diagramm.

• numEdgeProperties – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der eindeutigen Kanteneigenschaften im Diagramm.

• numEdges – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der Kanten im Diagramm.

• numNodeLabels – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der eindeutigen Knotenbezeichnungen im Diagramm.

• numNodeProperties – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Eine Liste der eindeutigen Knoteneigenschaften im Diagramm zusammen mit der Zahl der Knoten, bei denen die einzelnen Eigenschaften jeweils verwendet werden.

• numNodes – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Anzahl der Knoten im Diagramm.

• totalEdgePropertyValues – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Gesamtzahl der Nutzungen aller Kanteneigenschaften.

• totalNodePropertyValues – Dies ist ein Long vom Typ long (eine 64-Bit-Ganzzahl mit Vorzeichen).

  Die Gesamtzahl der Nutzungen aller Knoteneigenschaften.