Neptune 資料平面統計資料和圖形摘要 API - Amazon Neptune

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Neptune 資料平面統計資料和圖形摘要 API

屬性圖統計資料動作:

統計資料結構:

GetPropertygraphStatistics (動作)

        此 API 的 AWS CLI 名稱是:get-propertygraph-statistics

取得屬性圖統計資料 (Gremlin 和 openCypher)。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:GetStatisticsStatus IAM 動作。

請求
  • 無要求參數。

回應

  • payload必要:統計資料 物件。

    屬性圖資料的統計資料。

  • status必要:字串,類型為:string (UTF-8 編碼的字串)。

    請求的 HTTP 傳回碼。如果請求成功,則傳回碼為 200。如需常見錯誤的清單,請參閱 DFE 統計資料請求的常見錯誤代碼

ManagePropertygraphStatistics (動作

        此 API 的 AWS CLI 名稱是:manage-propertygraph-statistics

管理屬性圖統計資料的產生和使用。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:ManageStatistics IAM 動作。

請求

  • mode (在 CLI 中:--mode) – StatisticsAutoGenerationMode,類型為:string (UTF-8 編碼的字串)。

    統計資料產生模式。其中一個:DISABLE_AUTOCOMPUTEENABLE_AUTOCOMPUTEREFRESH,最後一個會手動觸發 DFE 統計資料產生。

回應

  • payloadRefreshStatisticsIdMap 物件。

    僅針對重新整理模式傳回此項。

  • status必要:字串,類型為:string (UTF-8 編碼的字串)。

    請求的 HTTP 傳回碼。如果請求成功,則傳回碼為 200。

DeletePropertygraphStatistics (動作)

        此 API 的 AWS CLI 名稱是:delete-propertygraph-statistics

刪除 Gremlin 和 openCypher (屬性圖) 資料的統計資料。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:DeleteStatistics IAM 動作。

請求
  • 無要求參數。

回應

  • payloadDeleteStatisticsValueMap 物件。

    刪除承載。

  • status – 字串,類型為:string (UTF-8 編碼的字串)。

    取消狀態。

  • statusCode – 整數,類型為:integer (帶正負號的 32 位元整數)。

    HTTP 回應代碼:如果刪除成功,則為 200,或者,如果沒有要刪除的統計資料,則為 204。

GetPropertygraphSummary (動作)

        此 API 的 AWS CLI 名稱是:get-propertygraph-summary

取得屬性圖的圖形摘要。

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:GetGraphSummary IAM 動作。

請求

  • mode (在 CLI 中:--mode) – GraphSummaryType,類型為:string (UTF-8 編碼的字串)。

    模式可以採取以下兩個值之一:BASIC (預設值) 和 DETAILED

回應

  • payloadPropertygraphSummaryValueMap 物件。

    包含屬性圖摘要回應的承載。

  • statusCode – 整數,類型為:integer (帶正負號的 32 位元整數)。

    請求的 HTTP 傳回碼。如果請求成功,則傳回碼為 200。

統計資料結構:

統計資料 (結構)

包含統計資料資訊。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 編碼的字串)。

    目前正在發生的統計資料產生執行的識別符。

RefreshStatisticsIdMap (結構)

REFRESH 模式的統計資料。

欄位
  • statisticsId - 這是字串,類型為:string (UTF-8 編碼的字串)。

    目前正在發生的統計資料產生執行的識別符。

NodeStructure (結構)

節點結構

欄位
  • count - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    具有此特定結構的節點數目。

  • distinctOutgoingEdgeLabels - 這是字串,類型為:string (UTF-8 編碼的字串)。

    此特定結構中存在之不同傳出邊緣標籤的清單。

  • nodeProperties - 這是字串,類型為:string (UTF-8 編碼的字串)。

    此特定結構中存在之節點屬性的清單。

EdgeStructure (結構)

邊緣結構。

欄位
  • count - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    具有此特定結構的邊緣數目。

  • edgeProperties - 這是字串,類型為:string (UTF-8 編碼的字串)。

    此特定結構中存在之邊緣屬性的清單。

SubjectStructure (結構)

主旨結構。

欄位
  • count - 這是 Long 整數,類型為: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 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同邊緣屬性的清單,以及其中使用每個屬性的邊緣計數。

  • edgeStructures - 這是 EdgeStructure 物件的陣列。

    僅在請求的模式為 DETAILED 時,此欄位才會存在。它包含邊緣結構的清單。

  • nodeLabels - 這是字串,類型為:string (UTF-8 編碼的字串)。

    圖形中不同節點標籤的清單。

  • nodeProperties - 這是 LongValuedMap 物件。它是金鑰值對的對應陣列,其中:

        每個金鑰都是字串,類型為:string (UTF-8 編碼的字串)。

        每個值都是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同節點屬性的數目。

  • nodeStructures - 這是 NodeStructure 物件的陣列。

    僅在請求的模式為 DETAILED 時,此欄位才會存在。它包含節點結構的清單。

  • numEdgeLabels - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同邊緣標籤的數目。

  • numEdgeProperties - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同邊緣屬性的數目。

  • numEdges - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中邊緣的數目。

  • numNodeLabels - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同節點標籤的數目。

  • numNodeProperties - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中不同節點屬性的清單,以及其中使用每個屬性的節點計數。

  • numNodes - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    圖形中節點的數目。

  • totalEdgePropertyValues - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    所有邊緣屬性的使用總數。

  • totalNodePropertyValues - 這是 Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    所有節點屬性的使用總數。