FailoverDBCluster - Amazon DocumentDB

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

FailoverDBCluster

Force le basculement d'un cluster.

En cas de basculement d'un cluster, l'une des répliques Amazon DocumentDB (instances en lecture seule) du cluster devient l'instance principale (le rédacteur du cluster).

En cas de défaillance de l'instance principale, Amazon DocumentDB bascule automatiquement vers une réplique Amazon DocumentDB, le cas échéant. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test.

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

DBClusterIdentifier

Identifiant de cluster pour lequel forcer un basculement. Ce paramètre n'est pas sensible à la casse.

Contraintes :

  • Doit correspondre à l'identifiant d'un DBCluster existant.

Type : chaîne

Obligatoire : non

TargetDBInstanceIdentifier

Nom de l'instance à promouvoir en instance principale.

Vous devez spécifier l'identifiant d'instance pour une réplique Amazon DocumentDB dans le cluster. Par exemple, mydbcluster-replica1.

Type : chaîne

Obligatoire : non

Éléments de réponse

L'élément suivant est renvoyé par le service.

DBCluster

Informations détaillées sur un cluster.

Type : objet DBCluster

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

DBClusterNotFoundFault

DBClusterIdentifierne fait pas référence à un cluster existant.

Code d’état HTTP : 404

InvalidDBClusterStateFault

L'état du cluster n'est pas valide.

Code d’état HTTP : 400

InvalidDBInstanceState

L'instance spécifiée n'est pas disponible.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :