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

Replication Links - Failover

服务:: SQL Database

API 版本:: 2023-08-01

从当前主服务器故障转移到此服务器。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/replicationLinks/{linkId}/failover?api-version=2023-08-01

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
linkId	path	True	string	复制链接的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

响应

名称	类型	说明
200 OK	ReplicationLink	已成功故障转移。
202 Accepted		正在执行故障转移作。标头 Location: string
Other Status Codes	ErrorResponse	错误响应： *** 400 ReplicationLinksReplicationLinkNameIsInvalid - 复制链接名称应为有效的 guid。 400 GeoReplicationDatabaseNotSecondary - 该作要求数据库成为复制目标。 400 ReplicationLinksReplicationLinkTypeIsInvalid - LinkType 无效。有效值为 STANDBY 和 GEO。 400 ReplicationLinksCreateIsNotSupported - 不支持创建复制链接。 400 LedgerNoDropLink - 无法停止异地复制，因为数据库启用了账本摘要上传。禁用账本摘要上传并重试作。 400 InvalidServerName - 指定的服务器名称无效。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 400 TokenTooLong - 提供的令牌太长。 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 400 InvalidServerName - 指定的服务器名称无效。 400 GeoReplicationDatabaseNotSecondary - 该作要求数据库成为复制目标。 400 CannotUseTrailingWhitespacesInDatabaseName - 数据库名称验证失败。 400 IncorrectReplicationLinkState - 该作要求数据库在复制链接上处于预期状态。 400 PlannedFailoverTimedOut - 用户调用了计划的故障转移，尝试联系合作伙伴管理服务时超时。 400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - 不支持使用 preferredEnclaveType 属性的不同值配置异地复制的数据库。 “{0}”服务器上的主“{1}”数据库使用“{2}”preferredEnclaveType，而“{3}”服务器上的辅助“{4}”数据库的指定 preferredEnclaveType 为“{5}”。基于虚拟化的安全性（VBS） enclave 不支持 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveType - 主数据库和辅助数据库之间的计划故障转移与不同的 preferredEnclaveType。 400 CannotUseReservedDatabaseName - 不能在此作中使用保留的数据库名称。 400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。 404 OperationIdNotFound - ID作不存在。 404 ResourceNotFound - 找不到请求的资源。 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器 404 OperationIdNotFound - ID作不存在。 404 DatabaseDoesNotExist - 用户已指定此服务器实例上不存在的数据库名称。 409 CannotCancelOperation - 管理作处于无法取消的状态。 409 OperationCancelled -作已被用户取消。 409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。 409 UpdateSloInProgress - 用户在 SLO 更新正在进行时尝试启动不兼容的作。 409 InvalidOperationForDatabaseNotInReplicationRelationship - 对不在复制关系中的数据库执行复制作。 409 ConflictingSystemOperationInProgress - 数据库正在进行系统维护作，并且需要等待进一步的作，直到它完成。 409 DuplicateGeoDrRelation - 数据库已处于复制关系中。这是重复的请求。 409 GeoReplicationCannotBecomePrimaryDuringUndo - 用户尝试故障转移或强制终止异地链接，而辅助副本处于物理上不一致的状态，因此无法进入主要角色。 409 ManagementServiceDatabaseBusy - 数据库“{0}”正忙于另一个作。请稍后尝试作。 409 FailoverGroupAlreadySetup - 无法执行该作，因为异地复制链接是故障转移组的一部分。必须从组中删除数据库才能单独终止或故障转移。 429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。 429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。 500 OperationTimedOut -作超时并自动回滚。请重试该作。 503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

名称

类型

说明

200 OK

ReplicationLink

已成功故障转移。

202 Accepted

正在执行故障转移作。

标头

Location: string

Other Status Codes

ErrorResponse

错误响应： ***

400 ReplicationLinksReplicationLinkNameIsInvalid - 复制链接名称应为有效的 guid。
400 GeoReplicationDatabaseNotSecondary - 该作要求数据库成为复制目标。
400 ReplicationLinksReplicationLinkTypeIsInvalid - LinkType 无效。有效值为 STANDBY 和 GEO。
400 ReplicationLinksCreateIsNotSupported - 不支持创建复制链接。
400 LedgerNoDropLink - 无法停止异地复制，因为数据库启用了账本摘要上传。禁用账本摘要上传并重试作。
400 InvalidServerName - 指定的服务器名称无效。
400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。
400 TokenTooLong - 提供的令牌太长。
400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作
400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作
400 InvalidServerName - 指定的服务器名称无效。
400 GeoReplicationDatabaseNotSecondary - 该作要求数据库成为复制目标。
400 CannotUseTrailingWhitespacesInDatabaseName - 数据库名称验证失败。
400 IncorrectReplicationLinkState - 该作要求数据库在复制链接上处于预期状态。
400 PlannedFailoverTimedOut - 用户调用了计划的故障转移，尝试联系合作伙伴管理服务时超时。
400 VBSEnclaveNotSupportedForGeoReplicationWithDefaultEnclave - 不支持使用 preferredEnclaveType 属性的不同值配置异地复制的数据库。 “{0}”服务器上的主“{1}”数据库使用“{2}”preferredEnclaveType，而“{3}”服务器上的辅助“{4}”数据库的指定 preferredEnclaveType 为“{5}”。
基于虚拟化的安全性（VBS） enclave 不支持 400 VBSEnclaveNotSupportedForPlannedFailoverBetweenDatabasesWithDifferentPreferredEnclaveType - 主数据库和辅助数据库之间的计划故障转移与不同的 preferredEnclaveType。
400 CannotUseReservedDatabaseName - 不能在此作中使用保留的数据库名称。
400 InvalidIdentifier - 标识符包含 NULL 或无效的 unicode 字符。
404 OperationIdNotFound - ID作不存在。
404 ResourceNotFound - 找不到请求的资源。
404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器
404 OperationIdNotFound - ID作不存在。
404 DatabaseDoesNotExist - 用户已指定此服务器实例上不存在的数据库名称。
409 CannotCancelOperation - 管理作处于无法取消的状态。
409 OperationCancelled -作已被用户取消。
409 OperationInterrupted - 无法完成资源上的作，因为它被同一资源上的另一个作中断。
409 UpdateSloInProgress - 用户在 SLO 更新正在进行时尝试启动不兼容的作。
409 InvalidOperationForDatabaseNotInReplicationRelationship - 对不在复制关系中的数据库执行复制作。
409 ConflictingSystemOperationInProgress - 数据库正在进行系统维护作，并且需要等待进一步的作，直到它完成。
409 DuplicateGeoDrRelation - 数据库已处于复制关系中。这是重复的请求。
409 GeoReplicationCannotBecomePrimaryDuringUndo - 用户尝试故障转移或强制终止异地链接，而辅助副本处于物理上不一致的状态，因此无法进入主要角色。
409 ManagementServiceDatabaseBusy - 数据库“{0}”正忙于另一个作。请稍后尝试作。
409 FailoverGroupAlreadySetup - 无法执行该作，因为异地复制链接是故障转移组的一部分。必须从组中删除数据库才能单独终止或故障转移。
429 SubscriptionTooManyCreateUpdateRequests - 请求超出可用资源可以处理的最大请求数。
429 SubscriptionTooManyRequests - 请求超出可用资源可以处理的最大请求数。
500 OperationTimedOut -作超时并自动回滚。请重试该作。
503 TooManyRequests - 请求超出可用资源可以处理的最大请求数。

