すべてのプロダクト
Search

このプロダクト

    Container Service for Kubernetes:DescribeClustersV1

    ドキュメントセンター

    Container Service for Kubernetes:DescribeClustersV1

    最終更新日:May 21, 2026

    DescribeClustersV1 API を使用して、クラスタータイプやクラスター仕様などの条件に基づいて Container Service for Kubernetes (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 および Standard)、ACK Serverless クラスター (Pro および Standard)、ACK Edge クラスター (Pro および Standard)、および ACK Lingjun クラスター (Pro) が含まれます。

    • ExternalKubernetes： 登録済みクラスター。

    Kubernetes
    page_size

    integer

    任意

    1ページあたりのエントリー数。

    10
    page_number

    integer

    任意

    ページ番号。

    1
    profile

    string

    任意

    cluster_type が ManagedKubernetes に設定されている場合、クラスターのサブタイプをさらに指定できます。

    • Default： ACK マネージドクラスター。これには ACK Pro クラスターと ACK Standard クラスターが含まれます。

    • Edge： ACK Edge クラスター。これには ACK Edge Pro クラスターと ACK Edge Standard クラスターが含まれます。

    • Serverless： ACK Serverless クラスター。これには ACK Serverless Pro クラスターと ACK Serverless Standard クラスターが含まれます。

    • Lingjun： ACK Lingjun クラスター (Pro edition)。

    Default
    cluster_spec

    string

    任意

    クラスター仕様。このパラメーターは、cluster_type が ManagedKubernetes に設定され、かつ profile パラメーターが指定されている場合にのみ有効です。有効な値：

    • ack.standard： Standard

    • ack.pro.small： Pro

    • 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 版およびプロビジョニング済みコントロールプレーン版のクラスター管理料金については、「クラスター管理料金」をご参照ください。

    ack.pro.small
    region_id

    string

    任意

    クラスターが属するリージョンの ID。

    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

    クラスターの初期バージョン。ACK でサポートされている Kubernetes バージョンの詳細については、「Kubernetes リリースの概要」をご参照ください。

    1.32.1-aliyun.1
    current_version

    string

    クラスターの現在のバージョン。

    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 に使用される Server Load Balancer (SLB) インスタンスの 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 ：安定かつ成熟したプロキシモード。Kubernetes Service のサービス検出と負荷分散は、iptables ルールを使用して実装されます。このモードは、適度なパフォーマンスを提供し、Service の数が少ないクラスターに適しています。

    • ipvs ：高性能プロキシモード。Kubernetes Service のサービス検出と負荷分散は、Linux IP Virtual Server (IPVS) モジュールを使用して実装されます。このモードは、Service 数が多く、高性能な負荷分散を必要とするクラスターに適しています。

    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

    このパラメーターは非推奨です。Pod の CIDR ブロックを取得するには、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 ロールの名前。このロールは、Elastic Compute Service (ECS) インスタンスをワーカーノードとして使用することを許可するために使用されます。

    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 サーバーレスクラスターでのみ利用できます。

    operation_policy

    object

    クラスターの自動運用保守ポリシー。

    cluster_auto_upgrade

    object

    クラスターの自動アップグレードポリシー。

    enabled

    boolean

    クラスターの自動アップグレードが有効かどうかを示します。

    true
    channel

    string

    アップグレードチャネル。詳細については、「アップグレードチャネル」をご参照ください。

    有効な値：

    • patch ：利用可能な最新のパッチバージョンにクラスターをアップグレードします。

    • stable ：最新の安定したマイナーバージョンにクラスターをアップグレードします。このバージョンは通常、2 番目に新しいマイナーバージョンです。

    • rapid ：利用可能な最新のマイナーバージョンにクラスターをアップグレードします。

    patch
    page_info

    object

    ページネーション情報。

    page_number

    integer

    ページ番号。

    3
    page_size

    integer

    1 ページあたりのエントリー数。

    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
  }
}

    エラーコード

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

    変更履歴

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