API de estructura general, restablecimiento rápido y motor de plano de datos de Neptune - Amazon Neptune
GetEngineStatusExecuteFastReset________________________QueryLanguageVersionFastResetToken

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.

API de estructura general, restablecimiento rápido y motor de plano de datos de Neptune

Operaciones del motor:

Estructuras de funcionamiento del motor:

GetEngineStatus (acción)

        El nombre de la AWS CLI para esta API es: get-engine-status.

Recupera el estado de la base de datos de gráficos del host.

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:GetEngineStatus en dicho clúster.

Solicitud

  • Ningún parámetro de solicitud.

Respuesta

  • dbEngineVersion: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en la versión del motor de Neptune que se ejecuta en el clúster de base de datos. Si esta versión del motor se ha parcheado de forma manual desde que se lanzó, el número de versión está precedido por Patch-.

  • dfeQueryEngine: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en enabled si el motor DFE está totalmente habilitado o en viaQueryHint (valor predeterminado) si el motor de DFE solo se usa con consultas que tienen la sugerencia de consulta useDFE establecida en true.

  • features: es una matriz de mapas de pares de clave-valor donde:

        Cada clave es una cadena, del tipo: string (una cadena codificada con UTF-8).

        Cada valor es un documento, del tipo: document (un contenido abierto independiente del protocolo representado por un modelo de datos similar a JSON).

    Incluye información de estado sobre las características habilitadas en el clúster de base de datos.

  • gremlin: objeto QueryLanguageVersion.

    Incluye información sobre el lenguaje de consultas de Gremlin disponible en el clúster. Específicamente, incluye un campo de versión que especifica la versión actual de TinkerPop que utiliza el motor.

  • labMode: es una matriz de mapas de pares de clave-valor donde:

        Cada clave es una cadena, del tipo: string (una cadena codificada con UTF-8).

        Cada valor es una cadena, del tipo: string (una cadena codificada con UTF-8).

    Incluye los ajustes del modo lab que utiliza el motor.

  • opencypher: objeto QueryLanguageVersion.

    Incluye información sobre el lenguaje de consultas de openCypher disponible en el clúster. Específicamente, incluye un campo de versión que especifica la versión actual de openCypher que utiliza el motor.

  • role: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en reader si la instancia es una réplica de lectura o en writer si la instancia es la instancia principal.

  • rollingBackTrxCount: un valor entero, del tipo: integer (un valor entero firmado de 32 bits).

    Si hay transacciones que se están restaurando, este campo se establece en el número de dichas transacciones. Si no hay ninguna transacción, el campo no aparecerá.

  • rollingBackTrxEarliestStartTime: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en la hora de inicio de la primera transacción que se va a restaurar. Si no se está revirtiendo ninguna transacción, este campo no aparecerá.

  • settings: es una matriz de mapas de pares de clave-valor donde:

        Cada clave es una cadena, del tipo: string (una cadena codificada con UTF-8).

        Cada valor es una cadena, del tipo: string (una cadena codificada con UTF-8).

    Incluye información sobre la configuración actual del clúster de base de datos. Por ejemplo, incluye el valor de tiempo de espera de la consulta del clúster actual (clusterQueryTimeoutInMs).

  • sparql: objeto QueryLanguageVersion.

    Incluye información sobre el lenguaje de consultas de SPARQL disponible en el clúster. Específicamente, incluye un campo de versión que especifica la versión actual de SPARQL que utiliza el motor.

  • startTime: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en la hora UTC a la que se inició el proceso actual del servidor.

  • status: una cadena, del tipo: string (una cadena codificada con UTF-8).

    Se establece en healthy si la instancia no está experimentando problemas. Si la instancia se está recuperando de un bloqueo o se reinicia y hay transacciones activas en ejecución desde el último cierre del servidor, status se establece en recovery.

Errores

ExecuteFastReset (acción)

        El nombre de la AWS CLI para esta API es: execute-fast-reset.

La API de REST de restablecimiento rápido le permite restablecer un gráfico de Neptune de forma rápida y sencilla, eliminando todos sus datos.

La restauración rápida de Neptune es un proceso de dos pasos. En primer lugar, llama a ExecuteFastReset con la opción action establecida en initiateDatabaseReset. Esto devuelve un token de UUID que luego debe incluirse cuando se vuelva a llamar a ExecuteFastReset con opción action establecida en performDatabaseReset. Consulte Vaciado de un clúster de base de datos de Amazon Neptune con la API de restablecimiento rápido.

Al invocar esta operación en un clúster de Neptune que tiene habilitada la autenticación de IAM, el usuario o rol de IAM que realiza la solicitud debe tener una política adjunta que permita la acción de IAM neptune-db:ResetDatabase en dicho clúster.

Solicitud

  • action (en la CLI: --action): obligatorio: una acción, del tipo: string (una cadena codificada con UTF-8).

    La acción de restablecimiento rápido. Uno de los valores siguientes:

    • initiateDatabaseReset: esta acción genera un token único necesario para realizar realmente el restablecimiento rápido.

    • performDatabaseReset: esta acción utiliza el token generado por la acción initiateDatabaseReset para realizar realmente el restablecimiento rápido.

  • token (en la CLI: --token): una cadena, del tipo: string (una cadena codificada con UTF-8).

    El token de restablecimiento rápido para iniciar el restablecimiento.

Respuesta

  • payload: objeto FastResetToken.

    La acción initiateDatabaseReset solo devuelve payload, que incluye el token único que se usará con la acción performDatabaseReset para que se realice el restablecimiento.

  • status: obligatorio: una cadena, del tipo: string (una cadena codificada con UTF-8).

    La acción performDatabaseReset solo devuelve status, que indica si se acepta o no la solicitud de restablecimiento rápido.

Errores

Estructuras de funcionamiento del motor:

QueryLanguageVersion (estructura)

Estructura para expresar la versión del lenguaje de consulta.

Campos

  • version: esto es obligatorio: una cadena, del tipo: string (una cadena codificada con UTF-8).

    La versión del lenguaje de consulta.

FastResetToken (estructura)

Estructura que incluye el token de restablecimiento rápido que se utiliza para iniciar un restablecimiento rápido.

Campos

  • token: se trata de una cadena, del tipo: string (una cadena codificada con UTF-8).

    Un UUID generado por la base de datos en la acción initiateDatabaseReset y luego utilizado por performDatabaseReset para restablecer la base de datos.