Instance Failover Groups - Get

Service:

SQL Database

API Version:

2021-11-01

取得容錯移轉群組。

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

URI 參數

名稱	位於	必要	類型	Description
failoverGroupName	path	True	string	故障轉移群組的名稱。
locationName	path	True	string	資源所在的區域名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	InstanceFailoverGroup	已成功擷取指定的故障轉移群組。
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 - 建立複本伺服器時，Edition 必須與主伺服器相同。 400 DnsZoneMismatch - 夥伴伺服器上的 DNSZone 與來源伺服器上的 DNSZone 不同。 這會中斷 InstanceFailoverGroup 功能。 400 InvalidTargetSubregion - 不可讀取次要複本的目標伺服器不在 DR 配對的 Azure 區域中。 400 GeoDrInstanceSizeMismatch - 主要受控實例和夥伴受控實例沒有相同的記憶體大小。 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure 金鑰保存庫 主體憑證已過期。 400 GeoDrSecondaryInstanceNotEmpty - 次要受控實例具有用戶資料庫。 若要建立實例故障轉移群組，次要受控實例必須是空的。 400 InstanceFailoverGroupIncorrectNetworkingConfiguration - 網路設定不正確。 主伺服器的復寫流量無法連線到輔助伺服器。 400 IncorrectReplicationLinkState - 作業預期資料庫在復寫連結上處於預期狀態。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 金鑰保存庫 uri 無效。 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 或無效的 Unicode 字元。 400 TokenTooLong - 提供的令牌太長。 400 AzureKeyVaultKeyDisabled - 無法在伺服器上完成作業，因為 Azure 金鑰保存庫 密鑰已停用。 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure 金鑰保存庫 密鑰到期日無效。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure 金鑰保存庫 Uri 為 Null 或空白。 400 InvalidSku - 使用者指定了無效的 SKU。 400 InvalidAddSecondaryPermission - 使用者沒有足夠的許可權可新增指定伺服器上的輔助伺服器。 400 ServerNotFound - 找不到要求的伺服器。 400 AzureKeyVaultNoServerIdentity - 未正確設定伺服器識別。 400 AzureKeyVaultInvalidUri - 來自 Azure 金鑰保存庫 的無效回應。 請使用有效的 Azure 金鑰保存庫 URI。 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure 金鑰保存庫 的必要許可權。 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。 400 PlannedFailoverTimedOutForDatabase - 使用者叫用 容錯移轉、逾時，而特定資料庫似乎要負責。 400 PlannedFailoverTimedOut - 使用者叫用 容錯移轉，並在嘗試連絡合作夥伴管理服務時逾時。 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。 400 GeoReplicationDatabaseNotSecondary - 作業預期資料庫為複寫目標。 400 AdalServicePrincipalNotFound - 作業無法完成，因為發生 Azure Active Directory 連結庫服務主體找不到錯誤。 400 AzureKeyVaultMalformedVaultUri - 提供的 金鑰保存庫 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 金鑰保存庫 密鑰名稱不存在。 409 AzureKeyVaultKeyInUse - 伺服器目前正在使用密鑰。 409 ConflictingSystemOperationInProgress - 資料庫上的系統維護作業正在進行中，而進一步的作業必須等到完成為止。 409 InvalidOperationForDatabaseNotInReplicationRelationship - 已在復寫關聯性中的資料庫上執行複寫植入作業。 409 InvalidDatabaseStateForOperation - 目前復寫狀態的資料庫上不允許此作業。 409 DuplicateGeoDrRelation - 資料庫已經在復寫關聯中。 這是重複的要求。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。 503 AzureKeyVaultConnectionFailed - 無法在伺服器上完成作業，因為嘗試連線到 Azure 金鑰保存庫 失敗 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取 金鑰保存庫 資訊時發生錯誤。 504 RequestTimeout - 服務要求超過允許的逾時。

範例

Get 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/failover-group-test?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for InstanceFailoverGroups Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/InstanceFailoverGroupGet.json
     */
    /**
     * Sample code: Get failover group.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFailoverGroup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getInstanceFailoverGroups().getWithResponse("Default",
            "Japan East", "failover-group-test", 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

{
  "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"
      }
    ]
  }
}

定義

名稱	Description
InstanceFailoverGroup	實例故障轉移群組。
InstanceFailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
InstanceFailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
InstanceFailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
ManagedInstancePairInfo	故障轉移群組中的受控實例配對。
PartnerRegionInfo	故障轉移群組的合作夥伴區域資訊。
ReadOnlyEndpointFailoverPolicy	故障轉移群組之只讀端點的故障轉移原則。
ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroup

實例故障轉移群組。

名稱	類型	Description
id	string	資源識別碼。
name	string	資源名稱。
properties.managedInstancePairs	ManagedInstancePairInfo[]	故障轉移群組中的受控實例配對清單。
properties.partnerRegions	PartnerRegionInfo[]	故障轉移群組的合作夥伴區域資訊。
properties.readOnlyEndpoint	InstanceFailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	InstanceFailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.replicationRole	InstanceFailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
properties.replicationState	string	故障轉移群組實例的復寫狀態。
type	string	資源類型。

InstanceFailoverGroupReadOnlyEndpoint

故障轉移群組實例的唯讀端點。

名稱	類型	Description
failoverPolicy	ReadOnlyEndpointFailoverPolicy	故障轉移群組之只讀端點的故障轉移原則。

InstanceFailoverGroupReadWriteEndpoint

故障轉移群組實例的讀寫端點。

名稱	類型	Description
failoverPolicy	ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。
failoverWithDataLossGracePeriodMinutes	integer	嘗試進行讀寫端點的數據遺失故障轉移之前的寬限期。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

InstanceFailoverGroupReplicationRole

故障轉移群組實例的本機複寫角色。

名稱	類型	Description
Primary	string
Secondary	string

ManagedInstancePairInfo

故障轉移群組中的受控實例配對。

名稱	類型	Description
partnerManagedInstanceId	string	合作夥伴 受控執行個體的標識碼。
primaryManagedInstanceId	string	配對的主要 受控執行個體標識碼。

PartnerRegionInfo

故障轉移群組的合作夥伴區域資訊。

名稱	類型	Description
location	string	合作夥伴受控實例的地理位置。
replicationRole	InstanceFailoverGroupReplicationRole	夥伴受控實例的複寫角色。

ReadOnlyEndpointFailoverPolicy

故障轉移群組之只讀端點的故障轉移原則。

名稱	類型	Description
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic，則需要 failoverWithDataLossGracePeriodMinutes。

名稱	類型	Description
Automatic	string
Manual	string