Instance Failover Groups - Failover

Przechodzi w tryb failover z bieżącego podstawowego wystąpienia zarządzanego do tego wystąpienia zarządzanego.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/failover?api-version=2021-11-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
failoverGroupName
path True

string

Nazwa grupy trybu failover.

locationName
path True

string

Nazwa regionu, w którym znajduje się zasób.

resourceGroupName
path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.

subscriptionId
path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.

api-version
query True

string

Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa Typ Opis
200 OK

InstanceFailoverGroup

Pomyślnie przełączono w tryb failover.

202 Accepted

Zaakceptowano

Other Status Codes

Odpowiedzi na błędy: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary — dane pole podstawowe w treści żądania tworzenia lub aktualizowania grupy trybu failover wystąpienia jest puste lub nieprawidłowe.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner — podane pole partnerów w treści żądania tworzenia lub aktualizowania grupy trybu failover wystąpienia jest puste lub nieprawidłowe.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner — co najmniej jeden z dostępnych serwerów partnerskich jest już częścią grupy trybu failover wystąpienia. Upewnij się, że serwer podstawowy i wszystkie te serwery partnerskie są unikatowe.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion — podany region wystąpienia zarządzanego partnera w treści żądania grupy trybu failover wystąpienia jest pusty lub nieprawidłowy.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount — obsługiwany jest tylko jeden region partnera.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount — obsługiwana jest tylko jedna para wystąpienia zarządzanego.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint — pole readWriteEndpoint jest wymagane dla żądań tworzenia lub aktualizowania.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid — treść żądania tworzenia lub aktualizowania grupy trybu failover wystąpienia jest pusta lub nieprawidłowa.

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary — modyfikacje grupy trybu failover wystąpienia nie są dozwolone na serwerze pomocniczym. Wykonaj żądanie na serwerze podstawowym.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues — wartość okresu prolongaty dla punktu końcowego odczytu i zapisu musi być nieujemna.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues — wartość okresu prolongaty dla grupy trybu failover wystąpienia musi być większa lub równa minimalnemu okresowi prolongaty "{0}" minut

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields — właściwość failoverWithDataLossGracePeriodMinutes musi zostać podana, gdy dla punktu końcowego odczytu i zapisu wybrano zasady trybu failover Automatycznie.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy — pole failoverPolicy dla punktu końcowego odczytu i zapisu jest wymagane do tworzenia lub aktualizowania żądań.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy — wartość okresu prolongaty nie powinna być podana, gdy dla punktu końcowego odczytu i zapisu wybrano zasady trybu failover.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified — treść żądania tworzenia lub aktualizowania grupy trybu failover wystąpienia nie powinna modyfikować właściwości tylko do odczytu "{0}".

  • 400 InstanceFailoverGroupFailoverRequestOnPrimary — żądanie trybu failover powinno zostać zainicjowane na pomocniczym serwerze grupy trybu failover wystąpienia.

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription — serwer podstawowy i serwer partnerski grupy trybu failover pochodzą z różnych subskrypcji. Subskrypcja między serwerami grupy trybu failover jest niedozwolona.

  • 400 FailoverGroupRegionMismatch — region partnerski określony w grupie trybu failover musi odpowiadać regionowi wskazanego wystąpienia zarządzanego partnera.

  • 400 ServerEditionMismatch — wersja musi być taka sama jak serwer podstawowy podczas tworzenia serwera repliki.

  • 400 DnsZoneMismatch — strefa DNSZone na serwerze partnerskim różni się od strefy DNSZone na serwerze źródłowym. Spowoduje to uszkodzenie funkcji InstanceFailoverGroup.

  • 400 InvalidTargetSubregion — docelowy serwer pomocniczego, który nie jest czytelny, nie znajduje się w sparowanym regionie świadczenia usługi Azure.

  • 400 GeoDrInstanceSizeMismatch — podstawowe wystąpienie zarządzane i wystąpienie zarządzane partnera nie mają tego samego rozmiaru magazynu.

  • 400 SecurityAdalPrincipalCertExpiredError — nie można ukończyć operacji, ponieważ certyfikat główny usługi Azure Key Vault wygasł.

  • 400 GeoDrSecondaryInstanceNotEmpty — pomocnicze wystąpienie zarządzane ma bazy danych użytkowników. Aby utworzyć grupę trybu failover wystąpienia, pomocnicze wystąpienie zarządzane musi być puste.

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration — konfiguracja sieci jest nieprawidłowa. Ruch replikacji serwera podstawowego nie może uzyskać dostępu do serwera pomocniczego.

  • 400 IncorrectReplicationLinkState — operacja oczekuje, że baza danych będzie w oczekiwanym stanie linku replikacji.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel — podany identyfikator URI Key Vault jest nieprawidłowy.

  • 400 KeyMaterialNotFoundOnRemoteServer — serwer zdalny nie ma dostępu do materiału klucza używanego jako funkcja ochrony TDE.

  • 400 AzureKeyVaultRsaKeyNotSupported — podany magazyn kluczy używa nieobsługiwanego rozmiaru klucza RSA lub typu klucza. Obsługiwany rozmiar klucza RSA to 2048 lub 3072, a typ klucza to RSA lub RSA-HSM.

  • 400 UnableToResolveRemoteServer — nie można rozpoznać nazwy serwera zdalnego partnera z powodu problemów z nieprawidłową nazwą serwera lub łącznością DNS.

  • 400 SameKeyUriNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza z tego samego magazynu kluczy, co funkcja ochrony szyfrowania serwera podstawowego z włączonym automatycznym obracania klucza.

  • 400 RemoteDatabaseCopyPermission — użytkownik nie ma wystarczających uprawnień do utworzenia kopii bazy danych na określonym serwerze.

  • 400 SameKeyMaterialNotFoundOnRemoteServer — serwer pomocniczy nie ma materiału klucza ochrony szyfrowania serwera podstawowego.

  • 400 CannotUseReservedDatabaseName — nie można użyć nazwy zarezerwowanej bazy danych w tej operacji.

  • 400 InvalidFailoverGroupRegion — serwery określone w grupie trybu failover wystąpienia muszą znajdować się w różnych regionach, aby zapewnić izolację.

  • 400 InstanceFailoverGroupDoesNotExist — grupa trybu failover nie istnieje na serwerze.

  • 400 InstanceFailoverGroupNotSecondary — nie można zainicjować trybu failover z serwera podstawowego w grupie trybu failover wystąpienia.

  • 400 InvalidServerName — podano nieprawidłową nazwę serwera.

  • 400 InvalidIdentifier — identyfikator zawiera wartość NULL lub nieprawidłowy znak Unicode.

  • 400 TokenTooLong — podany token jest za długi.

  • 400 AzureKeyVaultKeyDisabled — nie można ukończyć operacji na serwerze, ponieważ klucz usługi Azure Key Vault jest wyłączony.

  • 400 AzureKeyVaultInvalidExpirationDate — nie można ukończyć operacji, ponieważ data wygaśnięcia klucza usługi Azure Key Vault jest nieprawidłowa.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty — nie można ukończyć operacji, ponieważ identyfikator URI usługi Azure Key Vault ma wartość null lub jest pusty.

  • 400 InvalidSku — użytkownik określił nieprawidłową jednostkę SKU.

  • 400 InvalidAddSecondaryPermission — użytkownik nie ma wystarczających uprawnień do dodawania pomocniczego na określonym serwerze.

  • 400 ServerNotFound — nie można odnaleźć żądanego serwera.

  • 400 AzureKeyVaultNoServerIdentity — tożsamość serwera nie jest poprawnie skonfigurowana.

  • 400 AzureKeyVaultInvalidUri — nieprawidłowa odpowiedź z usługi Azure Key Vault. Użyj prawidłowego identyfikatora URI usługi Azure Key Vault.

  • 400 AzureKeyVaultMissingPermissions — na serwerze brakuje wymaganych uprawnień w usłudze Azure Key Vault.

  • 400 SecurityAzureKeyVaultInvalidKeyName — nie można ukończyć operacji z powodu nieprawidłowej nazwy klucza serwera.

  • 400 PlannedFailoverTimedOutForDatabase — użytkownik wywołał planowane przełączanie awaryjne, upłynął limit czasu, a konkretna baza danych wydaje się być winna.

  • 400 PlannedFailoverTimedOut — użytkownik wywołał planowane przełączanie awaryjne i upłynął limit czasu podczas próby skontaktowania się z usługą zarządzania partnerem.

  • 400 AdalGenericError — nie można ukończyć operacji, ponieważ wystąpił błąd usługi Azure Active Directory.

  • 400 GeoReplicationDatabaseNotSecondary — operacja oczekuje, że baza danych będzie obiektem docelowym replikacji.

  • 400 AdalServicePrincipalNotFound — nie można ukończyć operacji, ponieważ napotkano błąd jednostki usługi biblioteki Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri — podany identyfikator URI Key Vault jest nieprawidłowy.

  • 400 FeatureDisabledOnSelectedEdition — użytkownik próbował użyć funkcji wyłączonej w bieżącej wersji bazy danych.

  • 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje.

  • 404 ResourceNotFound — żądany zasób nie został znaleziony.

  • 404 OperationIdNotFound — operacja o identyfikatorze nie istnieje.

  • 404 SourceDatabaseNotFound — źródłowa baza danych nie istnieje.

  • 404 ServerNotInSubscription — określony serwer nie istnieje w określonej subskrypcji.

  • 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

  • 405 UnsupportedReplicationOperation — zainicjowano nieobsługiwaną operację replikacji w bazie danych.

  • 409 OperationCancelled — operacja została anulowana przez użytkownika.

  • 409 Operacja przerwana — nie można ukończyć operacji na zasobie, ponieważ została przerwana przez inną operację na tym samym zasobie.

  • 409 ManagedInstanceHasHybridLink — użytkownik próbował zainicjować operację, która nie jest obsługiwana, gdy wystąpienie zarządzane ma skonfigurowane łącze hybrydowe.

  • 409 RemoteDatabaseExists — nazwa docelowej bazy danych już istnieje na serwerze docelowym.

  • 409 ConflictingServerOperation — operacja jest obecnie w toku dla serwera.

  • 409 SubscriptionDisabled — subskrypcja jest wyłączona.

  • 409 InstanceFailoverGroupAlreadyExists — grupa trybu failover już istnieje na danym serwerze.

  • 409 InstanceFailoverGroupBusy — grupa trybu failover wystąpienia jest zajęta inną operacją.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo — użytkownik próbował przejść w tryb failover lub wymusić przerwanie łącza geograficznego, gdy pomocnicza jest w stanie, w którym może nie być fizycznie spójna i dlatego nie może wprowadzić roli głównej.

  • 409 InstanceFailoverGroupDnsRecordInUse — istnieje zduplikowany rekord DNS dla żądanego punktu końcowego.

  • 409 ServerKeyNameAlreadyExists — klucz serwera już istnieje na serwerze.

  • 409 ServerKeyUriAlreadyExists — identyfikator URI klucza serwera już istnieje na serwerze.

  • 409 ServerKeyDoesNotExists — klucz serwera nie istnieje.

  • 409 InvalidFailoverGroupName — podano nieprawidłową nazwę grupy trybu failover wystąpienia.

  • 409 UpdateSloInProgress — użytkownik próbował zainicjować niezgodną operację, gdy aktualizacja SLO była w toku.

  • 409 AzureKeyVaultKeyNameNotFound — nie można ukończyć operacji, ponieważ nazwa klucza usługi Azure Key Vault nie istnieje.

  • 409 AzureKeyVaultKeyInUse — klucz jest obecnie używany przez serwer.

  • 409 ConflictingSystemOperationInProgress — trwa operacja konserwacji systemu w bazie danych i dalsze operacje muszą czekać, aż zostanie ukończona.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship — operacja rozmieszczania replikacji została wykonana w bazie danych, która jest już w relacji replikacji.

  • 409 InvalidDatabaseStateForOperation — operacja nie jest dozwolona w bazie danych w bieżącym stanie replikacji.

  • 409 DuplicateGeoDrRelation — bazy danych są już w relacji replikacji. Jest to zduplikowane żądanie.

  • 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

  • 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby.

  • 429 SubscriptionTooManyCreateUpdateRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

  • 429 SubscriptionTooManyRequests — żądania wykraczające poza maksymalną liczbę żądań, które mogą być przetwarzane przez dostępne zasoby.

  • 500 OperationTimedOut — upłynął limit czasu operacji i automatycznie wycofano. Ponów próbę wykonania operacji.

  • 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

  • 503 TooManyRequests — żądania wykraczające poza maksymalne żądania, które mogą być przetwarzane przez dostępne zasoby.

  • 503 AzureKeyVaultConnectionFailed — nie można ukończyć operacji na serwerze, ponieważ próby nawiązania połączenia z usługą Azure Key Vault zakończyły się niepowodzeniem

  • 503 AzureKeyVaultGenericConnectionError — nie można ukończyć operacji, ponieważ wystąpił błąd podczas próby pobrania Key Vault informacji.

  • 504 RequestTimeout — żądanie usługi przekroczyło dozwolony limit czasu.

Przykłady

Planned failover of a failover group

Sample Request

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan West/instanceFailoverGroups/failover-group-test-3/failover?api-version=2021-11-01

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroups/failover-group-test-3",
  "name": "failover-group-test-3",
  "type": "Microsoft.Sql/locations/instanceFailoverGroups",
  "properties": {
    "readWriteEndpoint": {
      "failoverPolicy": "Automatic",
      "failoverWithDataLossGracePeriodMinutes": 480
    },
    "readOnlyEndpoint": {
      "failoverPolicy": "Disabled"
    },
    "replicationRole": "Primary",
    "replicationState": "CATCH_UP",
    "partnerRegions": [
      {
        "location": "Japan East",
        "replicationRole": "Secondary"
      }
    ],
    "managedInstancePairs": [
      {
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance",
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance"
      }
    ]
  }
}

Definicje

Nazwa Opis
InstanceFailoverGroup

Grupa trybu failover wystąpienia.

InstanceFailoverGroupReadOnlyEndpoint

Punkt końcowy grupy trybu failover tylko do odczytu.

InstanceFailoverGroupReadWriteEndpoint

Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.

InstanceFailoverGroupReplicationRole

Rola replikacji lokalnej wystąpienia grupy trybu failover.

ManagedInstancePairInfo

