Neptune 数据面板统计数据和图形摘要 API - Amazon Neptune
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Neptune 数据面板统计数据和图形摘要 API

属性图统计数据操作:

统计数据结构:

GetPropertygraphStatistics(操作)

        此 API 的 Amazon CLI 名称为:get-propertygraph-statistics

获取属性图统计数据(Gremlin 和 openCypher)。

在启用了 IAM 身份验证的 Neptune 集群中调用此操作时,发出请求的 IAM 用户或角色必须附加允许在该集群中执行 neptune-db:GetStatisticsStatus IAM 操作的策略。

请求
  • 无请求参数。

响应

  • payload必填:一个 统计数据 对象。

    属性图数据的统计数据。

  • status必需:一个字符串,类型为:string(UTF-8 编码的字符串)。

    请求的 HTTP 返回代码。如果请求成功,则代码为 200。有关常见错误的列表,请参阅 DFE 统计数据请求的常见错误代码

ManagePropertygraphStatistics(操作)

        此 API 的 Amazon CLI 名称为:manage-propertygraph-statistics

管理属性图统计数据的生成和使用。

在启用了 IAM 身份验证的 Neptune 集群中调用此操作时,发出请求的 IAM 用户或角色必须附加允许在该集群中执行 neptune-db:ManageStatistics IAM 操作的策略。

请求

  • mode(在 CLI 中:--mode)– StatisticsAutoGenerationMode,类型为:string(UTF-8 编码的字符串)。

    统计数据生成模式。其中之一:DISABLE_AUTOCOMPUTEENABLE_AUTOCOMPUTEREFRESH,最后一个模式手动触发 DFE 统计数据生成。

响应

  • payload – 一个 RefreshStatisticsIdMap 对象。

    这仅在刷新模式下才会返回。

  • status必需:一个字符串,类型为:string(UTF-8 编码的字符串)。

    请求的 HTTP 返回代码。如果请求成功,则代码为 200。

DeletePropertygraphStatistics(操作)

        此 API 的 Amazon CLI 名称为:delete-propertygraph-statistics

删除 Gremlin 和 openCypher(属性图)数据的统计数据。

在启用了 IAM 身份验证的 Neptune 集群中调用此操作时,发出请求的 IAM 用户或角色必须附加允许在该集群中执行 neptune-db:DeleteStatistics IAM 操作的策略。

请求
  • 无请求参数。

响应

  • payload – 一个 DeleteStatisticsValueMap 对象。

    删除有效负载。

  • status – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    取消状态。

  • statusCode – 一个整数,类型为:integer(带符号的 32 位整数)。

    HTTP 响应代码:如果删除成功,则为 200;如果没有要删除的统计数据,则为 204。

GetPropertygraphSummary(操作)

        此 API 的 Amazon CLI 名称为:get-propertygraph-summary

获取属性图的图形摘要。

在启用了 IAM 身份验证的 Neptune 集群中调用此操作时,发出请求的 IAM 用户或角色必须附加允许在该集群中执行 neptune-db:GetGraphSummary IAM 操作的策略。

请求

  • mode(在 CLI 中:--mode)– GraphSummaryType,类型为:string(UTF-8 编码的字符串)。

    模式可以取两个值之一:BASIC(默认)和 DETAILED

响应

  • payload – 一个 PropertygraphSummaryValueMap 对象。

    包含属性图摘要响应的有效负载。

  • statusCode – 一个整数,类型为:integer(带符号的 32 位整数)。

    请求的 HTTP 返回代码。如果请求成功,则代码为 200。

统计数据结构:

Statistics(结构)

包含统计信息。在计划查询执行时,DFE 引擎使用有关 Neptune 图形中数据的信息来进行有效的权衡。这些信息采用统计数据的形式,包括可以指导查询计划的所谓特性集和谓词统计数据。请参阅管理 Neptune DFE 要使用的统计数据

字段
  • active - 这是一个布尔值,类型为:boolean [布尔值(true 或 false)]。

    表示是否启用了 DFE 统计数据生成。

  • autoCompute - 这是一个布尔值,类型为:boolean [布尔值(true 或 false)]。

    表示是否启用了自动统计数据生成。

  • date – 这是 SyntheticTimestamp_date_time,类型为:string(UTF-8 编码的字符串)。

    最近生成 DFE 统计数据的 UTC 时间。

  • note – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    有关统计数据无效时出现的问题的注释。

  • signatureInfo –这是一个 StatisticsSummary 对象。

    包含以下内容的 StatisticsSummary 结构:

    • signatureCount - 所有特性集中的签名总数。

    • instanceCount – 特性集实例的总数。

    • predicateCount – 唯一谓词的总数。

  • statisticsId – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    报告当前统计数据生成运行的 ID。值为 -1 表示未生成任何统计数据。

StatisticsSummary(结构)

有关统计数据中生成的特性集的信息。

字段
  • instanceCount – 这是一个整数,类型为:integer(带符号的 32 位整数)。

    特性集实例的总数。

  • predicateCount – 这是一个整数,类型为:integer(带符号的 32 位整数)。

    唯一谓词的总数。

  • signatureCount – 这是一个整数,类型为:integer(带符号的 32 位整数)。

    所有特性集中的签名总数。

DeleteStatisticsValueMap(结构)

DeleteStatistics 的有效负载。

字段
  • active - 这是一个布尔值,类型为:boolean [布尔值(true 或 false)]。

    统计数据的当前状态。

  • statisticsId – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    当前正在运行的统计数据生成运行的 ID。

RefreshStatisticsIdMap(结构)

REFRESH 模式的统计数据。

字段
  • statisticsId – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    当前正在运行的统计数据生成运行的 ID。

NodeStructure(结构)

节点结构。

字段
  • count – 这是长整型,类型为:long(有符号的 64 位整数)。

    具有此特定结构的节点数量。

  • distinctOutgoingEdgeLabels – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    此特定结构中存在的不同传出边缘标签列表。

  • nodeProperties – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    此特定结构中存在的节点属性的列表。

EdgeStructure(结构)

边缘结构。

字段
  • count – 这是长整型,类型为:long(有符号的 64 位整数)。

    具有此特定结构的边缘数量。

  • edgeProperties – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    此特定结构中存在的边缘属性的列表。

SubjectStructure(结构)

主题结构。

字段
  • count – 这是长整型,类型为:long(有符号的 64 位整数)。

    此特定结构的出现次数。

  • predicates – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    此特定结构中存在的谓词的列表。

PropertygraphSummaryValueMap(结构)

属性图摘要响应的有效负载。

字段
  • graphSummary –这是一个 PropertygraphSummary 对象。

    图形摘要。

  • lastStatisticsComputationTime – 这是 SyntheticTimestamp_date_time,类型为:string(UTF-8 编码的字符串)。

    Neptune 上次计算统计数据的时间戳,采用 ISO 8601 格式。

  • version – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    此图形摘要响应的版本。

PropertygraphSummary(结构)

图形摘要 API 会返回节点和边缘标签以及属性键的只读列表,以及节点、边缘和属性的计数。请参阅属性图 (PG) 的图形摘要响应

字段
  • edgeLabels – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    图形中不同边缘标签的列表。

  • edgeProperties – 这是 LongValuedMap 对象。它是一个键值对的映射数组,其中:

        每个键都是一个字符串,类型为:string(UTF-8 编码的字符串)。

        每个值都是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同边缘属性的列表以及使用每个属性的边缘计数。

  • edgeStructures – 这是 EdgeStructure 对象数组。

    仅当请求的模式为 DETAILED 时,此字段才会出现。它包含边缘结构列表。

  • nodeLabels – 这是一个字符串,类型为:string(UTF-8 编码的字符串)。

    图形中不同节点标签的列表。

  • nodeProperties – 这是 LongValuedMap 对象。它是一个键值对的映射数组,其中:

        每个键都是一个字符串,类型为:string(UTF-8 编码的字符串)。

        每个值都是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同节点属性的数量。

  • nodeStructures – 这是 NodeStructure 对象数组。

    仅当请求的模式为 DETAILED 时,此字段才会出现。它包含节点结构的列表。

  • numEdgeLabels – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同边缘标签的数量。

  • numEdgeProperties – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同边缘属性的数量。

  • numEdges – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中的边缘数。

  • numNodeLabels – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同节点标签的数量。

  • numNodeProperties – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中不同节点属性的列表,以及使用每个属性的节点计数。

  • numNodes – 这是长整型,类型为:long(有符号的 64 位整数)。

    图形中的节点数。

  • totalEdgePropertyValues – 这是长整型,类型为:long(有符号的 64 位整数)。

    所有边缘属性的总使用次数。

  • totalNodePropertyValues – 这是长整型,类型为:long(有符号的 64 位整数)。

    所有节点属性的总使用次数。