全部产品
Search

搜索本产品

    云原生数据库 PolarDB：ModifyDBClusterPrimaryZone - 更换PolarDB集群的可用区

    文档中心

    云原生数据库 PolarDB：ModifyDBClusterPrimaryZone - 更换PolarDB集群的可用区

    更新时间：Jun 17, 2024

    更换PolarDB集群的可用区。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    polardb:ModifyDBClusterPrimaryZoneWrite
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      无
    		无

    请求参数

    名称类型必填描述示例值
    DBClusterIdstring是

    集群 ID。

    说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息，包括集群 ID。
    		pc-**************
    ZoneIdstring是

    新的可用区 ID。

    说明 可通过接口 DescribeRegions 查看可用的可用区。
    		cn-hangzhou-g
    ZoneTypestring是

    更换的可用区类型。取值范围如下：

    • Primary：主可用区。
    • Standby：备可用区。
    		Primary
    VSwitchIdstring否

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

    说明
  • 当集群为 PolarDB O 引擎或 PolarDB PostgreSQL 引擎时，该参数必填。
  • 当集群为 PolarDB MySQL 引擎时，如果目标可用区没有创建过 Vswitch，则使用默认的 Vswitch，该参数非必填。如果目标可用区已创建过 Vswitch，该参数必填。
    •
    		vsw-**************
    IsSwitchOverForDisasterstring否

    是否回切原可用区，取值范围如下：

    • true：回切原可用区。
    • false：不回切原可用区。
    		false
    PlannedStartTimestring否

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

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

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

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

    立即执行或定时执行更换可用区。取值范围如下：

    • false（默认值）：定时执行。
    • true：立即执行。
    		false
    VPCIdstring否

    切换可用区支持指定的专有网络 ID。

    		vpc-**********

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    		ED12C6FF-3261-4571-AB57-3570F6******

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400ScheduleTaskExistThe specified cluster already has a scheduled task.当前集群已存在待执行的定时任务。
    400InvalidZoneId.MalformedThe specified parameter ZoneId is not valid.指定的参数ZoneId无效。
    400InvalidZoneId.SameThe specified parameter ZoneId is same with origin zoneId.指定的参数ZoneId与原点ZoneId相同。
    403ActionUnauthorizedThe specified action is not available for you.你不可以执行该操作。
    403OperationDenied.MutexLockThe operation is not permitted due to the mutex lock.由于互斥锁，不允许执行该操作。
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
    404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效
    404InsufficientResourceThe specified target zone has insufficient resources.当前选择的目标可用区资源不足
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.由于某些未知错误、异常或失败，请求处理失败。

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

    变更历史

    变更时间变更内容概要操作
    2024-02-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
      删除错误码：403
      删除错误码：404
      删除错误码：500
    入参OpenAPI 入参发生变更。
      新增入参：ZoneType
    2023-11-23OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 404 变更
      删除错误码：400
      删除错误码：403
      删除错误码：500
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 400 变更
      错误码 404 变更
      新增错误码：403
      新增错误码：500
    2023-07-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：IsSwitchOverForDisaster
    2023-06-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：400
      删除错误码：404
    入参OpenAPI 入参发生变更。
      新增入参：VPCId