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

現在のアカウントで、クラスタータイプやクラスタースペックなどの指定された条件を満たす 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	任意	クラスター名。	クラスター-demo
cluster_type	string	任意	クラスタータイプ。有効な値: Kubernetes: ACK 専用クラスター。 ManagedKubernetes: ACK マネージドクラスタータイプ。ACK マネージドクラスター (Pro および Basic)、サーバーレス Kubernetes クラスター (Pro および Basic)、ACK エッジクラスター (Pro および Basic)、ACK Lingjun クラスター (Pro) を含みます。 ExternalKubernetes: 登録済みクラスター。	Kubernetes
page_size	integer	任意	1 ページあたりのレコード数。	10
page_number	integer	任意	現在のページ番号。	1
profile	string	任意	cluster_type を ManagedKubernetes に設定した場合、ACK クラスターの子クラスをさらに指定できます。有効な値: Default: ACK マネージドクラスター。ACK クラスター Pro および ACK クラスター Basic を含みます。 Edge: ACK エッジクラスター。ACK エッジクラスター Pro および ACK エッジクラスター Basic を含みます。 Serverless: サーバーレス Kubernetes クラスター。サーバーレス Kubernetes クラスター Pro およびサーバーレス Kubernetes クラスター Basic を含みます。 Lingjun: ACK Lingjun クラスター。Pro で利用可能です。	Default
cluster_spec	string	任意	cluster_type を ManagedKubernetes にセットし、プロファイル (profile) を構成した場合のクラスタースペック。有効な値: ack.standard: Basic ack.pro.small: プロ版 ack.pro.xlarge: プロ版 XL ack.pro.2xlarge: プロ版 2XL ack.pro.4xlarge: プロ版 4XL (ホワイトリストに追加するには、連絡先であるカスタマーサービスにお問い合わせください) プロ版 XL、プロ版 2XL、およびプロ版 4XL は、コンテナサービス ACK Pro Provisioned Control Plane によって提供される 3 つのティアです。コントロールプレーンリソースを事前割り当ておよび専用化することで、これらのティアは API の同時実行数と Pod のスケジューリング機能が一貫して高レベルに維持されることを保証します。AI トレーニングおよび推論、超大規模クラスター、および重大なワークロードに適しています。プロ版およびプロビジョニング済みコントロールプレーンプロダクトのクラスター管理料金については、クラスター管理料金をご参照ください。	ack.pro.small
region_id	string	任意	クラスターのリージョン。指定されたリージョンのクラスターをフィルター処理するには、このパラメーターを指定します。	cn-hangzhou
cluster_id	string	任意	クラスターの ID。	c3fb96524f9274b4495df0f12a6b5****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
clusters	array<object>	クラスター情報のリスト。
	array<object>	クラスターインスタンス。
