全部產品
Search

搜尋本產品

    PolarDB：ModifyDBClusterPrimaryZone - 更換PolarDB叢集的可用性區域

    文件中心

    PolarDB：ModifyDBClusterPrimaryZone - 更換PolarDB叢集的可用性區域

    更新時間：Dec 11, 2025

    更換PolarDB叢集的可用性區域。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:ModifyDBClusterPrimaryZone

    update

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    說明

    您可以調用 DescribeDBClusters 介面查看目標地區下所有的叢集資訊，包括叢集 ID。

    pc-**************
    ZoneId

    string

    是

    新的可用性區域 ID。

    說明

    可通過介面 DescribeRegions 查看可用的可用性區域。

    cn-hangzhou-g
    ZoneType

    string

    否

    更換的可用性區域類型。取值範圍如下：

    • Primary：主可用性區域。

    • Standby：備可用性區域。

    Primary
    VSwitchId

    string

    否

    目標可用性區域的虛擬交換器（VSwitch）ID。

    說明

    • 當叢集為 PolarDB O 引擎或 PolarDB PostgreSQL 引擎時，該參數必填。

    • 當叢集為 PolarDB MySQL 引擎時，如果目標可用性區域沒有建立過 Vswitch，則使用預設的 Vswitch，該參數非必填。如果目標可用性區域已建立過 Vswitch，該參數必填。

    vsw-**************
    IsSwitchOverForDisaster

    string

    否

    是否回切原可用性區域，取值範圍如下：

    • true：回切原可用性區域。

    • false：不回切原可用性區域。

    false
    PlannedStartTime

    string

    否

    開始執行定時（即在目標時間段內執行）變更可用性區域任務的最早時間。格式為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
    PlannedEndTime

    string

    否

    開始執行目標定時任務的最晚時間。格式為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
    FromTimeService

    boolean

    否

    立即執行或定時執行更換可用性區域。取值範圍如下：

    • false（預設值）：定時執行。

    • true：立即執行。

    false
    VPCId

    string

    否

    切換可用性區域支援指定的專用網路 ID。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ScheduleTaskExist The specified cluster already has a scheduled task. 當前叢集已存在待執行的定時任務。
    400 InvalidZoneId.Malformed The specified parameter ZoneId is not valid. 指定的參數ZoneId無效。
    400 InvalidZoneId.Same The specified parameter ZoneId is same with origin zoneId. 指定的參數ZoneId與原點ZoneId相同。
    500 InternalError The request processing has failed due to some unknown error, exception or failure. 由於某些未知錯誤、異常或失敗，請求處理失敗。
    403 ActionUnauthorized The specified action is not available for you. 你不可以執行該操作。
    403 OperationDenied.MutexLock The operation is not permitted due to the mutex lock. 由於互斥鎖，不允許執行該操作。
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效
    404 InsufficientResource The specified target zone has insufficient resources. 當前選擇的目標可用性區域資源不足

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。