華為云計算 云知識 刪除彈性云服務(wù)器DeleteServers
刪除彈性云服務(wù)器DeleteServers

功能介紹

根據(jù)指定的 云服務(wù)器 ID列表,刪除云服務(wù)器。

本接口為異步接口,當前刪除云服務(wù)器請求下發(fā)成功后會返回job_id,此時刪除云服務(wù)器并沒有立即完成,需要通過調(diào)用查詢?nèi)蝿?wù)的執(zhí)行狀態(tài)查詢job狀態(tài),當Job狀態(tài)為 SUC CES S 時代表云服務(wù)器刪除成功。

系統(tǒng)支持刪除單臺云服務(wù)器和批量刪除多臺云服務(wù)器操作,批量刪除云服務(wù)器時,一次最多可以刪除1000臺。

僅支持刪除按需計費的云服務(wù)器。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

POST /v1/{project_id}/cloudservers/delete

參數(shù)說明請參見表1。
表1 參數(shù)說明

參數(shù)

是否必選

描述

project_id

項目ID。

獲取方法請參見獲取項目ID。

請求消息

請求參數(shù)如表2所示。
表2 請求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

servers

Array of objects

所需要刪除的云服務(wù)器列表,詳情請參見表3。

delete_publicip

Boolean

配置刪除云服務(wù)器是否刪除云服務(wù)器綁定的 彈性公網(wǎng)IP 。如果選擇不刪除,則系統(tǒng)僅做解綁定操作,保留彈性 公網(wǎng)IP 資源。

取值為true或false。

  • true:刪除云服務(wù)器時,無論掛載在云服務(wù)器上的彈性公網(wǎng)IP的delete_on_termination字段為true或false,都會同時刪除該彈性公網(wǎng)IP
  • false:刪除云服務(wù)器時,無論掛載在云服務(wù)器上的彈性公網(wǎng)IP的delete_on_termination字段為true或false,僅做解綁操作,不刪除該彈性公網(wǎng)IP
說明:

若未設(shè)置delete_publicip參數(shù),彈性公網(wǎng)IP是否隨實例釋放依賴于該彈性公網(wǎng)IP的delete_on_termination字段。

  • delete_on_termination為true,delete_public為null,該彈性公網(wǎng)IP會被刪除。
  • delete_on_termination為false,delete_public為null,該彈性公網(wǎng)IP僅做解綁操作,不會被刪除。

delete_volume

Boolean

配置刪除云服務(wù)器是否刪除云服務(wù)器對應(yīng)的數(shù)據(jù)盤,如果選擇不刪除,則系統(tǒng)僅做卸載操作,保留 云硬盤 資源。默認為false。

  • true:刪除云服務(wù)器時會同時刪除掛載在云服務(wù)器上的數(shù)據(jù)盤。
  • false:刪除云服務(wù)器時,僅卸載云服務(wù)器上掛載的數(shù)據(jù)盤,不刪除該數(shù)據(jù)盤。
表3 servers字段數(shù)據(jù)結(jié)構(gòu)說明

參數(shù)

是否必選

參數(shù)類型

描述

id

String

需要刪除的云服務(wù)器ID。

響應(yīng)消息

請參考響應(yīng)(任務(wù)類)。

請求示例

刪除ID為“616fb98f-46ca-475e-917e-2563e5a8cd19”的云服務(wù)器,并解綁彈性公網(wǎng)IP、卸載數(shù)據(jù)盤。
POST https://{endpoint}/v1/{project_id}/cloudservers/delete

{
    "servers": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19"
        }
    ], 
    "delete_publicip": false, 
    "delete_volume": false
   }

響應(yīng)示例

{
    "job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}

{
    "error": {
        "message": "request body is illegal.", 
        "code": "Ecs.0005"
    }
}

返回值

請參考通用請求返回值。

錯誤碼

請參考錯誤碼