你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Instance Failover Groups - Get

服务:

SQL Database

API 版本:

2023-08-01

获取故障转移组。

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

URI 参数

名称	在	必需	类型	说明
failoverGroupName	path	True	string	故障转移组的名称。
locationName	path	True	string	资源所在的区域的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	InstanceFailoverGroup	已成功检索指定的故障转移组。
Other Status Codes	ErrorResponse	错误响应： *** 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 InvalidAddSecondaryPermission - 用户没有足够的权限在指定的服务器上添加辅助数据库。 400 InvalidSku - 用户指定了无效 SKU。 400 ServerNotFound - 找不到请求的服务器。 创建副本服务器时，400 ServerEditionMismatch - Edition 必须与主服务器相同。 400 FeatureDisabledOnSelectedEdition - 用户尝试使用当前数据库版本上禁用的功能。 400 TokenTooLong - 提供的令牌太长。 400 InvalidTargetSubregion - 不可读辅助数据库的目标服务器不在 DR 配对的 Azure 区域中。 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 400 IncorrectReplicationLinkState - 该作要求数据库在复制链接上处于预期状态。 400 CloudLifterFogInaccessibleDbRoleMismatch - 无法使 SQL 托管实例上的数据库 {0}{1} 可访问，因为故障转移组中的实例角色在数据库处于不可访问状态时从 {2} 更改为 {3}。 请通过执行异地故障转移还原原始数据库角色，然后重试。 400 CloudLifterGeodrBlocksDbActivate - 由于正在进行的异地作，无法使 SQL 托管实例上的数据库 {0}{1} 可访问。 请等待冲突的作完成，然后重试。 400 AzureKeyVaultKeyDisabled - 无法在服务器上完成该作，因为 Azure Key Vault 密钥已禁用。 400 AzureKeyVaultInvalidExpirationDate - 无法完成该作，因为 Azure Key Vault 密钥到期日期无效。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 无法完成作，因为 Azure Key Vault URI 为 null 或为空。 400 AzureKeyVaultNoServerIdentity - 服务器标识未正确配置。 400 AzureKeyVaultInvalidUri - 来自 Azure Key Vault 的无效响应。 请使用有效的 Azure Key Vault URI。 400 AzureKeyVaultMissingPermissions - 服务器缺少对 Azure Key Vault 所需的权限。 400 SecurityAzureKeyVaultInvalidKeyName - 由于服务器密钥名称无效，无法完成该作。 400 PlannedFailoverTimedOutForDatabase - 用户调用了计划内故障转移，超时，特定数据库似乎要归咎于此。 400 PlannedFailoverTimedOut - 用户调用了计划的故障转移，尝试联系合作伙伴管理服务时超时。 400 AdalGenericError - 由于遇到 Azure Active Directory 错误，无法完成该作。 400 AdalServicePrincipalNotFound - 无法完成该作，因为遇到 Azure Active Directory 库服务主体找不到错误。 400 AzureKeyVaultMalformedVaultUri - 提供的 Key Vault URI 无效。 400 CannotUseReservedDatabaseName - 不能在此作中使用保留的数据库名称。 400 InvalidFailoverGroupRegion - 实例故障转移组中指定的服务器需要驻留在不同区域中以提供隔离。 400 InstanceFailoverGroupDoesNotExist - 故障转移组在服务器上不存在。 400 InstanceFailoverGroupNotSecondary - 无法从实例故障转移组中的主服务器启动故障转移。 在实例池中预配的托管实例不支持 400 ManagedInstanceGeoDRNotAllowedForInstancePool - 创建自动故障转移组（GeoDR）。 只能为独立托管实例创建自动故障转移组。 400 InvalidServerName - 指定的服务器名称无效。 400 ManagedInstanceEstablishingFailoverGroupGeoPrimaryWithNewerVersionEditionThanSecondary - 无法创建故障转移组，因为主实例的数据库格式与辅助实例的数据库格式不兼容。 有关详细信息，请参阅 https://go.microsoft.com/fwlink/?linkid=2251601。 400 ManagedInstanceFailoverInFailoverGroupInstancesWithDifferentVersionEditions - 由于故障转移组中实例的数据库格式不匹配，无法执行故障转移作。 请考虑升级主实例的数据库格式或删除故障转移组，以将当前辅助实例提升为独立实例。 有关详细信息，请参阅 https://go.microsoft.com/fwlink/?linkid=2251601。 400 SecurityAdalPrincipalCertExpiredError - 无法完成该作，因为 Azure Key Vault 主体证书已过期。 免费 Azure SQL 托管实例产品/服务不支持 400 ManagedInstanceNotAllowedInGeoDRSetupWhenFreemium - 不支持部署故障转移组。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 Key Vault URI 无效。 400 ManagedInstanceGeoFailoverCannotBeExecuted - 目前无法执行托管实例异地故障转移。 原因：'{0}'。 400 KeyMaterialNotFoundOnRemoteServer - 远程服务器无权访问用作 TDE 保护程序的密钥材料。 400 SameKeyUriNotFoundOnRemoteServer - 辅助服务器没有与启用了密钥自动轮换的主服务器的加密保护程序相同的密钥保管库中的密钥材料。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密钥保管库使用不支持的 RSA 密钥大小或密钥类型。 支持的 RSA 密钥大小为 2048 或 3072，密钥类型为 RSA 或 RSA-HSM。 400 SameKeyMaterialNotFoundOnRemoteServer - 辅助服务器没有主服务器的加密保护程序的密钥材料。 400 GeoReplicationDatabaseNotSecondary - 该作要求数据库成为复制目标。 400 ManagedInstanceUpdateSloOngoing - 无法完成该作，因为托管实例“{0}”的服务层更改正在进行中。 请等待作完成，然后重试。 400 FailoverGroupRegionMismatch - 故障转移组中指定的合作伙伴区域需要匹配所指示的合作伙伴托管实例的区域。 400 DnsZoneMismatch - 合作伙伴服务器上的 DNSZone 不同于源服务器上的 DNSZone。 这会中断 InstanceFailoverGroup 功能。 400 GeoDrInstanceSizeMismatch - 主托管实例和合作伙伴托管实例的大小不同。 400 UnableToResolveRemoteServer - 由于服务器名称或 DNS 连接问题无效，无法解决远程合作伙伴服务器名称。 400 GeoDrSecondaryInstanceNotEmpty - 辅助托管实例具有用户数据库。 若要创建实例故障转移组，辅助托管实例需要为空。 400 RemoteDatabaseCopyPermission - 用户没有足够的权限在指定服务器上创建数据库副本。 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - 网络配置不正确。 主服务器的复制流量无法访问辅助服务器。 404 ResourceNotFound - 找不到请求的资源。 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。 404 ServerNotInSubscription - 指定的服务器在指定的订阅上不存在。 404 SourceDatabaseNotFound - 源数据库不存在。 405 UnsupportedReplicationOperation - 在数据库上启动了不受支持的复制作。 409 ConflictingServerOperation - 服务器当前正在进行作。 409 SubscriptionDisabled - 已禁用订阅。 409 ConflictingSystemOperationInProgress - 数据库正在进行系统维护作，并且需要等待进一步的作，直到它完成。 409 ManagedInstanceContainsInaccessibleDatabases - 无法完成该作，因为托管实例“{0}”包含处于不可访问状态的数据库。 请在重试作之前删除无法访问的数据库，或者修复对托管实例的客户管理的 TDE 保护程序密钥的访问权限问题。 https://go.microsoft.com/fwlink/?linkid=2111623 409 ManagedInstanceHasHybridLink - 用户尝试启动在托管实例配置了混合链接时不支持的作。 409 GeoReplicationCannotBecomePrimaryDuringUndo - 用户尝试故障转移或强制终止异地链接，而辅助副本处于物理上不一致的状态，因此无法进入主要角色。 409 ServerKeyNameAlreadyExists - 服务器上已存在服务器密钥。 409 ServerKeyUriAlreadyExists - 服务器上已存在服务器密钥 URI。 409 ServerKeyDoesNotExists - 服务器密钥不存在。 409 UpdateSloInProgress - 用户在 SLO 更新正在进行时尝试启动不兼容的作。 409 AzureKeyVaultKeyNameNotFound - 无法完成该作，因为 Azure Key Vault 密钥名称不存在。 409 AzureKeyVaultKeyInUse - 服务器当前正在使用密钥。 409 InstanceFailoverGroupAlreadyExists - 故障转移组已存在于给定服务器上。 409 InstanceFailoverGroupBusy - 实例故障转移组正忙于另一个作。 409 InstanceFailoverGroupDnsRecordInUse - 请求的终结点存在重复的 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 信息时遇到错误。 504 RequestTimeout - 服务请求超过了允许的超时。

