Failover Groups - List By Server

服務:

SQL Database

API 版本:

2021-11-01

列出伺服器中的容錯移轉群組。

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

URI 參數

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

回應

名稱	類型	Description
200 OK	FailoverGroupListResult	已成功擷取故障轉移群組。
Other Status Codes		錯誤回應： ≦ 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 - 建立或更新要求需要讀寫端點的 failoverPolicy 字段。 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - 在為讀寫端點選取故障轉移原則手動時，不應該提供寬限期值。 請從要求中移除它。 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - 建立或更新故障轉移群組要求本文不應修改只讀屬性 '{0}'。 400 FailoverGroupFailoverRequestOnPrimary - 故障轉移要求應在故障轉移群組的輔助伺服器上起始。 400 FailoverGroupPartnerServerFromDifferentSubscription - 故障轉移群組的主伺服器和夥伴伺服器來自不同的訂用帳戶。 不允許故障轉移群組伺服器的跨訂用帳戶。 400 InvalidAddSecondaryPermission - 使用者沒有足夠的許可權在指定的伺服器上新增次要複本。 400 InvalidSku - 使用者指定了無效的 SKU。 400 ServerNotFound - 找不到所要求的伺服器。 400 FeatureDisabledOnSelectedEdition - 用戶嘗試使用目前資料庫版本停用的功能。 400 TokenTooLong - 提供的令牌太長。 400 InvalidTargetSubregion - 不可讀取次要複本的目標伺服器不在 DR 配對的 Azure 區域中。 400 PartnerServerNotCompatible - 使用者嘗試將資料庫從 SAWA V1 伺服器複製到一部批注伺服器，反之亦然。 400 IncorrectReplicationLinkState - 作業預期資料庫在復寫連結上處於預期狀態。 400 ResourcePoolNotFound - 指定的彈性集區不存在於指定的邏輯伺服器中。 400 AzureKeyVaultKeyDisabled - 無法在伺服器上完成作業，因為 Azure 金鑰保存庫 密鑰已停用。 400 AzureKeyVaultInvalidExpirationDate - 作業無法完成，因為 Azure 金鑰保存庫 密鑰到期日無效。 400 SecurityAzureKeyVaultUrlNullOrEmpty - 作業無法完成，因為 Azure 金鑰保存庫 Uri 為 Null 或空白。 400 AzureKeyVaultNoServerIdentity - 伺服器識別未正確設定。 400 AzureKeyVaultInvalidUri - 來自 Azure 金鑰保存庫 的無效回應。 請使用有效的 Azure 金鑰保存庫 URI。 400 AzureKeyVaultMissingPermissions - 伺服器缺少 Azure 金鑰保存庫 的必要許可權。 400 SecurityAzureKeyVaultInvalidKeyName - 作業無法完成，因為伺服器密鑰名稱無效。 400 PlannerFailoverTimedOutForDatabase - 使用者叫用 容錯移轉、逾時，而特定資料庫似乎要負責。 400 PlannerFailoverTimedOut - 使用者叫用 容錯移轉，並在嘗試連絡合作夥伴管理服務時逾時。 400 AdalGenericError - 作業無法完成，因為發生 Azure Active Directory 錯誤。 400 AdalServicePrincipalNotFound - 作業無法完成，因為遇到 Azure Active Directory 連結庫服務主體錯誤。 400 AzureKeyVaultMalformedVaultUri - 提供的 金鑰保存庫 uri 無效。 400 CannotUseReservedDatabaseName - 無法在此作業中使用保留的資料庫名稱。 400 InvalidFailoverGroupRegion - 故障轉移群組中指定的伺服器必須位於不同區域以提供隔離。 400 FailoverGroupDoesNotExist - 故障轉移群組不存在於伺服器上。 400 FailoverGroupNotSecondary - 故障轉移無法從故障轉移群組中的主伺服器起始故障轉移。 400 InvalidServerName - 指定的伺服器名稱無效。 400 DatabaseInFailoverGroupNotPrimary - 資料庫的 GeoDR 鏈接已經存在，但其角色不是 「主要」，或不是連續複製連結。 400 SecurityAdalPrincipalCertExpiredError - 作業無法完成，因為 Azure 金鑰保存庫 主體憑證已過期。 400 UnableToCreateFailoverGroupDueToTableAuditing - 無法針對開啟數據表稽核的伺服器建立故障轉移群組。 400 InvalidIdentifier - 識別碼包含 NULL 或無效的 Unicode 字元。 400 UnableToAddDbWithTableAuditingToFailoverGroup - 無法透過故障轉移群組端點存取已啟用數據表稽核的資料庫。 400 SecurityInvalidAzureKeyVaultRecoveryLevel - 提供的 金鑰保存庫 uri 無效。 400 KeyMaterialNotFoundOnRemoteServer - 遠端伺服器無法存取做為 TDE 保護裝置使用的金鑰數據。 400 LimitOfFailoverGroupsPerServerExceeded - 建立新的故障轉移群組將會超過每部伺服器的允許故障轉移群組數目。 400 SameKeyUriNotFoundOnRemoteServer - 輔助伺服器沒有與啟用密鑰自動輪替之主伺服器加密保護裝置相同的密鑰保存庫密鑰數據。 400 AzureKeyVaultRsaKeyNotSupported - 提供的密鑰保存庫使用不支援的 RSA 金鑰大小或密鑰類型。 支援的 RSA 金鑰大小為 2048 或 3072，金鑰類型為 RSA 或 RSA-HSM。 400 SameKeyMaterialNotFoundOnRemoteServer - 輔助伺服器沒有主伺服器加密保護裝置的密鑰數據。 400 GeoReplicationDatabaseNotSecondary - 作業預期資料庫為複寫目標。 400 GeoReplicaLimitReached - 已達到個別複本複寫限制。 400 FailoverGroupWithVirtualNetworkRulesNotSupported - 使用自動故障轉移原則設定的故障轉移群組目前不支援使用虛擬網路防火牆規則設定的伺服器。 請使用手動故障轉移原則來設定故障轉移群組。 400 UnableToResolveRemoteServer - 遠端夥伴伺服器名稱因伺服器名稱無效或 DNS 連線問題而無法解決。 400 RemoteDatabaseCopyPermission - 用戶沒有足夠的許可權在指定的伺服器上建立資料庫複本。 400 SecurityAzureKeyVaultGeoChainError - 使用 Azure 金鑰保存庫 (BYOK) 啟用透明數據加密時，不支援建立次要 (稱為鏈結) 的次要複本。 404 ResourceNotFound - 找不到所要求的資源。 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 ServerNotInSubscription - 指定的伺服器不存在於指定的訂用帳戶上。 404 SourceDatabaseNotFound - 源資料庫不存在。 405 UnsupportedReplicationOperation - 資料庫上已起始不支持的復寫作業。 409 ConflictingServerOperation - 伺服器目前正在進行作業。 409 SubscriptionDisabled - 已停用訂用帳戶。 409 ConflictingSystemOperationInProgress - 資料庫上的系統維護作業正在進行中，而進一步的作業必須等到完成為止。 409 GeoReplicationCannotBecomePrimaryDuringUndo - 使用者嘗試故障轉移或強制終止異地連結，而輔助資料庫處於實體不一致的狀態，因此無法進入主要角色。 409 ServerKeyNameAlreadyExists - 伺服器密鑰已存在於伺服器上。 409 ServerKeyUriAlreadyExists - 伺服器密鑰 URI 已存在於伺服器上。 「409 ServerKeyDoesNotExists - 伺服器金鑰不存在。」 409 UpdateSloInProgress - 使用者嘗試在進行 SLO 更新時起始不相容的作業。 409 AzureKeyVaultKeyNameNotFound - 作業無法完成，因為 Azure 金鑰保存庫 密鑰名稱不存在。 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 金鑰保存庫 失敗 503 AzureKeyVaultGenericConnectionError - 作業無法完成，因為嘗試擷取 金鑰保存庫 資訊時發生錯誤。 503 DatabaseUnavailable - 作業失敗，因為資料庫無法使用。 504 RequestTimeout - 服務要求超過允許的逾時。