Pary wystąpień zarządzanych w grupie trybu failover.

PartnerRegionInfo

Informacje o regionie partnerskim dla grupy trybu failover.

ReadOnlyEndpointFailoverPolicy

Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.

ReadWriteEndpointFailoverPolicy

Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

InstanceFailoverGroup

Grupa trybu failover wystąpienia.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

name

string

Nazwa zasobu.

properties.managedInstancePairs

ManagedInstancePairInfo[]

Lista par wystąpień zarządzanych w grupie trybu failover.

properties.partnerRegions

PartnerRegionInfo[]

Informacje o regionie partnerskim dla grupy trybu failover.

properties.readOnlyEndpoint

InstanceFailoverGroupReadOnlyEndpoint

Punkt końcowy grupy trybu failover tylko do odczytu.

properties.readWriteEndpoint

InstanceFailoverGroupReadWriteEndpoint

Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.

properties.replicationRole

InstanceFailoverGroupReplicationRole

Rola replikacji lokalnej wystąpienia grupy trybu failover.

properties.replicationState

string

Stan replikacji wystąpienia grupy trybu failover.

type

string

Typ zasobu.

InstanceFailoverGroupReadOnlyEndpoint

Punkt końcowy grupy trybu failover tylko do odczytu.

Nazwa Typ Opis
failoverPolicy

