Instance Failover Groups - Failover
從目前的主要受控實例故障轉移至這個受控實例。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}/failover?api-version=2025-01-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
failover
|
path | True |
string |
故障轉移群組的名稱。 |
|
location
|
path | True |
string |
資源所在的區域名稱。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
資源群組的名稱。 名稱不區分大小寫。 |
|
subscription
|
path | True |
string (uuid) |
目標訂用帳戶的標識碼。 此值必須是 UUID。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
Azure 運作順利完成。 |
|
| 202 Accepted |
已接受資源作業。 標題
|
|
| Other Status Codes |
未預期的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow.
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
| 名稱 | Description |
|---|---|
| user_impersonation | 模擬您的用戶帳戶 |
範例
Planned failover of a failover group
範例要求
範例回覆
{
"name": "failover-group-test-3",
"type": "Microsoft.Sql/locations/instanceFailoverGroups",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroups/failover-group-test-3",
"properties": {
"managedInstancePairs": [
{
"partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-primary-mngdInstance",
"primaryManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/managedInstances/failover-group-secondary-mngdInstance"
}
],
"partnerRegions": [
{
"location": "Japan East",
"replicationRole": "Secondary"
}
],
"readOnlyEndpoint": {
"failoverPolicy": "Disabled"
},
"readWriteEndpoint": {
"failoverPolicy": "Automatic",
"failoverWithDataLossGracePeriodMinutes": 480
},
"replicationRole": "Primary",
"replicationState": "CATCH_UP",
"secondaryType": "Geo"
}
}
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/instanceFailoverGroupOperationResults/failover-group-test-3?api-version=2022-05-01-preview
定義
| 名稱 | Description |
|---|---|
|
created |
建立資源的身分識別類型。 |
|
Error |
資源管理錯誤附加資訊。 |
|
Error |
錯誤詳細資料。 |
|
Error |
錯誤回應 |
|
Instance |
實例故障轉移群組。 |
|
Instance |
故障轉移群組實例的唯讀端點。 |
|
Instance |
故障轉移群組實例的讀寫端點。 |
|
Instance |
故障轉移群組實例的本機複寫角色。 |
|
Managed |
故障轉移群組中的受控實例配對。 |
|
Partner |
故障轉移群組的合作夥伴區域資訊。 |
|
Read |
故障轉移群組只讀端點的故障轉移原則。 |
|
Read |
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
|
Secondary |
異地次要實例的類型。 如果實例僅做為DR選項,請設定 『Standby』。 |
|
system |
與建立和上次修改資源相關的元數據。 |
createdByType
建立資源的身分識別類型。
| 值 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
資源管理錯誤附加資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
附加資訊。 |
| type |
string |
其他資訊類型。 |
ErrorDetail
錯誤詳細資料。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤附加資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳情 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
錯誤物件。 |
InstanceFailoverGroup
實例故障轉移群組。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string (arm-id) |
資源的完整資源標識碼。 例如,“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” |
| name |
string |
資源的名稱 |
| properties.managedInstancePairs |
故障轉移群組中的受控實例配對清單。 |
|
| properties.partnerRegions |
故障轉移群組的合作夥伴區域資訊。 |
|
| properties.readOnlyEndpoint |
故障轉移群組實例的唯讀端點。 |
|
| properties.readWriteEndpoint |
故障轉移群組實例的讀寫端點。 |
|
| properties.replicationRole |
故障轉移群組實例的本機複寫角色。 |
|
| properties.replicationState |
string |
故障轉移群組實例的復寫狀態。 |
| properties.secondaryType |
異地次要實例的類型。 如果實例僅做為DR選項,請設定 『Standby』。 |
|
| systemData |
Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。 |
|
| type |
string |
資源的類型。 例如:「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」 |
InstanceFailoverGroupReadOnlyEndpoint
故障轉移群組實例的唯讀端點。
| 名稱 | 類型 | Description |
|---|---|---|
| failoverPolicy |
故障轉移群組只讀端點的故障轉移原則。 |
InstanceFailoverGroupReadWriteEndpoint
故障轉移群組實例的讀寫端點。
| 名稱 | 類型 | Description |
|---|---|---|
| failoverPolicy |
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
|
| failoverWithDataLossGracePeriodMinutes |
integer (int32) |
嘗試讀取寫入端點的數據遺失故障轉移之前的寬限期。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。 |
InstanceFailoverGroupReplicationRole
故障轉移群組實例的本機複寫角色。
| 值 | Description |
|---|---|
| Primary |
主要 |
| Secondary |
Secondary |
ManagedInstancePairInfo
故障轉移群組中的受控實例配對。
| 名稱 | 類型 | Description |
|---|---|---|
| partnerManagedInstanceId |
string |
Partner 的 Partner 受控執行個體 的 ID。 |
| primaryManagedInstanceId |
string |
Main 受控執行個體 的 ID in pair。 |
PartnerRegionInfo
故障轉移群組的合作夥伴區域資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| location |
string |
合作夥伴受控實例的地理位置。 |
| replicationRole |
夥伴受控實例的複寫角色。 |
ReadOnlyEndpointFailoverPolicy
故障轉移群組只讀端點的故障轉移原則。
| 值 | Description |
|---|---|
| Disabled |
Disabled |
| Enabled |
已啟用 |
ReadWriteEndpointFailoverPolicy
故障轉移群組之讀寫端點的故障轉移原則。 如果 failoverPolicy 為 Automatic,則需要 failoverWithDataLossGracePeriodMinutes。
| 值 | Description |
|---|---|
| Manual |
說明書 |
| Automatic |
自動 |
SecondaryInstanceType
異地次要實例的類型。 如果實例僅做為DR選項,請設定 『Standby』。
| 值 | Description |
|---|---|
| Geo |
地理位置 |
| Standby |
待命中 |
systemData
與建立和上次修改資源相關的元數據。
| 名稱 | 類型 | Description |
|---|---|---|
| createdAt |
string (date-time) |
資源建立的時間戳(UTC)。 |
| createdBy |
string |
建立資源的身分識別。 |
| createdByType |
建立資源的身分識別類型。 |
|
| lastModifiedAt |
string (date-time) |
資源上次修改的時間戳記 (UTC) |
| lastModifiedBy |
string |
上次修改資源的身分識別。 |
| lastModifiedByType |
上次修改資源的身分識別類型。 |