Instance Failover Groups - Get

Получает группу отработки отказа.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}?api-version=2022-02-01-preview

Параметры URI

Name In Required Type Description
failoverGroupName
path True
  • string

Имя группы отработки отказа.

locationName
path True
  • string

Имя региона, в котором находится ресурс.

resourceGroupName
path True
  • string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

subscriptionId
path True
  • string

Идентификатор подписки Azure.

api-version
query True
  • string

Версия API для использования в запросе.

Ответы

Name Type Description
200 OK

Успешно получена указанная группа отработки отказа.

Other Status Codes

Ответы на ошибки: ***

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPrimary — заданное основное поле в тексте запроса группы отработки отказа экземпляра создания или обновления является пустым или недопустимым.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidPartner — заданное поле партнеров при создании или обновлении текста запроса группы отработки отказа экземпляра является пустым или недопустимым.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestDuplicatePartner — один или несколько предоставленных серверов партнеров уже входят в группу отработки отказа экземпляра. Убедитесь, что первичный сервер и все указанные серверы партнеров являются уникальными.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidManagedInstanceRegion — предоставленный регион управляемого экземпляра партнера в теле запроса группы отработки отказа экземпляра пуст или недопустим.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount — поддерживается только один регион партнера.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestUnsupportedPairCount — поддерживается только одна пара управляемых экземпляров.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint — поле readWriteEndpoint требуется для создания или обновления запросов.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalid — текст запроса на создание или обновление группы отработки отказа экземпляра пуст или недопустим.

  • 400 InstanceFailoverGroupUpdateOrDeleteRequestOnSecondary — изменения в группе отработки отказа экземпляра не допускаются на сервере-получателе. Выполните запрос на сервере-источнике.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues — значение льготного периода для конечной точки чтения и записи должно быть неотрицательным.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues — значение периода отсрочки для группы отработки отказа экземпляра должно быть больше или равно минимальному льготному периоду минут{0}

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields — свойство failoverWithDataLossGracePeriodMinutes должно быть предоставлено, если для конечной точки чтения и записи выбрана политика отработки отказа.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy — поле failoverPolicy для конечной точки чтения и записи требуется для запросов на создание или обновление.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy — значение льготного периода не должно быть указано при выборе вручную политики отработки отказа для конечной точки чтения и записи.

  • 400 InstanceFailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified — текст запроса группы создания или обновления экземпляра отработки отказа не должен изменять свойство "{0}только для чтения".

  • 400 InstanceFailoverGroupFailoverRequestOnPrimary — запрос на отработку отказа должен быть инициирован на сервере-получателе группы отработки отказа экземпляра.

  • 400 InstanceFailoverGroupPartnerManagedInstanceFromDifferentSubscription — основной сервер и партнерский сервер группы отработки отказа находятся в разных подписках. Перекрестная подписка для серверов группы отработки отказа запрещена.

  • 400 FailoverGroupRegionMismatch — регион партнера, указанный в группе отработки отказа, должен соответствовать региону указанного управляемого экземпляра партнера.

  • 400 ServerEditionMismatch — выпуск должен совпадать с сервером-источником при создании сервера-реплики.

  • 400 DnsZoneMismatch — DNSZone на партнерском сервере отличается от DNSZone на исходном сервере. Это нарушает функциональные возможности InstanceFailoverGroup.

  • 400 InvalidTargetSubregion — целевой сервер нечитаемой вторичной базы данных не находится в парном регионе Azure для аварийного восстановления.

  • 400 GeoDrInstanceSizeMismatch — основной управляемый экземпляр и управляемый экземпляр партнера не имеют одинакового размера хранилища.

  • 400 SecurityAdalPrincipalCertExpiredError — операция не может быть завершена, так как срок действия сертификата субъекта azure Key Vault истек.

  • 400 GeoDrSecondaryInstanceNotEmpty — вторичный управляемый экземпляр содержит пользовательские базы данных. Чтобы создать группу отработки отказа экземпляра, вторичный управляемый экземпляр должен быть пустым.

  • 400 InstanceFailoverGroupIncorrectNetworkingConfiguration — неправильная конфигурация сети. Трафик репликации сервера-источника не может связаться с сервером-получателем.

  • 400 IncorrectReplicationLinkState — операция ожидает, что база данных будет находиться в ожидаемом состоянии в канале репликации.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel — указанный Key Vault URI недопустим.

  • 400 Key MaterialNotFoundOnRemoteServer — удаленный сервер не имеет доступа к материалу ключа, используемому в качестве предохранителя TDE.

  • 400 AzureKeyVaultRsaKeyNotSupported — предоставленное хранилище ключей использует неподдерживаемый размер ключа RSA или тип ключа. Поддерживаемый размер ключа RSA — 2048 или 3072, а тип ключа — RSA или RSA-HSM.

  • 400 UnableToResolveRemoteServer — не удалось устранить имя удаленного сервера-партнера из-за недопустимого имени сервера или проблем с подключением DNS.

  • 400 SameKeyUriNotFoundOnRemoteServer — сервер-получатель не содержит материал ключа из того же хранилища ключей, что и предохранитель шифрования первичного сервера с включенной автоматической сменой ключа.

  • 400 RemoteDatabaseCopyPermission — у пользователя недостаточно разрешений на создание копии базы данных на указанном сервере.

  • 400 SameKey MaterialNotFoundOnRemoteServer — сервер-получатель не содержит материала ключа предохранителя шифрования сервера-источника.

  • 400 CannotUseReservedDatabaseName — не удается использовать зарезервированное имя базы данных в этой операции.

  • 400 InvalidFailoverGroupRegion — серверы, указанные в группе отработки отказа экземпляров, должны находиться в разных регионах для обеспечения изоляции.

  • 400 InstanceFailoverGroupDoesNotExist — группа отработки отказа не существует на сервере.

  • 400 InstanceFailoverGroupNotSecondary — отработка отказа не может быть инициирована с сервера-источника в группе отработки отказа экземпляра.

  • 400 InvalidServerName — указано недопустимое имя сервера.

  • 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ юникода.

  • 400 TokenTooLong — предоставленный маркер слишком длинный.

  • 400 AzureKeyVaultKeyDisabled — не удалось завершить операцию на сервере, так как ключ Azure Key Vault отключен.

  • 400 AzureKeyVaultInvalidExpirationDate — операция не может быть завершена, так как срок действия ключа в Azure Key Vault недопустим.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty — операция не может быть завершена, так как URI Key Vault Azure имеет значение NULL или пуст.

  • 400 InvalidSku — пользователь указал недопустимый номер SKU.

  • 400 InvalidAddSecondaryPermission — у пользователя нет достаточных разрешений для добавления вторичной базы данных на указанный сервер.

  • 400 ServerNotFound — запрошенный сервер не найден.

  • 400 AzureKeyVaultNoServerIdentity — удостоверение сервера настроено неправильно.

  • 400 AzureKeyVaultInvalidUri — недопустимый ответ от Azure Key Vault. Используйте допустимый URI Key Vault Azure.

  • 400 AzureKeyVaultMissingPermissions — сервер не имеет необходимых разрешений на Key Vault Azure.

  • 400 SecurityAzureKeyVaultInvalidKeyName — не удалось завершить операцию из-за недопустимого имени ключа сервера.

  • 400 PlannedFailoverTimedOutForDatabase — пользователь вызвал плановую отработку отказа, истекло время ожидания, и определенная база данных, как представляется, виновата.

  • 400 PlannedFailoverTimedOut — пользователь вызвал плановую отработку отказа и истекло время ожидания при попытке связаться со службой управления партнерами.

  • 400 AdalGenericError — не удалось завершить операцию, так как обнаружена ошибка Azure Active Directory.

  • 400 GeoReplicationDatabaseNotSecondary — операция ожидает, что база данных будет целевым объектом репликации.

  • 400 AdalServicePrincipalNotFound — не удалось завершить операцию, так как обнаружена ошибка субъекта-службы библиотеки Azure Active Directory.

  • 400 AzureKeyVaultMalformedVaultUri — указанный Key Vault URI недопустим.

  • 400 FeatureDisabledOnSelectedEdition — пользователь попытался использовать функцию, которая отключена в текущем выпуске базы данных.

  • 404 ResourceNotFound — запрошенный ресурс не найден.

  • 404 SourceDatabaseNotFound — база данных-источник не существует.

  • 404 ServerNotInSubscription — указанный сервер не существует в указанной подписке.

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

  • 405 UnsupportedReplicationOperation — в базе данных была инициирована неподдерживаемая операция репликации.

  • 409 ManagedInstanceHasHybridLink — пользователь пытался инициировать операцию, которая не поддерживается при настройке гибридной связи управляемого экземпляра.

  • 409 RemoteDatabaseExists — имя целевой базы данных уже существует на целевом сервере.

  • 409 ConflictingServerOperation — операция в настоящее время выполняется для сервера.

  • 409 SubscriptionDisabled — подписка отключена.

  • 409 InstanceFailoverGroupAlreadyExists — группа отработки отказа уже существует на данном сервере.

  • 409 InstanceFailoverGroupBusy — группа отработки отказа экземпляра занята другой операцией.

  • 409 GeoReplicationCannotBecomePrimaryDuringUndo — пользователь пытался выполнить отработку отказа или принудительно завершить геосвязь, пока дополнительный объект находится в состоянии, где он может быть физически не согласован и поэтому не может ввести основную роль.

  • 409 InstanceFailoverGroupDnsRecordInUse — для запрошенной конечной точки существует повторяющаяся запись DNS.

  • 409 ServerKeyNameAlreadyExists — ключ сервера уже существует на сервере.

  • 409 ServerKeyUriAlreadyExists — URI ключа сервера уже существует на сервере.

  • 409 ServerKeyDoesNotExists. Ключ сервера не существует.

  • 409 InvalidFailoverGroupName — указано недопустимое имя группы отработки отказа экземпляра.

  • 409 UpdateSloInProgress — пользователь пытался инициировать несовместимую операцию во время выполнения обновления SLO.

  • 409 AzureKeyVaultKeyNameNotFound — не удалось выполнить операцию, так как имя ключа azure Key Vault не существует.

  • 409 AzureKeyVaultKeyInUse — ключ в настоящее время используется сервером.

  • 409 ConflictingSystemOperationInProgress — выполняется операция обслуживания системы в базе данных, а дальнейшие операции должны ждать завершения.

  • 409 InvalidOperationForDatabaseNotInReplicationRelationship — операция заполнения репликации была выполнена в базе данных, которая уже находится в связи репликации.

  • 409 InvalidDatabaseStateForOperation — операция не разрешена в базе данных в текущем состоянии репликации.

  • 409 DuplicateGeoDrRelation — базы данных уже находятся в связи репликации. Это повторяющийся запрос.

  • 429 SubscriptionTooManyCreateUpdateRequests — запросы за пределами максимального числа запросов, которые могут обрабатываться доступными ресурсами.

  • 429 SubscriptionTooManyRequests — запросы за пределами максимального числа запросов, которые могут обрабатываться доступными ресурсами.

  • 503 TooManyRequests — запросы за пределами максимального числа запросов, которые могут обрабатываться доступными ресурсами.

  • 503 AzureKeyVaultConnectionFailed — не удалось выполнить операцию на сервере, так как попытки подключения к Azure Key Vault завершились сбоем

  • 503 AzureKeyVaultGenericConnectionError — не удалось завершить операцию, так как при попытке получить сведения о Key Vault произошла ошибка.

  • 504 RequestTimeout — запрос на обслуживание превысил допустимое время ожидания.

Примеры

Get failover group

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups/failover-group-test?api-version=2022-02-01-preview

Sample Response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/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 West",
        "replicationRole": "Secondary"
      }
    ],
    "managedInstancePairs": [
      {
        "primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
        "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
      }
    ]
  }
}

Определения

InstanceFailoverGroup

Группа отработки отказа экземпляра.

InstanceFailoverGroupReadOnlyEndpoint

Конечная точка группы отработки отказа только для чтения.

InstanceFailoverGroupReadWriteEndpoint

Конечная точка чтения и записи экземпляра группы отработки отказа.

InstanceFailoverGroupReplicationRole

Локальная роль репликации экземпляра группы отработки отказа.

ManagedInstancePairInfo

Пары управляемых экземпляров в группе отработки отказа.

PartnerRegionInfo

Сведения о регионе партнера для группы отработки отказа.

ReadOnlyEndpointFailoverPolicy

Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

ReadWriteEndpointFailoverPolicy

Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если параметр failoverPolicy имеет значение Automatic, требуется отработка отказаWithDataLossGracePeriodMinutes.

InstanceFailoverGroup

Группа отработки отказа экземпляра.

Name Type Description
id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.managedInstancePairs

Список пар управляемых экземпляров в группе отработки отказа.

properties.partnerRegions

Сведения о регионе партнера для группы отработки отказа.

properties.readOnlyEndpoint

Конечная точка группы отработки отказа только для чтения.

properties.readWriteEndpoint

Конечная точка чтения и записи экземпляра группы отработки отказа.

properties.replicationRole

Локальная роль репликации экземпляра группы отработки отказа.

properties.replicationState
  • string

Состояние репликации экземпляра группы отработки отказа.

type
  • string

Тип ресурса.

InstanceFailoverGroupReadOnlyEndpoint

Конечная точка группы отработки отказа только для чтения.

Name Type Description
failoverPolicy

Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

InstanceFailoverGroupReadWriteEndpoint

Конечная точка чтения и записи экземпляра группы отработки отказа.

Name Type Description
failoverPolicy

Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если параметр failoverPolicy имеет значение Automatic, требуется отработка отказаWithDataLossGracePeriodMinutes.

failoverWithDataLossGracePeriodMinutes
  • integer

Льготный период перед отработкой отказа с потерей данных предпринимается для конечной точки чтения и записи. Если параметр failoverPolicy имеет значение Automatic, требуется отработка отказаWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

Локальная роль репликации экземпляра группы отработки отказа.

Name Type Description
Primary
  • string
Secondary
  • string

ManagedInstancePairInfo

Пары управляемых экземпляров в группе отработки отказа.

Name Type Description
partnerManagedInstanceId
  • string

Идентификатор Управляемый экземпляр партнера в паре.

primaryManagedInstanceId
  • string

Идентификатор первичного Управляемый экземпляр в паре.

PartnerRegionInfo

Сведения о регионе партнера для группы отработки отказа.

Name Type Description
location
  • string

Географическое расположение управляемых экземпляров партнера.

replicationRole

Роль репликации управляемых экземпляров партнера.

ReadOnlyEndpointFailoverPolicy

Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

Name Type Description
Disabled
  • string
Enabled
  • string

ReadWriteEndpointFailoverPolicy

Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если параметр failoverPolicy имеет значение Automatic, требуется отработка отказаWithDataLossGracePeriodMinutes.

Name Type Description
Automatic
  • string
Manual
  • string