手动倒换主备

功能介绍

您可以根据业务需要，手动倒换主备实例。

• 调用接口前，您需要了解API 认证鉴权。

调试

您可以在API Explorer中调试该接口。

接口约束

• 仅支持HA实例。
• 实例在创建、重启、数据库升级、变更规格、恢复、修改端口、删除用户、创建用户时不能进行此操作。
• 主备倒换不会改变实例的内网地址。

URI

• URI格式

  PUT /v3/{project_id}/instances/{instance_id}/failover

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一Region下的项目ID。 获取方法请参见获取项目ID。
  instance_id	是	实例ID。

请求消息

请求示例

• 不强制倒换主备实例。

  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover
  {}

• 强制倒换主备实例。

  {
  "force":true
  }

响应消息

• 正常响应要素说明

  名称	说明
  workflowId	任务ID。
  instanceId	实例ID。
  nodeId	节点ID。

• 正常响应样例

  {
      "workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
      "instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
      "nodeId":"b94ba815747040f1b0d641cd13364a06no03"
  }

• 异常响应

  请参见异常请求结果。

状态码

• 正常

  200

• 异常

  请参见状态码。

错误码

请参见错误码。