Instance Failover Groups - List By Location
列出位置中的故障转移组。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups?api-version=2023-08-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
location
|
path | True |
string |
资源所在的区域的名称。 |
|
resource
|
path | True |
string |
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
|
subscription
|
path | True |
string |
标识 Azure 订阅的订阅 ID。 |
|
api-version
|
query | True |
string |
要用于请求的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
已成功检索故障转移组。 |
|
| Other Status Codes |
错误响应: ***
|
示例
List failover group
示例请求
示例响应
{
"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"
}
],
"secondaryType": "Geo"
}
},
{
"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"
}
],
"secondaryType": "Geo"
}
}
]
}
定义
| 名称 | 说明 |
|---|---|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Instance |
实例故障转移组。 |
|
Instance |
实例故障转移组的列表。 |
|
Instance |
故障转移组实例的只读终结点。 |
|
Instance |
故障转移组实例的读写终结点。 |
|
Instance |
故障转移组实例的本地复制角色。 |
|
Managed |
故障转移组中的托管实例对。 |
|
Partner |
故障转移组的合作伙伴区域信息。 |
|
Read |
故障转移组只读终结点的故障转移策略。 |
|
Read |
故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic,则需要 failoverWithDataLossGracePeriodMinutes。 |
|
Secondary |
异地辅助实例的类型。 仅当实例用作 DR 选项时,请设置“备用”。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
InstanceFailoverGroup
实例故障转移组。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID。 |
| name |
string |
资源名称。 |
| properties.managedInstancePairs |
故障转移组中托管实例对的列表。 |
|
| properties.partnerRegions |
故障转移组的合作伙伴区域信息。 |
|
| properties.readOnlyEndpoint |
故障转移组实例的只读终结点。 |
|
| properties.readWriteEndpoint |
故障转移组实例的读写终结点。 |
|
| properties.replicationRole |
故障转移组实例的本地复制角色。 |
|
| properties.replicationState |
string |
故障转移组实例的复制状态。 |
| properties.secondaryType |
异地辅助实例的类型。 仅当实例用作 DR 选项时,请设置“备用”。 |
|
| type |
string |
资源类型。 |
InstanceFailoverGroupListResult
实例故障转移组的列表。
| 名称 | 类型 | 说明 |
|---|---|---|
| nextLink |
string |
用于检索下一页结果的链接。 |
| value |
结果数组。 |
InstanceFailoverGroupReadOnlyEndpoint
故障转移组实例的只读终结点。
| 名称 | 类型 | 说明 |
|---|---|---|
| failoverPolicy |
故障转移组只读终结点的故障转移策略。 |
InstanceFailoverGroupReadWriteEndpoint
故障转移组实例的读写终结点。
| 名称 | 类型 | 说明 |
|---|---|---|
| failoverPolicy |
故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic,则需要 failoverWithDataLossGracePeriodMinutes。 |
|
| failoverWithDataLossGracePeriodMinutes |
integer (int32) |
尝试对读写终结点执行故障转移前的宽限期,并丢失数据。 如果 failoverPolicy 为 Automatic,则需要 failoverWithDataLossGracePeriodMinutes。 |
InstanceFailoverGroupReplicationRole
故障转移组实例的本地复制角色。
| 值 | 说明 |
|---|---|
| Primary | |
| Secondary |
ManagedInstancePairInfo
故障转移组中的托管实例对。
| 名称 | 类型 | 说明 |
|---|---|---|
| partnerManagedInstanceId |
string |
成对的合作伙伴托管实例的 ID。 |
| primaryManagedInstanceId |
string |
主托管实例的 ID 成对。 |
PartnerRegionInfo
故障转移组的合作伙伴区域信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| location |
string |
合作伙伴托管实例的地理位置。 |
| replicationRole |
合作伙伴托管实例的复制角色。 |
ReadOnlyEndpointFailoverPolicy
故障转移组只读终结点的故障转移策略。
| 值 | 说明 |
|---|---|
| Disabled | |
| Enabled |
ReadWriteEndpointFailoverPolicy
故障转移组的读写终结点的故障转移策略。 如果 failoverPolicy 为 Automatic,则需要 failoverWithDataLossGracePeriodMinutes。
| 值 | 说明 |
|---|---|
| Manual | |
| Automatic |
SecondaryInstanceType
异地辅助实例的类型。 仅当实例用作 DR 选项时,请设置“备用”。
| 值 | 说明 |
|---|---|
| Geo | |
| Standby |