Instance Failover Groups - List By Location

Service:

SQL Database

API Version:

2021-11-01

Перечисляет группы отработки отказа в расположении.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
locationName	path	True	string	Имя региона, в котором находится ресурс.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.

Ответы

Имя	Тип	Описание
200 OK	InstanceFailoverGroupListResult	Группы отработки отказа успешно получены.
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 — не удалось выполнить операцию, так как срок действия сертификата субъекта Key Vault Azure истек. 400 GeoDrSecondaryInstanceNotEmpty — вторичный управляемый экземпляр имеет пользовательские базы данных. Чтобы создать группу отработки отказа экземпляров, вторичный управляемый экземпляр должен быть пустым. 400 InstanceFailoverGroupIncorrectNetworkingConfiguration — неправильная конфигурация сети. Трафик репликации сервера-источника не может достичь сервера-получателя. 400 IncorrectReplicationLinkState — операция ожидает, что база данных будет находиться в ожидаемом состоянии по каналу репликации. 400 SecurityInvalidAzureKeyVaultRecoveryLevel — указанный URI Key Vault недопустим. 400 KeyMaterialNotFoundOnRemoteServer — удаленный сервер не имеет доступа к материалу ключа, используемому в качестве предохранителя TDE. 400 AzureKeyVaultRsaKeyNotSupported — предоставленное хранилище ключей использует неподдерживаемый размер ключа RSA или тип ключа. Поддерживаемый размер ключа RSA — 2048 или 3072, а тип ключа — RSA или RSA-HSM. 400 UnableToResolveRemoteServer — не удалось разрешить имя удаленного сервера-партнера из-за недопустимого имени сервера или проблем с подключением к DNS. 400 SameKeyUriNotFoundOnRemoteServer — сервер-получатель не имеет материала ключа из того же хранилища ключей, что и предохранитель шифрования основного сервера с включенной автоматической сменой ключей. 400 RemoteDatabaseCopyPermission — пользователь не имеет достаточных разрешений на создание копии базы данных на указанном сервере. 400 SameKeyMaterialNotFoundOnRemoteServer — сервер-получатель не имеет материала ключа предохранителя шифрования основного сервера. 400 CannotUseReservedDatabaseName — не удается использовать зарезервированное имя базы данных в этой операции. 400 InvalidFailoverGroupRegion — серверы, указанные в группе отработки отказа экземпляров, должны находиться в разных регионах для обеспечения изоляции. 400 InstanceFailoverGroupDoesNotExist — группа отработки отказа не существует на сервере. 400 InstanceFailoverGroupNotSecondary — отработка отказа не может быть инициирована с сервера-источника в группе отработки отказа экземпляров. 400 InvalidServerName — указано недопустимое имя сервера. 400 InvalidIdentifier — идентификатор содержит значение NULL или недопустимый символ Юникода. 400 TokenTooLong — предоставленный маркер слишком длинный. 400 AzureKeyVaultKeyDisabled — не удалось выполнить операцию на сервере, так как ключ Key Vault Azure отключен. 400 AzureKeyVaultInvalidExpirationDate — не удалось выполнить операцию, так как срок действия ключа Key Vault Azure недопустим. 400 SecurityAzureKeyVaultUrlNullOrEmpty — не удалось выполнить операцию, так как URI Key Vault Azure имеет значение NULL или пусто. 400 InvalidSku — пользователь указал недопустимый номер SKU. 400 InvalidAddSecondaryPermission — пользователь не имеет достаточных разрешений для добавления вторичной базы данных на указанном сервере. 400 ServerNotFound — запрошенный сервер не найден. 400 AzureKeyVaultNoServerIdentity — удостоверение сервера настроено неправильно. 400 AzureKeyVaultInvalidUri — недопустимый ответ от Key Vault Azure. Используйте допустимый URI Key Vault Azure. 400 AzureKeyVaultMissingPermissions — на сервере отсутствуют необходимые разрешения на Key Vault Azure. 400 SecurityAzureKeyVaultInvalidKeyName — не удалось выполнить операцию из-за недопустимого имени ключа сервера. 400 PlannedFailoverTimedOutForDatabase — пользователь вызвал плановая отработка отказа, истекло время ожидания, и определенная база данных, как представляется, blame. 400 PlannedFailoverTimedOut — пользователь вызвал плановая отработка отказа, и время ожидания истекло при попытке связаться со службой управления партнерами. 400 AdalGenericError — не удалось выполнить операцию, так как возникла ошибка Azure Active Directory. 400 GeoReplicationDatabaseNotSecondary — операция ожидает, что база данных будет целевым объектом репликации. 400 AdalServicePrincipalNotFound — не удалось выполнить операцию, так как обнаружена ошибка субъект-служба библиотеки Azure Active Directory не найдена. 400 AzureKeyVaultMalformedVaultUri — указанный URI Key Vault недопустим. 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 — не удалось выполнить операцию, так как имя ключа Key Vault Azure не существует. 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 — превышено допустимое время ожидания запроса на обслуживание.

