API de resumen de gráficos y estadísticas del plano de datos de Neptune - Amazon Neptune

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 resumen de gráficos y estadísticas del plano de datos de Neptune

Acciones estadísticas de gráficos de propiedades:

Estructuras de estadísticas:

GetPropertygraphStatistics (acción)

        El nombre de la AWS CLI para esta API es: get-propertygraph-statistics.

Obtiene las estadísticas de los gráficos de propiedades (Gremlin y openCypher).

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:GetStatisticsStatus en dicho clúster.

Solicitud
  • Ningún parámetro de solicitud.

Respuesta

  • payload: obligatorio: objeto Estadísticas.

    Estadísticas de los datos de gráficos de propiedades.

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

    El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200. Consulte Códigos de error comunes para la solicitud de estadísticas del DFE para obtener una lista de los errores más comunes.

ManagePropertygraphStatistics (acción)

        El nombre de la AWS CLI para esta API es: manage-propertygraph-statistics.

Administra la generación y el uso de estadísticas de gráficos de propiedades.

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:ManageStatistics en dicho clúster.

Solicitud

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

    El modo de generación de estadísticas. Uno de los siguientes: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE o REFRESH, el último de los cuales desencadena manualmente la generación de estadísticas del DFE.

Respuesta

  • payload: objeto RefreshStatisticsIdMap.

    Esto solo se devuelve en el modo de actualización.

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

    El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200.

DeletePropertygraphStatistics (acción)

        El nombre de la AWS CLI para esta API es: delete-propertygraph-statistics.

Elimina las estadísticas de los datos (gráficos de propiedades) de Gremlin y openCypher.

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:DeleteStatistics en dicho clúster.

Solicitud
  • Ningún parámetro de solicitud.

Respuesta

  • payload: objeto DeleteStatisticsValueMap.

    La carga de eliminación.

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

    El estado de cancelación.

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

    El código de respuesta HTTP: 200 si la eliminación se realizó correctamente o 204 si no había estadísticas que eliminar.

GetPropertygraphSummary (acción)

        El nombre de la AWS CLI para esta API es: get-propertygraph-summary.

Obtiene un resumen de gráficos de un gráfico de propiedades.

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:GetGraphSummary en dicho clúster.

Solicitud

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

    El modo puede tomar uno de estos dos valores: BASIC (el valor predeterminado) y DETAILED.

Respuesta

  • payload: objeto PropertygraphSummaryValueMap.

    Carga que incluye la respuesta de resumen de gráficos de propiedades.

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

    El código de devolución HTTP de la solicitud. Si la solicitud se ha realizado correctamente, el código es 200.

Estructuras de estadísticas:

Statistics (estructura)

Incluye información de estadísticas. El motor DFE utiliza la información sobre los datos de gráficos de Neptune para realizar compensaciones efectivas a la hora de planificar la ejecución de las consultas. Esta información adopta la forma de estadísticas que incluyen los denominados conjuntos de características y estadísticas de predicados que pueden guiar la planificación de las consultas. Consulte Administración de las estadísticas para que las utilice el DFE de Neptune.

Campos
  • active: se trata de un booleano, del tipo: boolean (un valor booleano [true o false]).

    Indica si la generación de estadísticas del DFE está habilitada o no.

  • autoCompute: se trata de un booleano, del tipo: boolean (un valor booleano [true o false]).

    Indica si la generación automática de estadísticas está habilitada o no.

  • date: se trata de un valor SyntheticTimestamp_date_time, del tipo: string (una cadena codificada en UTF-8).

    La hora UTC a la que se generaron las estadísticas del DFE por última vez.

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

    Una nota sobre los problemas en el caso de que las estadísticas no sean válidas.

  • signatureInfo: se trata de un objeto StatisticsSummary.

    Una estructura StatisticsSummary que incluye:

    • signatureCount: el número total de firmas en todos los conjuntos de características.

    • instanceCount: el número total de instancias del conjunto de características.

    • predicateCount: el número total de predicados únicos.

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

    Indica el ID de la ejecución de generación de estadísticas actual. Un valor de -1 indica que no se ha generado ninguna estadística.

