调用ModifyDBClusterPrimaryZone变更PolarDB集群的主可用区。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDBClusterPrimaryZone

系统规定参数。取值:ModifyDBClusterPrimaryZone

DBClusterId String pc-**************

集群ID。

ZoneId String cn-hangzhou-g

新的主可用区ID。

说明 可通过接口DescribeRegions查看可用的可用区。
VSwitchId String vsw-**************

目标可用区的虚拟交换机ID。

说明
  • 当集群为PolarDB O引擎或PolarDB PostgreSQL引擎时,该参数必填。
  • 当集群为PolarDB MySQL引擎时,
    • 如果目标可用区没有创建过vswitch时,则使用默认vswitch,该参数非必填。
    • 如果目标可用区已创建过vswitch时,该参数必填。
PlannedStartTime String 2021-01-14T09:00:00Z

开始执行定时(即在目标时间段内执行)变更主可用区任务的最早时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

说明
  • 开始时间的取值范围为未来24小时内的任意时间点。例如当前时间为2021-01-14T09:00:00Z,此处允许填入的开始时间范围为2021-01-14T09:00:00Z~2021-01-15T09:00:00Z
  • 若该参数留空,默认立即执行变更主可用区任务。
PlannedEndTime String 2021-01-14T09:30:00Z

开始执行目标定时任务的最晚时间。格式为YYYY-MM-DDThh:mm:ssZ(UTC)。

说明
  • 最晚时间需晚于开始时间的30分钟或以上。
  • 若设置了PlannedStartTime但未指定该参数,执行目标任务的最晚时间默认为开始时间+30分钟。例如当设置PlannedStartTime2021-01-14T09:00:00Z且该参数留空时,目标任务最晚将于2021-01-14T09:30:00Z开始执行。
FromTimeService Boolean false

立即执行或定时执行更换主可用区。取值:

  • false(默认值):定时执行
  • true:立即执行

返回数据

名称 类型 示例值 描述
RequestId String ED12C6FF-3261-4571-AB57-3570F6******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=ModifyDBClusterPrimaryZone
&DBClusterId=pc-**************
&ZoneId=cn-hangzhou-g
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBClusterPrimaryZoneResponse>
<RequestId>ED12C6FF-3261-4571-AB57-3570F6******</RequestId>
</ModifyDBClusterPrimaryZoneResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "ED12C6FF-3261-4571-AB57-3570F6******"
}

错误码

HttpCode 错误码 错误信息 描述
400 ScheduleTaskExist The specified cluster already has a scheduled task. 当前集群已存在待执行的定时任务。
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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