Примеры

List failover group

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/Japan East/instanceFailoverGroups?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for InstanceFailoverGroups ListByLocation. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/InstanceFailoverGroupList.json
     */
    /**
     * Sample code: List failover group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getInstanceFailoverGroups().listByLocation("Default", "Japan East",
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test",
      "name": "failover-group-test",
      "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"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanEast/instanceFailoverGroups/failover-group-test-1",
      "name": "failover-group-test-1",
      "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-1",
            "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance-1"
          }
        ]
      }
    }
  ]
}

Определения

Имя	Описание
InstanceFailoverGroup	Группа отработки отказа экземпляра.
InstanceFailoverGroupListResult	Список групп отработки отказа экземпляров.
InstanceFailoverGroupReadOnlyEndpoint	Конечная точка только для чтения экземпляра группы отработки отказа.
InstanceFailoverGroupReadWriteEndpoint	Конечная точка чтения и записи экземпляра группы отработки отказа.
InstanceFailoverGroupReplicationRole	Роль локальной репликации экземпляра группы отработки отказа.
ManagedInstancePairInfo	Пары Управляемых экземпляров в группе отработки отказа.
PartnerRegionInfo	Сведения о регионе партнера для группы отработки отказа.
ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.
ReadWriteEndpointFailoverPolicy	Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если параметр failoverPolicy имеет значение Автоматически, то требуется отработка отказаWithDataLossGracePeriodMinutes.

InstanceFailoverGroup

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.managedInstancePairs	ManagedInstancePairInfo[]	Список пар управляемых экземпляров в группе отработки отказа.
properties.partnerRegions	PartnerRegionInfo[]	Сведения о регионе партнера для группы отработки отказа.
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	Конечная точка только для чтения экземпляра группы отработки отказа.
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	Конечная точка чтения и записи экземпляра группы отработки отказа.
properties.replicationRole	InstanceFailoverGroupReplicationRole	Роль локальной репликации экземпляра группы отработки отказа.
properties.replicationState	string	Состояние репликации экземпляра группы отработки отказа.
type	string	Тип ресурса.

InstanceFailoverGroupListResult

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

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	InstanceFailoverGroup[]	Массив результатов.

InstanceFailoverGroupReadOnlyEndpoint

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

Имя	Тип	Описание
failoverPolicy	ReadOnlyEndpointFailoverPolicy	Политика отработки отказа конечной точки только для чтения для группы отработки отказа.

InstanceFailoverGroupReadWriteEndpoint

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

Имя	Тип	Описание
failoverPolicy	ReadWriteEndpointFailoverPolicy	Политика отработки отказа конечной точки чтения и записи для группы отработки отказа. Если параметр failoverPolicy имеет значение Автоматически, то требуется отработка отказаWithDataLossGracePeriodMinutes.
failoverWithDataLossGracePeriodMinutes	integer	Для конечной точки чтения и записи выполняется льготный период перед отработкой отказа с потерей данных. Если параметр failoverPolicy имеет значение Автоматически, то требуется отработка отказаWithDataLossGracePeriodMinutes.

InstanceFailoverGroupReplicationRole

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

Имя	Тип	Описание
Primary	string
Secondary	string

ManagedInstancePairInfo

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

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

PartnerRegionInfo

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

Имя	Тип	Описание
location	string	Географическое расположение управляемых экземпляров партнера.
replicationRole	InstanceFailoverGroupReplicationRole	Роль репликации управляемых экземпляров партнера.

ReadOnlyEndpointFailoverPolicy

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

Имя	Тип	Описание
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

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

Имя	Тип	Описание
Automatic	string
Manual	string