StatisticsSummary (estructura)

Información sobre los conjuntos de características generados en las estadísticas.

Campos
  • instanceCount: se trata de un valor entero, del tipo: integer (un valor entero firmado de 32 bits).

    El número total de instancias del conjunto de características.

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

    El número total de predicados únicos.

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

    El número total de firmas en todos los conjuntos de características.

DeleteStatisticsValueMap (estructura)

La carga de DeleteStatistics.

Campos
  • active: se trata de un booleano, del tipo: boolean (un valor booleano [true o false]).

    El estado actual de las estadísticas.

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

    El ID de la ejecución de generación de estadísticas que se está produciendo actualmente.

RefreshStatisticsIdMap (estructura)

Estadísticas del modo REFRESH.

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

    El ID de la ejecución de generación de estadísticas que se está produciendo actualmente.

NodeStructure (estructura)

Una estructura de nodos.

Campos
  • count: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    Número de nodos que tienen esta estructura específica.

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

    Una lista de las etiquetas de borde saliente distintas presentes en esta estructura específica.

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

    Una lista de propiedades de los nodos presentes en esta estructura específica.

EdgeStructure (estructura)

Una estructura de borde.

Campos
  • count: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de bordes que tiene esta estructura específica.

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

    Una lista de propiedades de los bordes presentes en esta estructura específica.

SubjectStructure (estructura)

Una estructura de tema.

Campos
  • count: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    Número de apariciones de esta estructura específica.

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

    Una lista de predicados presentes en esta estructura específica.

PropertygraphSummaryValueMap (estructura)

Carga de la respuesta de resumen de gráficos de propiedades.

Campos
  • graphSummary: se trata de un objeto PropertygraphSummary.

    El resumen del gráfico.

  • lastStatisticsComputationTime: se trata de un valor SyntheticTimestamp_date_time, del tipo: string (una cadena codificada en UTF-8).

    La marca temporal, en formato ISO 8601, de la hora en que Neptune calculó las estadísticas por última vez.

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

    La versión de esta respuesta del resumen de gráficos.

PropertygraphSummary (estructura)

La API de resumen de gráficos devuelve una lista de solo lectura de etiquetas de nodos y bordes y claves de propiedades, junto con el recuento de nodos, bordes y propiedades. Consulte Respuesta del resumen de gráficos para un gráfico de propiedades (PG).

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

    Una lista de etiquetas de bordes distintos del gráfico.

  • edgeProperties: se trata de objetos LongValuedMap. Se trata de una matriz de mapeo de pares clave-valor donde:

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

        Cada valor es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    Una lista de las propiedades de bordes distintos del gráfico, junto con el recuento de bordes en las que se utiliza cada propiedad.

  • edgeStructures: se trata de una matriz de objetos EdgeStructure.

    Este campo solo está presente cuando el modo solicitado es DETAILED. Incluye una lista de estructuras de bordes.

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

    Una lista de etiquetas de nodos distintas del gráfico.

  • nodeProperties: se trata de objetos LongValuedMap. Se trata de una matriz de mapeo de pares clave-valor donde:

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

        Cada valor es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de propiedades de nodos distintas del gráfico.

  • nodeStructures: se trata de una matriz de objetos NodeStructure.

    Este campo solo está presente cuando el modo solicitado es DETAILED. Incluye una lista de estructuras de nodos.

  • numEdgeLabels: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de etiquetas de bordes distintos del gráfico.

  • numEdgeProperties: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de propiedades de bordes distintos del gráfico.

  • numEdges: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de bordes del gráfico.

  • numNodeLabels: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de etiquetas de nodos distintas del gráfico.

  • numNodeProperties: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    Una lista de las propiedades de nodos distintas del gráfico, junto con el recuento de nodos en los que se utiliza cada propiedad.

  • numNodes: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número de nodos del gráfico.

  • totalEdgePropertyValues: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número total de usos de todas las propiedades de bordes.

  • totalNodePropertyValues: esto es un valor Long, del tipo: long (valor entero firmado de 64 bits).

    El número total de usos de todas las propiedades de nodos.