Servlet de status e endpoint de status do openCypher Neptune

O endpoint de openCypher status fornece acesso a informações sobre consultas que estão sendo executadas no servidor ou aguardando para serem executadas. Também permite que você cancele essas consultas. O endpoint é:

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

Você pode usar os POST métodos HTTP GET e para obter o status atual do servidor ou cancelar uma consulta. Você também pode usar o método DELETE para cancelar uma consulta em execução ou em espera.

Parâmetros para solicitações de status

Parâmetros de consulta de status

• includeWaiting (true ou false): quando definido como true e outros parâmetros não estão presentes, faz com que as informações de status das consultas em espera sejam geradas, bem como das consultas em execução.

• cancelQuery: usado somente com os métodos GET e POST, para indicar que se trata de uma solicitação de cancelamento. O método DELETE não precisa desse parâmetro.

  O valor do parâmetro cancelQuery não é usado, mas quando cancelQuery está presente, o parâmetro queryId é obrigatório para identificar qual consulta cancelar.

• queryId: contém o ID de uma consulta específica.

  Quando usado com o método GET ou POST e o parâmetro cancelQuery não está presente, queryId faz com que as informações sejam geradas para a consulta específica identificada. Se o parâmetro cancelQuery estiver presente, a consulta específica que queryId identifica será cancelada.

  Quando usado com o método DELETE, queryId sempre indica que uma consulta específica deve ser cancelada.

• silent: usado somente ao cancelar uma consulta. Se definido como true, faz com que o cancelamento ocorra silenciosamente.

Campos de resposta da solicitação de status

Campos de resposta de status se o ID de uma consulta específica não for fornecido

• acceptedQueryCount— O número de consultas que foram aceitas, mas ainda não concluídas, incluindo consultas na fila.

• runningQueryCount— O número de openCypher consultas em execução no momento.

• consultas — Uma lista das openCypher consultas atuais.

Campos de resposta de status para uma consulta específica

• queryId— Um GUID id para a consulta. O Neptune atribui automaticamente esse valor de ID a cada consulta, ou você também pode atribuir seu próprio ID (consulte Injete uma ID personalizada em um Neptune Gremlin ou Query SPARQL).

• queryString— A consulta enviada. Ela será truncada para 1024 caracteres se for maior do que isso.

• queryEvalStats— Estatísticas para esta consulta:

  • waited: indica quanto tempo a consulta esperou, em milissegundos.

  • elapsed: o número de milissegundos em que a consulta esteve em execução até o momento.

  • cancelled: True indica que a consulta foi cancelada ou False que não foi cancelada.

Exemplos de solicitação e resposta de status

• Solicitação do status de todas as consultas, incluindo aquelas em espera:

  curl https://server:port/openCypher/status \
    --data-urlencode "includeWaiting=true"

  Resposta:

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

• Solicitação do status de todas as consultas em execução, não incluindo aquelas em espera:

  curl https://server:port/openCypher/status

  Resposta:

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

• Solicitação do status de uma única consulta:

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

  Resposta:

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

• Solicitações para cancelar uma consulta

  1. Usar POST:

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

  Resposta:

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

  2. Usar GET:

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

  Resposta:

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

  3. Usar DELETE:

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

  Resposta:

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