對PolarDB集群進行手動主備切換,可以指定一個只讀節點為新的主節點。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
polardb:FailoverDBCluster | update |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 數據庫集群 ID。 | pc-************** |
TargetDBNodeId | string | 否 | 將要切換為主節點的節點 ID,如果不填,則系統自動選舉。您可以通過接口 DescribeDBClusters 查詢節點 ID 等信息。 說明
| pi-*********** |
RollBackForDisaster | boolean | 否 | 是否是故障切換后的回切至原主可用區,取值范圍如下:
| false |
ClientToken | string | 否 | 用于保證請求的冪等性,防止重復提交請求。由客戶端生成該參數值,保證在不同請求間唯一,大小寫敏感、不超過 64 個 ASCII 字符。 | 6000170000591aed949d0f54a343f1a4233c1e7d1c5****** |
TargetZoneType | string | 否 | 是否是主可用區內主備切換,取值如下:
| Primary |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | HaStatusNotSupport | Current DB instance HA status does not support this operation. | 實例的HA狀態不支持該操作 |
400 | InvalidDBNodeId.Malformed | The specified parameter DBNodeId is not valid. | 指定的參數DBNodeId無效。 |
400 | InvalidDBType.Malformed | The Specified DBType is not valid. | 指定的數據庫類型無效. |
400 | UnsupportHighFrequenceSwitchOver | The instance has switch over too frequent within ten minutes. | 當前切換過于頻繁,建議5分鐘后重試 |
400 | UnsupportWitchUnhealthyReplication | The action is unsupported with unhealthy replication. | 當前復制關系異常,不支持切換至存儲熱備集群 |
403 | OperationDenied.DBNodeType | The operation is not permitted due to type of node. | 操作失敗,節點類型不允許此操作。 |
403 | OperationDenied.ClusterCategory | The operation is not permitted due to cluster category. | 該集群不支持此產品系列。 |
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 當前的記錄中不存在提供的DBClusterId。 |
404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的參數DBClusterId無效 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-08-08 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-12-07 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-09-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-06-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |