View a markdown version of this page

Endpoint de status e servlet de status do openCypher no Neptune - Amazon Neptune
ParâmetrosCampos de respostaExemplos de solicitações e respostas

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Endpoint de status e servlet de status do openCypher no Neptune

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

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

É possível usar os métodos GET e POST HTTP 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 consultas do OpenCypher atualmente em execução.

  • queries: uma lista das consultas atuais do openCypher.

Campos de resposta de status para uma consulta específica

  • queryId: um ID de GUID 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 Injetar um ID personalizado em uma consulta do Gremlin ou do SPARQL no Neptune).

  • 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:

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

    Para obter mais informações, consulte get-open-cypher-query-status na Referência 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 exemplos de AWS SDK em outras linguagens, consulteAWS SDK.

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

    Este exemplo pressupõe que suas AWS credenciais estejam configuradas em seu ambiente. us-east-1Substitua pela região do seu cluster Neptune.

    curl
    curl https://your-neptune-endpoint: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:

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

    Para obter mais informações, consulte get-open-cypher-query-status na Referência 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 exemplos de AWS SDK em outras linguagens, consulteAWS SDK.

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

    Este exemplo pressupõe que suas AWS credenciais estejam configuradas em seu ambiente. us-east-1Substitua pela região do seu cluster Neptune.

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

    Resposta:

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

  • Solicitação do status de uma única 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 obter mais informações, consulte get-open-cypher-query-status na Referência 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 exemplos de AWS SDK em outras linguagens, 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

    Este exemplo pressupõe que suas AWS credenciais estejam configuradas em seu ambiente. us-east-1Substitua pela região do seu cluster Neptune.

    curl
    curl https://your-neptune-endpoint: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

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

    Para obter mais informações, consulte cancel-open-cypher-queryna Referência 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 exemplos de AWS SDK em outras linguagens, 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

    Este exemplo pressupõe que suas AWS credenciais estejam configuradas em seu ambiente. us-east-1Substitua pela região do seu cluster Neptune.

    curl

    1. Usar POST:

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

    2. Usar GET:

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

    3. Usar DELETE:

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

    Resposta:

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