ReadOnlyEndpointFailoverPolicy

Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.

InstanceFailoverGroupReadWriteEndpoint

Punkt końcowy odczytu i zapisu wystąpienia grupy trybu failover.

Nazwa Typ Opis
failoverPolicy

ReadWriteEndpointFailoverPolicy

Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

failoverWithDataLossGracePeriodMinutes

integer

Okres prolongaty przed przejściem w tryb failover z próbą utraty danych dla punktu końcowego odczytu i zapisu. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Rola replikacji lokalnej wystąpienia grupy trybu failover.

Nazwa Typ Opis
Primary

string

Secondary

string

ManagedInstancePairInfo

Pary wystąpień zarządzanych w grupie trybu failover.

Nazwa Typ Opis
partnerManagedInstanceId

string

Identyfikator wystąpienia zarządzanego partnera w parze.

primaryManagedInstanceId

string

Identyfikator podstawowego wystąpienia zarządzanego w parze.

PartnerRegionInfo

Informacje o regionie partnerskim dla grupy trybu failover.

Nazwa Typ Opis
location

string

Lokalizacja geograficzna wystąpień zarządzanych partnera.

replicationRole

InstanceFailoverGroupReplicationRole

Rola replikacji wystąpień zarządzanych przez partnera.

ReadOnlyEndpointFailoverPolicy

Zasady trybu failover punktu końcowego tylko do odczytu dla grupy trybu failover.

Nazwa Typ Opis
Disabled

string

Enabled

string

ReadWriteEndpointFailoverPolicy

Zasady trybu failover punktu końcowego odczytu i zapisu dla grupy trybu failover. Jeśli tryb failoverPolicy jest automatyczny, wymagany jest tryb failoverWithDataLossGracePeriodMinutes.

Nazwa Typ Opis
Automatic

string

Manual

string