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

DescribeClustersV1 API を呼び出し、クラスタータイプやクラスター仕様などの条件に基づいて、アカウント内の ACK クラスターのリストを取得します。

今すぐお試しください

この 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:GetClusters

get

*Cluster

acs:cs:*:{#accountId}:cluster/*

なし

リクエスト構文

GET /api/v1/clusters HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
name	string	任意	クラスター名。	cluster-demo
cluster_type	string	任意	クラスタータイプ。 `Kubernetes` ：ACK 専用クラスター。 `ManagedKubernetes` ：ACK マネージドクラスター。これには、ACK マネージドクラスター (Pro Edition および Basic Edition)、ACK サーバーレスクラスター (Pro Edition および Basic Edition)、ACK エッジクラスター (Pro Edition および Basic Edition)、および ACK Lingjun クラスター (Pro Edition) が含まれます。 `ExternalKubernetes` ：登録済みクラスター。	Kubernetes
page_size	integer	任意	ページあたりのエントリー数。	10
page_number	integer	任意	ページ番号。	1
profile	string	任意	クラスターのサブタイプ。このパラメーターは、`cluster_type` が `ManagedKubernetes` に設定されている場合にのみ適用されます。 `Default` ：ACK マネージドクラスター。これには、Pro Edition および Basic Edition が含まれます。 `Edge` ：ACK エッジクラスター。これには、Pro Edition および Basic Edition が含まれます。 `Serverless` ：ACK サーバーレスクラスター。これには、Pro Edition および Basic Edition が含まれます。 `Lingjun` ：ACK Lingjun クラスター (Pro Edition)。	Default
cluster_spec	string	任意	クラスター仕様。このパラメーターは、`cluster_type` が `ManagedKubernetes` に設定され、`profile` パラメーターが指定されている場合にのみ適用されます。有効な値： `ack.standard` ：Basic Edition `ack.pro.small` ：Pro Edition `ack.pro.xlarge` ：Pro XL `ack.pro.2xlarge` ：Pro 2XL `ack.pro.4xlarge` ：Pro 4XL (アカウントを許可リストに追加するには、カスタマーサービスにお問い合わせください。) Pro XL、Pro 2XL、Pro 4XL は、ACK Pro プロビジョニング済みコントロールプレーンの 3 つの階層です。これらの階層は、専用のコントロールプレーンリソースを事前に割り当てて固定することで、API サーバーリクエストと Pod のスケジューリングで一貫して高いパフォーマンスを確保します。これらは、AI トレーニングと推論、非常に大規模なクラスター、およびミッションクリティカルなワークロードに最適です。 Pro Edition クラスター、およびプロビジョニング済みのコントロールプレーンを使用するクラスターのコストについては、「クラスター管理料金」をご参照ください。	ack.pro.small
region_id	string	任意	クラスターのリージョン。特定のリージョン内のクラスターをフィルタリングする場合に使用します。	cn-hangzhou
cluster_id	string	任意	クラスター ID。	c3fb96524f9274b4495df0f12a6b5****

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
clusters	array<object>	クラスターのリスト。
	array<object>	クラスターの詳細。
cluster_id	string	クラスターの ID。	c3fb96524f9274b4495df0f12a6b5****
cluster_type	string	クラスターのタイプ。	Kubernetes
created	string	クラスターが作成された時刻。	2025-04-07T09:57:26+08:00
init_version	string	クラスターの初期 Kubernetes バージョン。 ACK がサポートする Kubernetes バージョンの詳細については、「Kubernetes バージョンの概要」をご参照ください。	1.32.1-aliyun.1
current_version	string	クラスターの現在の Kubernetes バージョン。	1.32.1-aliyun.1
next_version	string	クラスターをアップグレードできるバージョン。	1.xx.x-aliyun.1
deletion_protection	boolean	クラスターの削除保護が有効かどうか。この機能は、コンソールや API オペレーションによるクラスターの誤削除を防ぎます。有効な値： `true`：削除保護が有効です。 `false`：削除保護が無効です。	true
docker_version `deprecated`	string	クラスターの Docker バージョン。	19.03.5
external_loadbalancer_id `deprecated`	string	Ingress 用のロードバランサーインスタンスの ID。デフォルトのインスタンスタイプは slb.s1.small (保証性能) です。	lb-2vcrbmlevo6kjpgch****
master_url	string	クラスターの API サーバーエンドポイント。内部エンドポイントとパブリックエンドポイントの両方を含みます。	{\"api_server_endpoint\":\"\",\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"}
meta_data	string	クラスターのメタデータ。	{\"Addons\":[{\"config\":***}}
name	string	クラスターの名前。	cluster-demo
network_mode `deprecated`	string	クラスターのネットワークモード。有効な値： `classic`：クラシックネットワーク。 `vpc`：VPC。 `overlay`：オーバーレイネットワーク。 `calico`：Calico ネットワーク。	vpc
private_zone `deprecated`	boolean	クラスターで PrivateZone が有効かどうか。有効な値： `true`：PrivateZone が有効です。 `false`：PrivateZone が無効です。	false
profile	string	クラスターのサブタイプ。	Default
region_id	string	クラスターがデプロイされているリージョンの ID。	cn-beijing
resource_group_id	string	クラスターが属するリソースグループの ID。	rg-acfmyvw3wjm****
security_group_id	string	クラスターが属するセキュリティグループの ID。	sg-2vcgwsrwgt5mp0yi****
container_cidr	string	Pod の CIDR ブロック。このパラメーターは、Flannel ネットワーク設定に使用されます。	172.20.xx.xx/16
service_cidr	string	Service の CIDR ブロック。	172.21.xx.xx/20
proxy_mode	string	kube-proxy のプロキシモード。 `iptables`：kube-proxy の成熟し、安定したプロキシモードです。iptables ルールを使用して、サービスの検出と負荷分散を行います。パフォーマンスは中程度で、クラスター内のサービス数に影響を受けます。このモードは、少数のサービスを実行するクラスターに適しています。 `ipvs`：kube-proxy の高性能なプロキシモードです。Linux IPVS モジュールを使用して、サービスの検出と負荷分散を行います。このモードは、多数のサービスを実行し、高性能な負荷分散を必要とするクラスターに適しています。	ipvs
timezone	string	クラスターのタイムゾーン。	Asia/Shanghai
ip_stack	string	クラスターの IP スタック。有効な値： `ipv4`：クラスターは IPv4 スタックを使用します。 `dual`：クラスターはデュアル IPv4/IPv6 スタックを使用します。	ipv4
cluster_domain	string	クラスターのドメイン名。	cluster.local
size	integer	クラスター内のマスターノードとワーカーノードの合計数。	5
state	string	クラスターの状態。有効な値： `initial`：作成中。 `failed`：作成に失敗。 `running`：実行中。 `updating`：更新中。 `upgrading`：アップグレード中。 `removing`：ノードを削除中。 `draining`：ノードをドレイン中。 `scaling`：スケーリング中。 `inactive`：非アクティブ。 `unavailable`：利用不可。 `deleting`：削除中。 `deleted`：削除済み。 `delete_failed`：削除に失敗。 `waiting`：接続待機中。 `disconnected`：切断状態。	running
subnet_cidr `deprecated`	string	このパラメーターは非推奨です。代わりに `container_cidr` パラメーターを使用してください。	null
tags	array	クラスターにアタッチされたタグ。
	tag	タグの詳細。
updated	string	クラスターが最後に更新された時刻。	2025-04-07T09:57:26+08:00
vpc_id	string	クラスターがデプロイされている VPC の ID。	vpc-2vcg932hsxsxuqbgl****
vswitch_id `deprecated`	string	vSwitch の ID。	vsw-2vc41xuumx5z2rdma**,vsw-2vc41xuumx5z2rdma**
vswitch_ids	array	コントロールプレーンに使用される vSwitch の ID のリスト。
	string	コントロールプレーンに使用される vSwitch の ID。	vsw-2vc41xuumx5z2rdma****
worker_ram_role_name `deprecated`	string	ワーカーノードに権限を付与するワーカー RAM ロールの名前。	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
zone_id `deprecated`	string	クラスターがデプロイされているアベイラビリティーゾーンの ID。	cn-beijing-b
cluster_spec	string	クラスターの仕様。	ack.standard
maintenance_window	maintenance_window	クラスターのメンテナンスウィンドウ。この機能は、ACK マネージドクラスターと ACK Serverless クラスターでのみ利用できます。
operation_policy	object	クラスターの自動 O&M ポリシー。
cluster_auto_upgrade	object	クラスターの自動アップグレード設定。
enabled	boolean	クラスターの自動アップグレードを有効にするかどうか。	true
channel	string	自動アップグレードチャネル。詳細については、「アップグレードチャネル」をご参照ください。有効な値： `patch`：最新のパッチバージョンにアップグレードします。 `stable`：2 番目に新しいマイナーバージョンにアップグレードします。 `rapid`：最新のマイナーバージョンにアップグレードします。	patch
page_info	object	ページネーション情報。
page_number	integer	ページ番号。	3
page_size	integer	ページあたりのエントリー数。	20
total_count	integer	返されたエントリーの合計数。	50

例

成功レスポンス

JSONJSON

{
  "clusters": [
    {
      "cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
      "cluster_type": "Kubernetes",
      "created": "2025-04-07T09:57:26+08:00",
      "init_version": "1.32.1-aliyun.1",
      "current_version": "1.32.1-aliyun.1",
      "next_version": "1.xx.x-aliyun.1",
      "deletion_protection": true,
      "docker_version": "19.03.5",
      "external_loadbalancer_id": "lb-2vcrbmlevo6kjpgch****",
      "master_url": "{\\\"api_server_endpoint\\\":\\\"\\\",\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.xx.xx:6443\\\"}",
      "meta_data": "{\\\"Addons\\\":[{\\\"config\\\":***}}",
      "name": "cluster-demo",
      "network_mode": "vpc",
      "private_zone": false,
      "profile": "Default",
      "region_id": "cn-beijing",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2vcgwsrwgt5mp0yi****",
      "container_cidr": "172.20.xx.xx/16",
      "service_cidr": "172.21.xx.xx/20",
      "proxy_mode": "ipvs",
      "timezone": "Asia/Shanghai",
      "ip_stack": "ipv4",
      "cluster_domain": "cluster.local",
      "size": 5,
      "state": "running",
      "subnet_cidr": "null",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "updated": "2025-04-07T09:57:26+08:00",
      "vpc_id": "vpc-2vcg932hsxsxuqbgl****",
      "vswitch_id": "vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****",
      "vswitch_ids": [
        "vsw-2vc41xuumx5z2rdma****"
      ],
      "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
      "zone_id": "cn-beijing-b",
      "cluster_spec": "ack.standard",
      "maintenance_window": {
        "enable": false,
        "maintenance_time": "2020-10-15T12:31:00.000+08:00",
        "duration": "3h",
        "weekly_period": "Monday,Thursday",
        "recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU"
      },
      "operation_policy": {
        "cluster_auto_upgrade": {
          "enabled": true,
          "channel": "patch"
        }
      }
    }
  ],
  "page_info": {
    "page_number": 3,
    "page_size": 20,
    "total_count": 50
  }
}

エラーコード

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

変更履歴

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