cluster_domain	string	クラスターのローカルドメイン名。	クラスター.local
cluster_id	string	クラスターの ID。	c3fb96524f9274b4495df0f12a6b5****
cluster_spec	string	クラスターのスペック。	ack.standard
cluster_type	string	クラスターのタイプ。	Kubernetes
container_cidr	string	Pod の CIDR ブロック。これは Flannel ネットワーク構成です。	172.20.xx.xx/16
created	string	クラスターが作成された時間。	2025-04-07T09:57:26+08:00
current_version	string	クラスターの現在のバージョン。	1.32.1-aliyun.1
deletion_protection	boolean	クラスターの削除保護が有効かどうかを示します。削除保護は、コンソールまたは API オペレーションの呼び出しによるクラスターの誤削除を防ぎます。有効な値: true: 削除保護が有効です。コンソールまたは API オペレーションの呼び出しでクラスターを削除できません。 false: 削除保護が無効です。コンソールまたは API オペレーションの呼び出しでクラスターを削除できます。	true
docker_version `deprecated`	string	クラスターの Docker バージョン。	19.03.5
external_loadbalancer_id `deprecated`	string	クラスターの Ingress 用の SLB インスタンス。デフォルトインスタンスタイプ: パフォーマンス保証インスタンス (slb.s1.small)。	lb-2vcrbmlevo6kjpgch****
init_version	string	クラスターの初期 Kubernetes バージョン。ACK でサポートされている Kubernetes バージョンの詳細については、「Kubernetes バージョンリリースノート」を参照してください。	1.32.1-aliyun.1
ip_stack	string	クラスターの IP プロトコルスタック。有効な値: ipv4: IPv4 プロトコルスタックのみをサポートするクラスターを作成します。 dual: IPv4/IPv6 デュアルスタックをサポートするクラスターを作成します。	ipv4
maintenance_window	maintenance_window	クラスターのメンテナンスウィンドウ。この特徴は、ACK マネージドクラスターおよびサーバーレス Kubernetes クラスターに対してのみ効果があります。
master_url	string	内部ネットワークアクセスアドレスおよびパブリックネットワークアクセスアドレスを含む、クラスター API サーバーのアクセスアドレス。	{"api_サーバー_endpoint":"","intranet_api_サーバー_endpoint":"https://192.168.xx.xx:6443"}
meta_data	string	クラスターのメタデータ。	{"Addons":[{"config":***}}
name	string	クラスター名。	クラスター-demo
network_mode `deprecated`	string	クラスターのネットワークモード。有効な値: classic: クラシックネットワーク。 vpc: 仮想非公開クラウド (VPC)。 overlay: オーバーレイネットワーク。 calico: Calico プロトコルネットワーク。	vpc
next_version	string	クラスターのスペックアップ先バージョン。	1.xx.x-aliyun.1
operation_policy	object	クラスターの自動 O&M ポリシー。
cluster_auto_upgrade	object	クラスターの自動スペックアップ構成。
channel	string	クラスターの自動スペックアップ周波数。詳細については、「スペックアップ周波数」を参照してください。有効な値: patch: 最新のパッチバージョン。 stable: 2 番目に新しいマイナーバージョン。 rapid: 最新のマイナーバージョン。	パッチ
enabled	boolean	クラスターの自動スペックアップが有効かどうかを示します。	true
private_zone `deprecated`	boolean	クラスターのプライベートゾーン構成。有効な値: true: プライベートゾーンが有効です。 false: プライベートゾーンが無効です。	false
profile	string	クラスターのサブタイプ。	Default
proxy_mode	string	kube-proxy プロキシモード。 iptables: 成熟して安定した kube-proxy プロキシモード。このモードでは、サービス検出と負荷分散に iptables ルールを使用します。パフォーマンスは平均的で、クラスター規模の影響を受けます。このモードは、small 数のサービスを含むクラスターに適しています。 ipvs: 高性能な kube-proxy プロキシモード。このモードでは、サービス検出と負荷分散に Linux IPVS モジュールを使用します。このモードは、large 数のサービスを含み、高性能な負荷分散を必要とするクラスターに適しています。	ipvs
region_id	string	クラスターがデプロイされているリージョンの ID。	cn-beijing
resource_group_id	string	クラスターのリソースグループ ID。	rg-acfmyvw3wjm****
security_group_id	string	クラスターのセキュリティグループ ID。	sg-2vcgwsrwgt5mp0yi****
service_cidr	string	サービスの CIDR ブロック。	172.21.xx.xx/20
size	integer	Master ノードとワーカーノードを含む、クラスター内の現在のノード数。	5
state	string	クラスターの実行ステータス。有効な値: initial: クラスターを作成中です。 failed: クラスターの作成に失敗した。 running: クラスターは実行中です。 updating: クラスターを更新中です。 upgrading: クラスターをスペックアップ中です。 removing: ノードを削除中です。 draining: ノードをドレイン中です。 scaling: クラスターをスケーリング中です。 inactive: クラスターは非アクティブです。 unavailable: クラスターは利用できません。 deleting: クラスターを削除中です。 deleted: クラスターは削除されました。 delete_failed: クラスターの削除に失敗しました。 waiting: クラスターはアクセス状態にあり、接続待ちです。 disconnected: クラスターは切断されています。	実行中
subnet_cidr `deprecated`	string	[非推奨] Pod CIDR ブロックを取得するにはコンテナ (container_cidr) を使用してください。	null
tags	array	クラスターのリソースタグ。
	tag	クラスターのリソースタグ。
timezone	string	タイムゾーン。	Asia/Shanghai
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。
	string	クラスターコントロールプレーン用の vSwitch。	vsw-2vc41xuumx5z2rdma****
worker_ram_role_name `deprecated`	string	ECS インスタンスがクラスターのワーカーノードとして機能することを許可する Worker RAM ロール名。	KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****
zone_id `deprecated`	string	クラスターのゾーン ID。	cn-beijing-b
page_info	object	ページネーション情報。
page_number	integer	ページ番号。	3
page_size	integer	1 ページあたりのエントリ数。	20
total_count	integer	結果の総数。	50

例

成功レスポンス

JSONJSON

{
  "clusters": [
    {
      "cluster_domain": "クラスター.local",
      "cluster_id": "c3fb96524f9274b4495df0f12a6b5****",
      "cluster_spec": "ack.standard",
      "cluster_type": "Kubernetes",
      "container_cidr": "172.20.xx.xx/16",
      "created": "2025-04-07T09:57:26+08:00",
      "current_version": "1.32.1-aliyun.1",
      "deletion_protection": true,
      "docker_version": "19.03.5",
      "external_loadbalancer_id": "lb-2vcrbmlevo6kjpgch****",
      "init_version": "1.32.1-aliyun.1",
      "ip_stack": "ipv4",
      "maintenance_window": {
        "duration": "3h",
        "enable": false,
        "exclusions": [
          {
            "description": "凍結期間中はすべての変更が禁止されます",
            "end_time": "2026-11-15T00:00:00+08:00",
            "scope": "NoOperations",
            "start_time": "2026-11-01T00:00:00+08:00"
          }
        ],
        "maintenance_time": "2020-10-15T12:31:00.000+08:00",
        "recurrence": "FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU",
        "weekly_period": "Monday,Thursday"
      },
      "master_url": "{\"api_サーバー_endpoint\":\"\",\"intranet_api_サーバー_endpoint\":\"https://192.168.xx.xx:6443\"}",
      "meta_data": "{\"Addons\":[{\"config\":***}}",
      "name": "クラスター-demo",
      "network_mode": "vpc",
      "next_version": "1.xx.x-aliyun.1",
      "operation_policy": {
        "cluster_auto_upgrade": {
          "channel": "パッチ",
          "enabled": true
        }
      },
      "private_zone": false,
      "profile": "Default",
      "proxy_mode": "ipvs",
      "region_id": "cn-beijing",
      "resource_group_id": "rg-acfmyvw3wjm****",
      "security_group_id": "sg-2vcgwsrwgt5mp0yi****",
      "service_cidr": "172.21.xx.xx/20",
      "size": 5,
      "state": "実行中",
      "subnet_cidr": "null",
      "tags": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "timezone": "Asia/Shanghai",
      "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"
    }
  ],
  "page_info": {
    "page_number": 3,
    "page_size": 20,
    "total_count": 50
  }
}

エラーコード

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

変更履歴

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