Поделиться через

Failover Groups - List By Server

  • Ссылка
Служба:
SQL Database
Версия API:
2023-08-01

Выводит список групп отработки отказа на сервере.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/failoverGroups?api-version=2023-08-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName
 path True

string

Имя сервера, содержащего группу отработки отказа.
subscriptionId
 path True

string

Идентификатор подписки, идентифицирующий подписку Azure.
api-version
 query True

string

Версия API, используемая для запроса.

Ответы

Имя Тип Описание
200 OK

FailoverGroupListResult

Успешно извлечены группы отработки отказа.
Other Status Codes

ErrorResponse

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

  • 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases — идентификаторы предоставленных баз данных неправильно созданы идентификаторами ресурсов базы данных. Пример правильного форматирования см. в https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

  • 400 FailoverGroupCreateOrUpdateRequestInvalidPartner — заданное поле партнеров в тексте запроса группы отработки отказа пусто или недопустимо. Укажите допустимое значение этого поля. Примеры правильно отформатированных запросов см. в https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

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

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

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount — поддерживается только один сервер партнера для группы отработки отказа. Измените запрос соответствующим образом. Примеры допустимых запросов см. в https://docs.microsoft.com/en-us/rest/api/sql/failovergroups/createorupdate

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

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

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

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

  • 400 FailoverGroupCreateOrUpdateRequestLessThanMinimumGracePeriodValues — льготный период для группы отработки отказа должен быть больше или равен минимальному льготному периоду "{0}' минут

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

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

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

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

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

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

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

  • 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCountForStandby — только один сервер партнера для группы отработки отказа поддерживается для резервного режима secondaryType. Измените запрос соответствующим образом.

  • 400 InvalidAddSecondaryPermission . Пользователь не имеет достаточного разрешения на добавление вторичного объекта на указанном сервере.

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

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

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

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

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

  • 400 PartnerServerNotCompatible — пользователь пытается скопировать базу данных с сервера SAWA V1 на сервер Sterling или наоборот.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 400 DatabaseInFailoverGroupNotPrimary — ссылка GeoDR для базы данных уже существует, но ее роль не является первичной или не является непрерывной ссылкой копирования.

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

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

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

  • 400 FailToAddDbWithTableAuditingToFailoverGroup — база данных с включенным аудитом таблиц не будет доступна через конечную точку группы отработки отказа.

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

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

  • 400 LimitOfFailoverGroupsPerServerExceed. Создание новой группы отработки отказа превысит допустимое количество групп отработки отказа на сервер.

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

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

  • 400 SameKey MaterialNotFoundOnRemoteServer — вторичный сервер не содержит ключевого материала защиты шифрования первичного сервера.

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

  • 400 GeoReplicaLimitReached — достигнуто ограничение репликации для каждой реплики.

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

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

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

  • 400 SecurityAzureKeyVaultGeoChainError — создание вторичной (процесса, известной как цепочка) не поддерживается при включении прозрачного шифрования данных с помощью Azure Key Vault (BYOK).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 409 FailoverGroupAlreadyExists — группа отработки отказа уже существует на определенном сервере. Используйте другое имя группы отработки отказа.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • 503 DatabaseUnavailable — операция завершилась ошибкой, так как база данных недоступна.

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

Примеры

List failover group

Образец запроса

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups?api-version=2023-08-01

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test",
      "name": "failover-group-test",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-primary-server/failoverGroups/failover-group-test-2",
      "name": "failover-group-test-2",
      "type": "Microsoft.Sql/servers/failoverGroups",
      "location": "Japan East",
      "properties": {
        "readWriteEndpoint": {
          "failoverPolicy": "Automatic",
          "failoverWithDataLossGracePeriodMinutes": 480
        },
        "readOnlyEndpoint": {
          "failoverPolicy": "Disabled",
          "targetServer": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server"
        },
        "replicationRole": "Primary",
        "replicationState": "CATCH_UP",
        "partnerServers": [
          {
            "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/failover-group-secondary-server",
            "location": "Japan West",
            "replicationRole": "Secondary"
          }
        ],
        "databases": []
      }
    }
  ]
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
FailoverGroup

Группа отработки отказа.
FailoverGroupDatabasesSecondaryType

Вторичный тип баз данных на сервере партнера.
FailoverGroupListResult

Список групп отработки отказа.
FailoverGroupReadOnlyEndpoint

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

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

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

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

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

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

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

FailoverGroup

Object

Группа отработки отказа.

Имя Тип Описание
id

string

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

string

Расположение ресурса.
name

string

Имя ресурса.
properties.databases

string[] (arm-id)

Список баз данных в группе отработки отказа.
properties.partnerServers

PartnerInfo[]

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

FailoverGroupReadOnlyEndpoint

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

FailoverGroupReadWriteEndpoint

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

FailoverGroupReplicationRole

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

string

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

FailoverGroupDatabasesSecondaryType

Вторичный тип баз данных на сервере партнера.
tags

object

Теги ресурсов.
type

string

Тип ресурса.

FailoverGroupDatabasesSecondaryType

Перечисление

Вторичный тип баз данных на сервере партнера.

Значение Описание
Geo
Standby

FailoverGroupListResult

Object

Список групп отработки отказа.

Имя Тип Описание
nextLink

string

Ссылка на получение следующей страницы результатов.
value

FailoverGroup[]

Массив результатов.

FailoverGroupReadOnlyEndpoint

Object

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

Имя Тип Описание
failoverPolicy

ReadOnlyEndpointFailoverPolicy

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

string (arm-id)

Целевой сервер партнера, на который указывает конечная точка только для чтения.

FailoverGroupReadWriteEndpoint

Object

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

Имя Тип Описание
failoverPolicy

ReadWriteEndpointFailoverPolicy

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

integer (int32)

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

FailoverGroupReplicationRole

Перечисление

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

Значение Описание
Primary
Secondary

PartnerInfo

Object

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

Имя Тип Описание
id

string (arm-id)

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

string

Географическое расположение сервера партнера.
replicationRole

FailoverGroupReplicationRole

Роль репликации сервера-партнера.

ReadOnlyEndpointFailoverPolicy

Перечисление

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

Значение Описание
Disabled
Enabled

ReadWriteEndpointFailoverPolicy

Перечисление

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

Значение Описание
Automatic
Manual