Method: iceberg.v1.restcatalog.extensions.projects.catalogs.failover

將目錄容錯移轉至新的主要副本區域。

HTTP 要求

POST https://biglake.googleapis.com/iceberg/v1/restcatalog/extensions/{name=projects/*/catalogs/*}:failover

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

這是必要旗標，目錄名稱，格式為「projects/{projectId}/catalogs/{catalogId}」

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "primaryReplica": string,
  "validateOnly": boolean,
  "conditionalFailoverReplicationTime": string
}
欄位
primaryReplica

string

這是必要旗標，要指派為新主副本區域的區域。例如「us-east1」。這必須是目錄副本清單中標示為「次要」的副本區域之一。
validateOnly

boolean

選用。如果設定此值，系統只會驗證要求，但不會執行更新。您隨時可以檢查 replicationTime，包括執行容錯移轉之前。
conditionalFailoverReplicationTime

string (Timestamp format)

選用。如果未設定，請等待來源區域的所有資料複製到新的主要區域，再完成容錯移轉，這樣就不會遺失資料 (也稱為「軟性容錯移轉」)。如果設定了這個時間戳記，系統會立即進行容錯移轉，並接受來源區域中在這個時間戳記之後提交，但尚未複製的任何資料遺失。如果在此時間前提交的任何資料尚未複製，系統就不會執行容錯移轉，並會傳回錯誤 (也稱為「硬體容錯移轉」)。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

回應主體

目錄容錯移轉的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "replicationTime": string
}
欄位
replicationTime

string (Timestamp format)

僅供輸出。所有命名空間和資料表的中繼資料都已複製到指定為 newPrimaryReplica 的區域，且時間戳記不早於此值。部分資源的複製時間可能比這個時間戳記還近。如果為空白，表示備用資源剛建立，尚未完全初始化。注意：如果 Cloud Storage 複寫浮水印可用，則代表目錄中繼資料和 Cloud Storage 資料。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/bigquery
  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱Authentication Overview。