SwitchDBInstanceHA - 切换实例高可用主节点。

更新时间:
复制 MD 格式

切换 PolarDB-X 实例主节点所在的可用区

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:SwitchDBInstanceHA

none

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

RegionId

string

是

地域 ID。

cn-hangzhou

DBInstanceName

string

是

PolarDB-X 实例名称。

pxc-htri0ori2r****

TargetPrimaryRegionId

string

否

切换后的主节点所在地域 ID。

cn-hangzhou

TargetPrimaryAzoneId

string

否

切换后的主节点所在可用区 ID。

cn-hangzhou-d

SwitchTimeMode

string

否

切换模式:0 为立即切换,1 为运维时间切换,2 为指定时间切换。

0

SwitchTime

string

否

指定切换时间。SwitchTimeMode 为 2 时必填,采用 UTC 时间,格式为 YYYY-MM-DDThh:mm:ssZ。

2018-02-05T09:12:00Z

返回参数

名称

类型

描述

示例值

object

Message

string

错误信息。

successs

RequestId

string

请求 ID。

1A6D328C-84B8-40DC-BF49-6C73984D7494

Success

boolean

请求是否成功。

示例

正常返回示例

JSON格式

{
  "Message": "successs",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。