更換PolarDB集群的可用區。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
polardb:ModifyDBClusterPrimaryZone | Write |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 集群 ID。 說明
您可以調用 DescribeDBClusters 接口查看目標地域下所有的集群信息,包括集群 ID。
| pc-************** |
ZoneId | string | 是 | 新的可用區 ID。 說明
可通過接口 DescribeRegions 查看可用的可用區。
| cn-hangzhou-g |
ZoneType | string | 是 | 更換的可用區類型。取值范圍如下:
| Primary |
VSwitchId | string | 否 | 目標可用區的虛擬交換機(VSwitch)ID。 說明
| vsw-************** |
IsSwitchOverForDisaster | string | 否 | 是否回切原可用區,取值范圍如下:
| false |
PlannedStartTime | string | 否 | 開始執行定時(即在目標時間段內執行)變更可用區任務的最早時間。格式為 說明
2021-01-14T09:00:00Z ,此處允許填入的開始時間范圍為2021-01-14T09:00:00Z ~2021-01-15T09:00:00Z 。 | 2021-01-14T09:00:00Z |
PlannedEndTime | string | 否 | 開始執行目標定時任務的最晚時間。格式為 說明
PlannedStartTime 但未指定該參數,執行目標任務的最晚時間默認為開始時間+30 分鐘 。例如當設置PlannedStartTime 為2021-01-14T09:00:00Z 且該參數留空時,目標任務最晚將于2021-01-14T09:30:00Z 開始執行。 | 2021-01-14T09:30:00Z |
FromTimeService | boolean | 否 | 立即執行或定時執行更換可用區。取值范圍如下:
| false |
VPCId | string | 否 | 切換可用區支持指定的專有網絡 ID。 | vpc-********** |
返回參數
示例
正常返回示例
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相同。 |
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. | 當前選擇的目標可用區資源不足 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 由于某些未知錯誤、異常或失敗,請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2024-02-27 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-11-23 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-09-12 | OpenAPI 錯誤碼發生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-07-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||||||||
| ||||||||||||||||
2023-06-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 看變更集 | ||||||||||||||
|