Neptune 資料平面引擎、快速重設和一般結構 API - Amazon Neptune

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

Neptune 資料平面引擎、快速重設和一般結構 API

引擎操作:

引擎操作結構:

GetEngineStatus (動作)

        此 API 的 AWS CLI 名稱是:get-engine-status

擷取主機上圖形資料庫的狀態。

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

請求
  • 無要求參數。

回應

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

    設定為資料庫叢集上執行的 Neptune 引擎版本。若此引擎版本自發行以來已手動進行修補,則版本號碼會加上 Patch- 前綴。

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

    如果 DFE 引擎已完全啟用,則設定為 enabled,或者,如果 DFE 引擎僅與 useDFE 查詢提示設定為 true 的查詢搭配使用,則設定為 viaQueryHint (預設值)。

  • features – 它是金鑰值對的對應陣列,其中:

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

        每個值都是文件,類型為:document (與通訊協定無關的開放內容,由類似 JSON 的資料模型表示)。

    包含有關資料庫叢集上啟用之功能的狀態資訊。

  • gremlinQueryLanguageVersion 物件。

    包含叢集上可用之 Grimlin 查詢語言的相關資訊。具體而言,它包含一個版本欄位,指定引擎正在使用的目前 TinkerPop 版本。

  • labMode – 它是金鑰值對的對應陣列,其中:

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

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

    包含引擎正在使用的實驗室模式設定。

  • opencypherQueryLanguageVersion 物件。

    包含叢集上可用之 openCypher 查詢語言的相關資訊。具體而言,它包含一個版本欄位,指定引擎正在使用的目前 openCypher 版本。

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

    如果執行個體是僅供讀取複本,則設定為 reader,或者,如果執行個體是主要執行個體,則設為 writer

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

    如果有要復原的交易,則此欄位會設定為此類交易的數目。如果沒有,則欄位根本不會出現。

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

    設定為正在復原之最早交易的開始時間。如果沒有任何交易正在復原,則欄位根本不會出現。

  • settings – 它是金鑰值對的對應陣列,其中:

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

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

    包含資料庫叢集上目前設定的相關資訊。例如,包含目前的叢集查詢逾時設定 (clusterQueryTimeoutInMs)。

  • sparqlQueryLanguageVersion 物件。

    包含叢集上可用之 SPARQL 查詢語言的相關資訊。具體而言,它包含一個版本欄位,指定引擎正在使用的目前 SPARQL 版本。

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

    設定為目前伺服器程序啟動的 UTC 時間。

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

    如果執行個體沒有發生問題,則設定為 healthy。如果執行個體正在從當機復原,或是正在重新開機,而仍有從最近一次伺服器關機執行的作用中交易,則狀態會設為 recovery

ExecuteFastReset (動作)

        此 API 的 AWS CLI 名稱是:execute-fast-reset

快速重設 REST API 可讓您快速輕鬆地重設 Neptune 圖形,同時刪除其所有資料。

Neptune 快速重設是兩步驟程序。首先您會在 action 設定為 initiateDatabaseReset 的情況下呼叫 ExecuteFastReset。這會傳回一個 UUID 權杖,然後在 action 設定為 performDatabaseReset 的情況下再次呼叫 ExecuteFastReset 時會包含此權杖。請參閱使用快速重設 API 清空 Amazon Neptune 資料庫叢集

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

請求

  • action (在 CLI 中:--action) – 必要:一種動作,類型為:string (UTF-8 編碼的字串)。

    快速重設動作。下列其中一值:

    • initiateDatabaseReset – 此動作會產生實際執行快速重設所需的唯一權杖。

    • performDatabaseReset – 此動作會使用 initiateDatabaseReset 動作產生的權杖來實際執行快速重設。

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

    要啟動重設的快速重設權杖

回應

  • payloadFastResetToken 物件。

    payload 只由 initiateDatabaseReset 動作傳回,並包含要與 performDatabaseReset 動作搭配使用以進行重設的唯一權杖。

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

    status 只會針對 performDatabaseReset 動作傳回,並指示是否接受快速重設請求。

引擎操作結構:

QueryLanguageVersion (結構)

表示查詢語言版本的結構。

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

    查詢語言的版本。

FastResetToken (結構)

一種結構,其中包含用來啟動快速重設的快速重設權杖。

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

    initiateDatabaseReset 動作中由資料庫產生的 UUID,然後由 performDatabaseReset 用來重設資料庫。