示例

Planned failover of a replication link

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb/failover?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ReplicationLinkFailover.json
// this example is just showing the usage of "ReplicationLinks_Failover" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerDatabaseReplicationLinkResource created on azure
// for more information of creating SqlServerDatabaseReplicationLinkResource, please refer to the document of SqlServerDatabaseReplicationLinkResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default";
string serverName = "sourcesvr";
string databaseName = "gamma-db";
string linkId = "4891ca10-ebd0-47d7-9182-c722651780fb";
ResourceIdentifier sqlServerDatabaseReplicationLinkResourceId = SqlServerDatabaseReplicationLinkResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, linkId);
SqlServerDatabaseReplicationLinkResource sqlServerDatabaseReplicationLink = client.GetSqlServerDatabaseReplicationLinkResource(sqlServerDatabaseReplicationLinkResourceId);

// invoke the operation
ArmOperation<SqlServerDatabaseReplicationLinkResource> lro = await sqlServerDatabaseReplicationLink.FailoverAsync(WaitUntil.Completed);
SqlServerDatabaseReplicationLinkResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerDatabaseReplicationLinkData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "properties": {
    "partnerServer": "testsvr",
    "partnerDatabase": "gamma-db",
    "partnerDatabaseId": "/subscriptions/00000000-1111-2222-3333-555555555555/resourceGroups/Second-Default/providers/Microsoft.Sql/servers/testsvr/databases/gamma-db",
    "partnerLocation": "Japan East",
    "role": "Primary",
    "partnerRole": "Secondary",
    "replicationMode": "ASYNC",
    "startTime": "2018-06-21T08:12:43.783Z",
    "percentComplete": 100,
    "replicationState": "CATCH_UP",
    "isTerminationAllowed": true,
    "linkType": "GEO"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/sourcesvr/databases/gamma-db/replicationLinks/4891ca10-ebd0-47d7-9182-c722651780fb",
  "name": "4891ca10-ebd0-47d7-9182-c722651780fb"
}

状态代码:: 202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/JapanWest/replicationLinksOperationResults/replicationlink-group-test-3?api-version=2022-05-01-preview

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ReplicationLink	复制链接。
ReplicationLinkType	链接类型（GEO、NAMED、STANDBY）。更新作不支持 NAMED。
ReplicationRole	本地复制角色。
ReplicationState	复制状态（挂起、种子设定、CATCHUP、SUSPENDED）。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

ReplicationLink

Object

复制链接。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.isTerminationAllowed	boolean	用户当前是否允许终止链接。
properties.linkType	ReplicationLinkType	链接类型（GEO、NAMED、STANDBY）。更新作不支持 NAMED。
properties.partnerDatabase	string	资源伙伴数据库。
properties.partnerDatabaseId	string	资源伙伴数据库 ID。
properties.partnerLocation	string	资源合作伙伴位置。
properties.partnerRole	ReplicationRole	合作伙伴复制角色。
properties.partnerServer	string	资源伙伴服务器。
properties.percentComplete	integer (int32)	链接的种子设定完成百分比。
properties.replicationMode	string	复制模式。
properties.replicationState	ReplicationState	复制状态（挂起、种子设定、CATCHUP、SUSPENDED）。
properties.role	ReplicationRole	本地复制角色。
properties.startTime	string (date-time)	创建链接的时间。
type	string	资源类型。

ReplicationLinkType

枚举

链接类型（GEO、NAMED、STANDBY）。更新作不支持 NAMED。

值	说明
GEO
NAMED
STANDBY

ReplicationRole

枚举

本地复制角色。

值	说明
Primary
Secondary
NonReadableSecondary
Source
Copy

ReplicationState

枚举

复制状态（挂起、种子设定、CATCHUP、SUSPENDED）。

值	说明
PENDING
SEEDING
CATCH_UP
SUSPENDED

通过

Replication Links - Failover

URI 参数

响应

示例

Planned failover of a replication link

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ReplicationLink

ReplicationLinkType

ReplicationRole

ReplicationState