Method: hive.v1.projects.catalogs.failover

カタログを新しいプライマリ レプリカ リージョンにフェイルオーバーします。

HTTP リクエスト


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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。「projects/{projectId}/catalogs/{catalogId}」形式のカタログの名前

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "primaryReplica": string,
  "validateOnly": boolean,
  "conditionalFailoverReplicationTime": string
}
フィールド
primaryReplica

string

必須。新しいプライマリ レプリカ リージョンとして割り当てられるリージョン。例: 「us-east1」。これは、カタログのレプリカのリストで「セカンダリ」としてマークされているレプリカ リージョンのいずれかである必要があります。
validateOnly

boolean

省略可。設定されている場合はリクエストの検証のみが行われ、更新は実行されません。これは、フェイルオーバーを実行する前など、いつでも replicationTime を検査するために使用できます。
conditionalFailoverReplicationTime

string (Timestamp format)

省略可。設定されていない場合は、フェイルオーバーを完了する前に、ソース リージョンのすべてのデータが新しいプライマリ リージョンに複製されるまで待機します。この場合、データは失われません（ソフト フェイルオーバーとも呼ばれます）。設定されている場合、このタイムスタンプ以降にソースリージョンで commit され、まだ複製されていないデータが失われることを受け入れて、すぐにフェイルオーバーします。この時刻より前にコミットされたデータが複製されていない場合、フェイルオーバーは実行されず、エラーが返されます（ハード フェイルオーバーとも呼ばれます）。

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"。

レスポンスの本文

catalogs.failover のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "replicationTime": string
}
フィールド
replicationTime

string (Timestamp format)

出力専用。新しい primaryReplica として指定されたリージョン内のすべての Namespace とテーブル メタデータがレプリケートされた最小タイムスタンプ。一部のリソースは、このタイムスタンプよりも最近複製された可能性があります。空の場合、レプリカは作成されたばかりで、まだ完全に初期化されていません。

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 をご覧ください。