FailoverDBCluster
Força um failover para um cluster de banco de dados.
Um failover para um cluster promove uma das réplicas do Amazon DocumentDB (instâncias somente leitura) no cluster para ser a instância primária (o gravador do cluster).
Se a instância primária falhar, o Amazon DocumentDB fará o failover automaticamente para uma réplica do Amazon DocumentDB, se houver uma. Você pode forçar um failover quando quiser simular uma falha de uma instância principal para testes.
Parâmetros de Solicitação
Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.
- DBClusterIdentifier
-
Um identificador de cluster para forçar um failover. Esse parâmetro não diferencia maiúsculas de minúsculas.
Restrições:
-
Deve corresponder ao identificador de um
DBClusterexistente.
Tipo: String
Obrigatório: Não
-
- TargetDBInstanceIdentifier
-
O nome da instância a ser promovida a instância principal.
Você deve especificar o identificador da instância para uma réplica de leitura do Amazon DocumentDB no cluster. Por exemplo,
mydbcluster-replica1.Tipo: String
Obrigatório: Não
Elementos de Resposta
O elemento a seguir é retornado pelo serviço.
- DBCluster
-
Informações detalhadas sobre um cluster.
Tipo: objeto DBCluster
Erros
Para obter informações sobre os erros comuns a todas ações, consulte Erros comuns.
- DBClusterNotFoundFault
-
DBClusterIdentifiernão se refere a um cluster existente.Código de Status HTTP: 404
- InvalidDBClusterStateFault
-
O cluster não está em um estado válido.
Código de Status HTTP: 400
- InvalidDBInstanceState
-
A instância especificada não está no estado disponível.
Código de Status HTTP: 400
Consulte Também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
