View a markdown version of this page

Neptune-openCypher-Status-Servlet und Statusendpunkt - Amazon Neptune
ParametersAntwortfelderBeispielanforderungen und Beispielantworten

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.

Neptune-openCypher-Status-Servlet und Statusendpunkt

Der openCypher-Statusendpunkt bietet Zugriff auf Informationen zu Abfragen, die zurzeit auf dem Server ausgeführt werden oder auf die Ausführung warten. Sie können diese Abfragen auch abbrechen. Der Endpunkt ist:

https://(the server):(the port number)/openCypher/status

Sie können die HTTP-Methoden GET und POST verwenden, um den aktuellen Status vom Server abzurufen oder eine Abfrage abzubrechen. Sie können die Methode DELETE auch verwenden, um eine ausgeführte oder wartende Abfrage abzubrechen.

Parameter für Statusanforderungen

Statusabfrage-Parameter

  • includeWaiting (true oder false)   –   Wenn auf true festgelegt und keine anderen Parameter vorhanden sind, werden Statusinformationen für wartende und ausgeführte Abfragen zurückgegeben.

  • cancelQuery   –   Wird nur mit den Methoden POST und GET verwendet, um anzuzeigen, dass es sich um eine Abbruchanforderung handelt. Die Methode DELETE benötigt diesen Parameter nicht.

    Der Wert des Parameters cancelQuery wird nicht verwendet. Wenn jedoch cancelQuery vorhanden ist, ist der Parameter queryId erforderlich, um die Abfrage zu identifizieren, die abgebrochen werden soll.

  • queryId   –   Enthält die ID einer bestimmten Abfrage.

    Wenn mit den Methoden GET oder POST verwendet und wenn der Parameter cancelQuery nicht vorhanden ist, veranlasst queryId die Rückgabe von Statusinformationen für die spezifische identifizierte Abfrage. Wenn der Parameter cancelQuery vorhanden ist, wird die spezifische Abfrage abgebrochen, die queryId identifiziert.

    Gibt bei Verwendung mit der Methode DELETE gibt queryId stets eine bestimmte Abfrage an, die abgebrochen werden soll.

  • silent   –   Wird nur beim Abbruch einer Abfrage verwendet. Wenn auf true festgelegt, erfolgt der Abbruch im Hintergrund.

Statusanforderungs-Antwortfelder

Statusantwortfelder, wenn die ID einer bestimmten Abfrage nicht angegeben wird

  • acceptedQueryCount— Die Anzahl der Abfragen, die akzeptiert, aber noch nicht abgeschlossen wurden, einschließlich Abfragen in der Warteschlange.

  • runningQueryCount— Die Anzahl der aktuell laufenden OpenCypher-Abfragen.

  • queries   –   Eine Liste der aktuellen openCypher-Abfragen.

Statusantwortfelder für eine bestimmte Abfrage

  • queryId   –   Eine GUID-ID für die Abfrage. Neptune weist diesen ID-Wert automatisch jeder Abfrage zu. Sie können auch eine eigene ID zuweisen (siehe Einfügen einer benutzerdefinierten ID in eine Neptune-Gremlin- oder -SPARQL-Abfrage).

  • queryString   –   Die übermittelte Abfrage. Die Abfrage wird nach 1024 Zeichen abgeschnitten, wenn sie länger ist.

  • queryEvalStats— Statistiken für diese Abfrage:

    • waited   –   Der Zeitraum in Millisekunden, über den die Abfrage gewartet hat.

    • elapsed   –   Der Zeitraum in Millisekunden, über den die Abfrage bis jetzt ausgeführt wurde.

    • cancelled   –   True gibt an, dass die Abfrage abgebrochen wurde; False gibt an, dass sie nicht abgebrochen wurde.

Beispiele für Statusanforderungen und Antworten

  • Anforderung des Status aller Abfragen, einschließlich wartender Abfragen:

    AWS CLI
    aws neptunedata get-open-cypher-query-status \
  --endpoint-url https://your-neptune-endpoint:port \
  --include-waiting

    Weitere Informationen finden Sie unter get-open-cypher-query-status in der AWS CLI Befehlsreferenz.

    SDK
    import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.get_open_cypher_query_status(
    includeWaiting=True
)

print(response)

    AWS SDK-Beispiele in anderen Sprachen finden Sie unterAWS SDK.

    awscurl
    awscurl https://your-neptune-endpoint:port/openCypher/status \
  --region us-east-1 \
  --service neptune-db \
  -X POST \
  -d "includeWaiting=true"
    Anmerkung

    In diesem Beispiel wird davon ausgegangen, dass Ihre AWS Anmeldeinformationen in Ihrer Umgebung konfiguriert sind. Ersetze es us-east-1 durch die Region deines Neptun-Clusters.

    curl
    curl https://your-neptune-endpoint:port/openCypher/status \
  --data-urlencode "includeWaiting=true"

    Antwort:

    {
  "acceptedQueryCount" : 0,
  "runningQueryCount" : 0,
  "queries" : [ ]
}

  • Anforderung des Status ausgeführter Abfragen, ohne wartende Abfragen:

    AWS CLI
    aws neptunedata get-open-cypher-query-status \
  --endpoint-url https://your-neptune-endpoint:port

    Weitere Informationen finden Sie unter get-open-cypher-query-status in der AWS CLI Befehlsreferenz.

    SDK
    import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.get_open_cypher_query_status()

print(response)

    AWS SDK-Beispiele in anderen Sprachen finden Sie unterAWS SDK.

    awscurl
    awscurl https://your-neptune-endpoint:port/openCypher/status \
  --region us-east-1 \
  --service neptune-db
    Anmerkung

    In diesem Beispiel wird davon ausgegangen, dass Ihre AWS Anmeldeinformationen in Ihrer Umgebung konfiguriert sind. Ersetze es us-east-1 durch die Region deines Neptun-Clusters.

    curl
    curl https://your-neptune-endpoint:port/openCypher/status

    Antwort:

    {
  "acceptedQueryCount" : 0,
  "runningQueryCount" : 0,
  "queries" : [ ]
}

  • Anforderung des Status einer einzelnen Abfrage:

    AWS CLI
    aws neptunedata get-open-cypher-query-status \
  --endpoint-url https://your-neptune-endpoint:port \
  --query-id eadc6eea-698b-4a2f-8554-5270ab17ebee

    Weitere Informationen finden Sie unter get-open-cypher-query-status in der AWS CLI Befehlsreferenz.

    SDK
    import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.get_open_cypher_query_status(
    queryId='eadc6eea-698b-4a2f-8554-5270ab17ebee'
)

print(response)

    AWS SDK-Beispiele in anderen Sprachen finden Sie unterAWS SDK.

    awscurl
    awscurl https://your-neptune-endpoint:port/openCypher/status \
  --region us-east-1 \
  --service neptune-db \
  -X POST \
  -d "queryId=eadc6eea-698b-4a2f-8554-5270ab17ebee"
    Anmerkung

    In diesem Beispiel wird davon ausgegangen, dass Ihre AWS Anmeldeinformationen in Ihrer Umgebung konfiguriert sind. Ersetze es us-east-1 durch die Region deines Neptun-Clusters.

    curl
    curl https://your-neptune-endpoint:port/openCypher/status \
  --data-urlencode "queryId=eadc6eea-698b-4a2f-8554-5270ab17ebee"

    Antwort:

    {
  "queryId" : "eadc6eea-698b-4a2f-8554-5270ab17ebee",
  "queryString" : "MATCH (n1)-[:knows]->(n2), (n2)-[:knows]->(n3), (n3)-[:knows]->(n4), (n4)-[:knows]->(n5), (n5)-[:knows]->(n6), (n6)-[:knows]->(n7), (n7)-[:knows]->(n8), (n8)-[:knows]->(n9), (n9)-[:knows]->(n10) RETURN COUNT(n1);",
  "queryEvalStats" : {
    "waited" : 0,
    "elapsed" : 23463,
    "cancelled" : false
  }
}

  • Anforderungen des Abbruchs einer Abfrage

    AWS CLI
    aws neptunedata cancel-open-cypher-query \
  --endpoint-url https://your-neptune-endpoint:port \
  --query-id f43ce17b-db01-4d37-a074-c76d1c26d7a9

    Weitere Informationen finden Sie cancel-open-cypher-queryin der AWS CLI Befehlsreferenz.

    SDK
    import boto3
from botocore.config import Config

client = boto3.client(
    'neptunedata',
    endpoint_url='https://your-neptune-endpoint:port',
    config=Config(read_timeout=None, retries={'total_max_attempts': 1})
)

response = client.cancel_open_cypher_query(
    queryId='f43ce17b-db01-4d37-a074-c76d1c26d7a9'
)

print(response)

    AWS SDK-Beispiele in anderen Sprachen finden Sie unterAWS SDK.

    awscurl
    awscurl https://your-neptune-endpoint:port/openCypher/status \
  --region us-east-1 \
  --service neptune-db \
  -X POST \
  -d "cancelQuery" \
  -d "queryId=f43ce17b-db01-4d37-a074-c76d1c26d7a9"
    Anmerkung

    In diesem Beispiel wird davon ausgegangen, dass Ihre AWS Anmeldeinformationen in Ihrer Umgebung konfiguriert sind. Ersetze es us-east-1 durch die Region deines Neptun-Clusters.

    curl

    1. Verwenden von POST:

    curl -X POST https://your-neptune-endpoint:port/openCypher/status \
  --data-urlencode "cancelQuery" \
  --data-urlencode "queryId=f43ce17b-db01-4d37-a074-c76d1c26d7a9"

    2. Verwenden von GET:

    curl -X GET https://your-neptune-endpoint:port/openCypher/status \
  --data-urlencode "cancelQuery" \
  --data-urlencode "queryId=588af350-cfde-4222-bee6-b9cedc87180d"

    3. Verwenden von DELETE:

    curl -X DELETE \
  "https://your-neptune-endpoint:port/openCypher/status?queryId=b9a516d1-d25c-4301-bb80-10b2743ecf0e"

    Antwort:

    {
  "status" : "200 OK",
  "payload" : true
}