View a markdown version of this page

Servlet de estado de openCypher de Neptune y punto de conexión de estado - Amazon Neptune
ParametersCampos de respuestaSolicitudes y respuestas de ejemplo

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Servlet de estado de openCypher de Neptune y punto de conexión de estado

El punto de conexión de estado de openCypher proporciona acceso a la información sobre las consultas que se están ejecutando actualmente en el servidor o están en espera de ejecutarse. También le permite cancelar esas consultas. El punto de conexión es:

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

Puede utilizar los métodos HTTP GET y POST para obtener el estado actual del servidor o para cancelar una consulta. También puede usar el método DELETE para cancelar una consulta en curso o en espera.

Parámetros de las solicitudes de estado

Parámetros de la consulta de estado

  • includeWaiting (true o false): cuando se establece en true y otros parámetros no están presentes, se devuelve la información de estado tanto para las consultas en espera como para las consultas en ejecución.

  • cancelQuery: se utiliza únicamente con los métodos GET y POST para indicar que se trata de una solicitud de cancelación. El método DELETE no necesita este parámetro.

    El valor del parámetro cancelQuery no se utiliza, pero cuando cancelQuery está presente, el parámetro queryId es obligatorio para identificar qué consulta se va a cancelar.

  • queryId: contiene el identificador de una consulta específica.

    Cuando se usa con el método GET o POST y el parámetro cancelQuery no está presente, queryId hace que se devuelva la información de estado de la consulta específica que identifica. Si el parámetro cancelQuery está presente, se cancela la consulta específica que queryId identifica.

    Cuando se usa con el método DELETE, queryId siempre indica que se debe cancelar una consulta específica.

  • silent: solo se usa al cancelar una consulta. Si se establece en true, hace que la cancelación se produzca de forma silenciosa.

Campos de respuesta a la solicitud de estado

Campos de respuesta de estado si no se proporciona el identificador de una consulta específica

  • acceptedQueryCount— El número de consultas que se han aceptado pero que aún no se han completado, incluidas las consultas de la cola.

  • runningQueryCount— El número de consultas de OpenCypher que se están ejecutando actualmente.

  • queries: una lista de las consultas de openCypher actuales.

Campos de respuesta de estado para una consulta específica

  • queryId: un identificador GUID de la consulta. Neptune asigna automáticamente este valor de identificador a cada consulta o también puede asignar su propio identificador (consulte Inserte un identificador personalizado en una consulta de Neptune Gremlin o SPARQL).

  • queryString: la consulta enviada. Esta se trunca en 1024 caracteres, si supera este número.

  • queryEvalStats— Estadísticas de esta consulta:

    • waited: indica cuánto tiempo esperó la consulta, en milisegundos.

    • elapsed: el número de milisegundos que la consulta lleva en ejecución.

    • cancelled: True indica que la consulta se ha cancelado o False que no se ha cancelado.

Ejemplos de solicitudes de estado y respuestas

  • Solicitud del estado de todas las consultas, incluidas las que están en espera:

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

    Para obtener más información, consulte get-open-cypher-query-status en la Referencia de AWS CLI comandos.

    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)

    Para ver ejemplos de AWS SDK en otros idiomas, consulteAWS SDK.

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

    En este ejemplo se supone que sus AWS credenciales están configuradas en su entorno. us-east-1Sustitúyala por la región de tu cúmulo de Neptuno.

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

    Respuesta:

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

  • Solicitud del estado de todas las consultas, sin incluir las que están en espera:

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

    Para obtener más información, consulte get-open-cypher-query-status en la Referencia de AWS CLI comandos.

    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)

    Para ver ejemplos de AWS SDK en otros idiomas, consulteAWS SDK.

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

    En este ejemplo se supone que sus AWS credenciales están configuradas en su entorno. us-east-1Sustitúyala por la región de tu cúmulo de Neptuno.

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

    Respuesta:

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

  • Solicitud del estado de una sola consulta:

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

    Para obtener más información, consulte get-open-cypher-query-status en la Referencia de AWS CLI comandos.

    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)

    Para ver ejemplos de AWS SDK en otros idiomas, consulteAWS 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"
    nota

    En este ejemplo se supone que sus AWS credenciales están configuradas en su entorno. us-east-1Sustitúyala por la región de tu cúmulo de Neptuno.

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

    Respuesta:

    {
  "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
  }
}

  • Solicitudes para cancelar una consulta

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

    Para obtener más información, consulte cancel-open-cypher-queryla Referencia de AWS CLI comandos.

    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)

    Para ver ejemplos de AWS SDK en otros idiomas, consulteAWS 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"
    nota

    En este ejemplo se supone que sus AWS credenciales están configuradas en su entorno. us-east-1Sustitúyala por la región de tu cúmulo de Neptuno.

    curl

    1. Uso de POST:

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

    2. Uso de GET:

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

    3. Uso de DELETE:

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

    Respuesta:

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