Method: hive.v1.projects.catalogs.failover

Basculer le catalogue vers une nouvelle région de réplique principale.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom du catalogue au format "projects/{projectId}/catalogs/{catalogId}".

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "primaryReplica": string,
  "validateOnly": boolean,
  "conditionalFailoverReplicationTime": string
}
Champs
primaryReplica

string

Obligatoire. Région à laquelle l'instance répliquée principale est attribuée. Par exemple, "us-east1". Il doit s'agir de l'une des régions de réplique de la liste des répliques du catalogue, marquée comme "secondaire".
validateOnly

boolean

Facultatif. Si cette option est définie, elle ne valide que la requête, mais n'effectue pas la mise à jour. Vous pouvez l'utiliser pour inspecter replicationTime à tout moment, y compris avant d'effectuer un basculement.
conditionalFailoverReplicationTime

string (Timestamp format)

Facultatif. Si cette option n'est pas définie, attendez que toutes les données de la région source soient répliquées dans la nouvelle région principale avant de terminer le basculement, sans perte de données (également appelé "basculement progressif"). Si cette option est définie, le basculement est immédiat. Toute perte de données validées dans la région source après ce code temporel et qui n'ont pas encore été répliquées est acceptée. Si des données validées avant cette heure n'ont pas été répliquées, le basculement ne sera pas effectué et une erreur sera renvoyée (également appelée "basculement forcé").

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Corps de la réponse

Message de réponse pour catalogs.failover.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "replicationTime": string
}
Champs
replicationTime

string (Timestamp format)

Uniquement en sortie. Code temporel minimal pour lequel tous les espaces de noms et les métadonnées de table ont été répliqués dans la région spécifiée comme nouvelle primaryReplica. Il est possible que certaines ressources aient été répliquées plus récemment que cet horodatage. Si ce champ est vide, cela signifie que l'instance répliquée vient d'être créée et n'a pas encore été entièrement initialisée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.