DeleteInstances - 釋放 OceanBase 執行個體

更新時間:
Copy as MD

調用介面釋放 OceanBase 執行個體。

介面說明

調用該介面時,執行個體必須滿足以下條件,否則將操作失敗:

  • 執行個體狀態為運行中;

  • 執行個體類型為主執行個體(隨用隨付類型)。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DeleteInstances

delete

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#instanceId}/*

請求參數

名稱

類型

必填

描述

樣本值

InstanceIds

string

需刪除的叢集 ID。
格式為 JSON 數組的字串。

["ob317v4uif****","ob627v4uif****"]

BackupRetainMode

string

叢集刪除後的備份保留原則。取值如下:

  • receive_all:保留全部備份組;

  • delete_all:刪除全部備份組;

  • receive_last:保留最後一個備份組。

說明


預設值為 delete_all。

delete_all

DryRun

boolean

是否只預檢此次請求, 預設為 false。取值範圍:

  • true:發送檢查請求,不會刪除執行個體。如果檢查通過,則返回 DryRunResult=true, 如果檢查不通過, 則返回相應錯誤的錯誤碼。

  • false(預設):發送正常請求,通過檢查後直接刪除執行個體。如果 DryRun 填寫為 false, 則表示不進行預檢查, DryRunResult 預設返回 false。

false

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

Data

object

返回資料。

DryRunResult

boolean

預檢查請求的結果。

  • 如果 DryRun 填寫為 true,當預檢查請求通過,則 DryRunResult 返回 true,否則返回相應的錯誤碼資訊。

  • 如果 DryRun 填寫為 false, 則表示不進行預檢查, DryRunResult 預設返回 false。

false

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "DryRunResult": false
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 BadRequest BadRequest
500 InternalServerError InternalServerError
404 InstanceStatus.Invalid InstanceStatus.Invalid
404 StandbyInstance.StillOnline StandbyInstance.StillOnline
404 UnknownError UnknownError
404 Tenant.StillOnline Tenant.StillOnline
404 ServiceTemporarilyUnavailable ServiceTemporarilyUnavailable
404 NotFound NotFound

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

變更歷史

更多資訊,參考變更詳情