SwitchoverInstance - 切換主備執行個體

更新時間:
Copy as MD

切換 OceanBase 主備執行個體。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:SwitchoverInstance

update

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

string

主備執行個體 ID,預設可以使用需要切換為主執行個體的執行個體 ID。

ob317v4uif****

TargetInstanceId

string

需要切換為主執行個體的執行個體 ID。

ob4bv8o7sp****

Forced

boolean

是否強制切換主備執行個體。取值範圍:

  • true:表示強制切換主備執行個體。

  • false:表示不強制切換主備執行個體。

true

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

473469**-AA6F-4D**-B3DB-A***********

Data

object

切換主備執行個體資料列表。

Message

string

切換主備執行個體資訊。

delete tag-value success

Success

boolean

是否修改成功。

  • true:修改成功。

  • false:修改失敗。

true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469**-AA6F-4D**-B3DB-A***********",
  "Data": {
    "Message": "delete tag-value success",
    "Success": true
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情