Method: hive.v1.projects.catalogs.failover

Conmuta por error el catálogo a una nueva región de réplica principal.

Solicitud HTTP


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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Nombre del catálogo con el formato "projects/{projectId}/catalogs/{catalogId}"

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "primaryReplica": string,
  "validateOnly": boolean,
  "conditionalFailoverReplicationTime": string
}
Campos
primaryReplica

string

Obligatorio. Es la región que se asigna como la nueva región de réplica principal. Por ejemplo, "us-east1". Debe ser una de las regiones de réplica en la lista de réplicas del catálogo marcada como "secundaria".
validateOnly

boolean

Es opcional. Si se configura, solo valida la solicitud, pero no realiza la actualización. Se puede usar para inspeccionar el replicationTime en cualquier momento, incluso antes de realizar una conmutación por error.
conditionalFailoverReplicationTime

string (Timestamp format)

Es opcional. Si no se configura, espera a que todos los datos de la región de origen se repliquen en la nueva región principal antes de completar la conmutación por error, sin pérdida de datos (también llamada "conmutación por error parcial"). Si se configura, se realiza la conmutación por error de inmediato y se acepta la pérdida de los datos confirmados en la región de origen después de esta marca de tiempo que aún no se replicaron. Si no se replicaron los datos confirmados antes de este momento, no se realizará la conmutación por error y se mostrará un error (también llamado "conmutación por error forzada").

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Cuerpo de la respuesta

Es el mensaje de respuesta para catalogs.failover.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "replicationTime": string
}
Campos
replicationTime

string (Timestamp format)

Solo salida. Es la marca de tiempo mínima para la que se replicaron todos los metadatos de los espacios de nombres y las tablas en la región especificada como primaryReplica nueva. Es posible que algunos recursos se hayan replicado más recientemente que esta marca de tiempo. Si está vacío, significa que la réplica se acaba de crear y aún no se inicializó por completo.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.