DeleteCluster - 刪除叢集 - Container Service for Kubernetes

介面說明

風險提示：

叢集內訂用帳戶類型 ECS、靈駿計算節點等資源無法自動釋放，為避免不必要的費用，請您手動釋放。關於更多細節，請參見叢集刪除及節點釋放規則。
訂用帳戶類型的 APIServer SLB 資源無法自動釋放，為避免不必要的費用，請您手動釋放。
VPC、交換器、安全性群組、RamRole 如被其他資源佔用無法刪除時會預設保留，請您手動釋放。
通過虛擬節點建立的Elastic Container Instance 會被自動釋放。
部分通過叢集建立的雲資源在刪除叢集時不會被自動釋放，叢集刪除後會繼續計費，請根據實際需要釋放或保留。這些資源套件括：叢集自動建立的Log Service SLS Project；通過動態儲存裝置卷購買的雲端硬碟。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DeleteCluster

delete

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

無

請求文法

DELETE /clusters/{ClusterId} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。	c905d1364c2dd4b6284a3f41790c4****

請求參數

名稱	類型	必填	描述	樣本值
retain_all_resources	boolean	否	是否保留所有資源。如果設定該值為`true`，則會忽略`retain_resources`，通過`DescribeClusterResources`介面查詢到的通過叢集建立的雲資源將被保留。如果該值為`false`，請注意`delete_options`中預設保留的資源仍將被保留，如需刪除相關資源，請單獨在`delete_options`中設定`delete_mode`為`delete`。 `true`：保留所有資源，包含所有通過叢集建立的雲資源。 `false`：不保留所有資源（`delete_options`中定義的預設保留資源除外，如`ALB`在該參數取值為`false`時仍然保留）。預設值：`false`。	false
keep_slb `deprecated`	boolean	否	是否保留 SLB，取值： `true`：保留建立的 SLB 資源。 `false`：不保留建立的 SLB 資源。預設值：`false`。請使用`delete_options`中的`SLB`管理	false
retain_resources	array	否	資源清單。刪除叢集時如果需要保留資源，則需要提供對應資源的 ID。
	string	否	資源 ID。	sg-2ze6ess9kho6fdn9****
delete_options	array<object>	否	叢集關聯資源的刪除選項。
	object	否	特定類型資源的刪除選項。
resource_type	string	否	資源類型，可取值： SLB：通過 service 建立的 SLB 資源，預設刪除，可選擇保留。 ALB：ALB Ingress Controller 建立的 ALB 資源，預設保留，可選擇刪除。 SLS_Data：叢集日誌功能所使用的Log Service Project，預設保留，可選擇刪除。 SLS_ControlPlane：託管版叢集控制平面日誌所使用的Log Service Project，預設保留，可選擇刪除。 PrivateZone：ACK Serverless 叢集建立的 PrivateZone 資源，預設保留，可選擇刪除。	SLS_Data
delete_mode	string	否	該類型資源的刪除策略，可取值： delete：刪除該類資源。 retain：保留該類資源。	delete

返回參數

名稱	類型	描述	樣本值
	object	返回體資料。
cluster_id	string	叢集 ID。	cb95aa626a47740afbf6aa099b650****
request_id	string	請求 ID。	687C5BAA-D103-4993-884B-C35E4314****
task_id	string	任務 ID。	T-5a54309c80282e39ea****

樣本

正常返回樣本

JSON格式

{
  "cluster_id": "cb95aa626a47740afbf6aa099b650****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea****"
}

錯誤碼

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

變更歷史

更多資訊，參考變更詳情。