示例

Get failover group

示例请求

HTTP

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=2023-08-01

示例响应

状态代码:

200

{
  "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"
      }
    ],
    "secondaryType": "Geo"
  }
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
InstanceFailoverGroup	实例故障转移组。
InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
ManagedInstancePairInfo	故障转移组中的托管实例对。
PartnerRegionInfo	故障转移组的合作伙伴区域信息。
ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。
ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
SecondaryInstanceType	异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

InstanceFailoverGroup

Object

实例故障转移组。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.managedInstancePairs	ManagedInstancePairInfo[]	故障转移组中托管实例对的列表。
properties.partnerRegions	PartnerRegionInfo[]	故障转移组的合作伙伴区域信息。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	故障转移组实例的只读终结点。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	故障转移组实例的读写终结点。
properties.replicationRole	InstanceFailoverGroupReplicationRole	故障转移组实例的本地复制角色。
properties.replicationState	string	故障转移组实例的复制状态。
properties.secondaryType	SecondaryInstanceType	异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。
type	string	资源类型。

InstanceFailoverGroupReadOnlyEndpoint

Object

故障转移组实例的只读终结点。

名称	类型	说明
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障转移组只读终结点的故障转移策略。

InstanceFailoverGroupReadWriteEndpoint

Object

故障转移组实例的读写终结点。

名称	类型	说明
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer (int32)	尝试对读写终结点执行故障转移前的宽限期，并丢失数据。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroupReplicationRole

枚举

故障转移组实例的本地复制角色。

值	说明
Primary
Secondary

ManagedInstancePairInfo

Object

故障转移组中的托管实例对。

名称	类型	说明
partnerManagedInstanceId	string	成对的合作伙伴托管实例的 ID。
primaryManagedInstanceId	string	主托管实例的 ID 成对。

PartnerRegionInfo

Object

故障转移组的合作伙伴区域信息。

名称	类型	说明
location	string	合作伙伴托管实例的地理位置。
replicationRole	InstanceFailoverGroupReplicationRole	合作伙伴托管实例的复制角色。

ReadOnlyEndpointFailoverPolicy

枚举

故障转移组只读终结点的故障转移策略。

值	说明
Disabled
Enabled

ReadWriteEndpointFailoverPolicy

枚举

故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic，则需要 failoverWithDataLossGracePeriodMinutes。

值	说明
Automatic
Manual

SecondaryInstanceType

枚举

异地辅助实例的类型。 仅当实例用作 DR 选项时，请设置“备用”。

值	说明
Geo
Standby