範例

List failover group

範例要求

HTTP

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

Java

/**
 * Samples for FailoverGroups ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/FailoverGroupList.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().getFailoverGroups().listByServer("Default",
            "failover-group-primary-server", com.azure.core.util.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

範例回覆

狀態碼:

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"
        },
        "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"
        },
        "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": []
      }
    }
  ]
}

定義

名稱	Description
FailoverGroup	故障轉移群組。
FailoverGroupListResult	故障轉移群組的清單。
FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
FailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
PartnerInfo	故障轉移群組的夥伴伺服器資訊。
ReadOnlyEndpointFailoverPolicy	故障轉移群組之只讀端點的故障轉移原則。
ReadWriteEndpointFailoverPolicy	故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為自動，則需要 failoverWithDataLossGracePeriodMinutes。

FailoverGroup

故障轉移群組。

名稱	類型	Description
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.databases	string[]	故障轉移群組中的資料庫清單。
properties.partnerServers	PartnerInfo[]	故障轉移群組的夥伴伺服器資訊清單。
properties.readOnlyEndpoint	FailoverGroupReadOnlyEndpoint	故障轉移群組實例的唯讀端點。
properties.readWriteEndpoint	FailoverGroupReadWriteEndpoint	故障轉移群組實例的讀寫端點。
properties.replicationRole	FailoverGroupReplicationRole	故障轉移群組實例的本機複寫角色。
properties.replicationState	string	故障轉移群組實例的復寫狀態。
tags	object	資源標籤。
type	string	資源類型。

FailoverGroupListResult

故障轉移群組的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	FailoverGroup[]	結果陣列。

FailoverGroupReadOnlyEndpoint

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

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

FailoverGroupReadWriteEndpoint

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

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

FailoverGroupReplicationRole

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

名稱	類型	Description
Primary	string
Secondary	string

PartnerInfo

故障轉移群組的夥伴伺服器資訊。

名稱	類型	Description
id	string	夥伴伺服器的資源識別碼。
location	string	合作夥伴伺服器的地理位置。
replicationRole	FailoverGroupReplicationRole	夥伴伺服器的復寫角色。

ReadOnlyEndpointFailoverPolicy

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

名稱	類型	Description
Disabled	string
Enabled	string

ReadWriteEndpointFailoverPolicy

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

名稱	類型	Description
Automatic	string
Manual	string