Method: hive.v1.projects.catalogs.failover

Faça failover do catálogo para uma nova região de réplica principal.

Solicitação HTTP


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

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do catálogo no formato "projects/{projectId}/catalogs/{catalogId}"

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "primaryReplica": string,
  "validateOnly": boolean,
  "conditionalFailoverReplicationTime": string
}
Campos
primaryReplica

string

Obrigatório. A região que está sendo atribuída como a nova região da réplica principal. Por exemplo, "us-east1". Precisa ser uma das regiões de réplica na lista de réplicas do catálogo marcada como "secundária".
validateOnly

boolean

Opcional. Se definido, valida apenas a solicitação, mas não realiza a atualização. Isso pode ser usado para inspecionar o replicationTime a qualquer momento, inclusive antes de realizar um failover.
conditionalFailoverReplicationTime

string (Timestamp format)

Opcional. Se não estiver definido, aguarde a replicação de todos os dados da região de origem para a nova região principal antes de concluir o failover, sem perda de dados (também chamado de "failover suave"). Se definido, faça failover imediatamente, aceitando a perda de dados confirmados na região de origem após esse carimbo de data/hora que ainda não foram replicados. Se algum dado confirmado antes desse horário não tiver sido replicado, o failover não será realizado e um erro será retornado (também chamado de "failover forçado").

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Corpo da resposta

Mensagem de resposta para catalogs.failover.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "replicationTime": string
}
Campos
replicationTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora mínimo em que todos os namespaces e metadados de tabela foram replicados na região especificada como o novo primaryReplica. Alguns recursos podem ter sido replicados mais recentemente do que esse carimbo de data/hora. Se estiver vazio, a réplica acabou de ser criada e ainda não foi totalmente inicializada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.