DeleteCluster - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

操作説明

重要

Elastic Compute Service (ECS) インスタンスや Lingjun コンピューティングノードなどのサブスクリプションベースのリソースは自動的にリリースされません。不要な料金を避けるために、手動でリリースする必要があります。詳細については、「クラスターの削除とノードのリリースルール」をご参照ください。
サブスクリプションベースの APIServer SLB リソースは自動的にリリースされません。不要な料金を避けるために、手動でリリースする必要があります。
VPC、VSwitch、セキュリティグループ、Resource Access Management (RAM) ロールなどのリソースが他のリソースで使用中の場合、デフォルトで保持されます。手動でリリースする必要があります。
仮想ノードで作成された ECI は自動的にリリースされます。
クラスターと共に作成された一部のクラウドリソースは、クラスターを削除しても自動的にリリースされず、課金が継続されます。これらのリソースを保持するかリリースするかを選択できます。これらのリソースには、クラスターによって自動的に作成された SLS プロジェクトや、動的ボリュームを介して購入したクラウドディスクが含まれます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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`：関連するすべてのクラウドリソースを保持しません。このパラメーターを `false` に設定しても、`delete_options` パラメーターでデフォルトで保持するように設定されているリソース (`ALB` など) は保持されます。デフォルト値：`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 コントローラーによって作成された ALB リソース。これらのリソースはデフォルトで保持されますが、削除することも選択できます。 SLS_Data：クラスターログに使用される SLS プロジェクト。このリソースはデフォルトで保持されますが、削除することも選択できます。 SLS_ControlPlane：マネージドクラスターのコントロールプレーンログに使用される SLS プロジェクト。このリソースはデフォルトで保持されますが、削除することも選択できます。 PrivateZone：Container Service for Kubernetes (ACK) サーバーレスクラスターによって作成された 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****

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。