すべてのプロダクト
Search
ドキュメントセンター

Container Service for Kubernetes:DescribeClusterDetail

最終更新日:Jul 16, 2026

クラスター ID を指定して、特定のクラスターの詳細を照会します。

今すぐお試しください

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

get

*Cluster

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

なし なし

リクエスト構文

GET /clusters/{ClusterId} HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

ClusterId

string

必須

クラスターの ID。

cdde1f21ae22e483ebcb068a6eb7f****

リクエストパラメーター

パラメーター

必須 / 任意

説明

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド

説明

object

レスポンスボディ。

cluster_id

string

クラスターの ID。

c82e6987e2961451182edacd74faf****

cluster_type

string

クラスターのタイプ。

  • Kubernetes: ACK 専用クラスター。

  • ManagedKubernetes: ACK クラスタータイプ。ACK クラスター (コンテナサービス ACK Pro および ACK Basic)、サーバーレス Kubernetes クラスター (プロ版および Basic)、ACK エッジクラスター (プロ版および Basic)、ACK Lingjun クラスター (プロ版) を含みます。

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

Kubernetes

created

string

クラスターが作成された時間。

2025-04-07T09:57:26+08:00

init_version

string

クラスターの初期 Kubernetes バージョン。

1.32.1-aliyun.1

current_version

string

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

1.32.1-aliyun.1

next_version

string

クラスターをスペックアップできる Kubernetes バージョン。

1.xx.x-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 に関連付けられている Server Load Balancer (SLB) のインスタンス ID。

lb-2zehc05z3b8dwiifh****

meta_data

string

クラスターのメタデータ。

\"Addons\":***

name

string

クラスターの名前。

cluster-demo

network_mode deprecated

string

クラスターで使用されているネットワークタイプ (VPC など)。

vpc

region_id

string

クラスターがデプロイされているリージョンの ID。

cn-beijing

resource_group_id

string

クラスターが属するリソースグループの ID。

rg-acfmyvw3wjm****

security_group_id

string

クラスターに関連付けられているセキュリティグループの ID。

sg-25yq****

size

integer

クラスター内のノード数 (Master ノードとワーカーノードを含む)。

5

state

string

クラスターのステータス。有効な値:

  • initial: クラスターを作成中です。

  • failed: クラスターの作成に失敗した。

  • running: クラスターは実行中です。

  • updating: クラスターを更新中です。

  • upgrading: クラスターをスペックアップ中です。

  • removing: ノードを削除中です。

  • draining: ノードをドレイン中です。

  • scaling: クラスターをスケーリング中です。

  • inactive: クラスターは非アクティブです。

  • unavailable: クラスターは使用できません。

  • deleting: クラスターを削除中です。

  • deleted: クラスターは削除されました。

  • delete_failed: クラスターの削除に失敗しました。

  • waiting: クラスターはアクセス状態にあり、接続待ちです。

  • disconnected: クラスターは切断されています。

running

tags

array

クラスターのリソースタグ。

tag

クラスターのリソースタグ。

updated

string

クラスターが最後に更新された時間。

2025-04-10T13:28:09+08:00

vpc_id

string

クラスターで使用されている非公開 VPC の ID。クラスター作成時にこのパラメーターは必須です。

vpc-2zecuu62b9zw7a7qn****

vswitch_id deprecated

string

vSwitch の ID。このフィールドは非推奨です。コントロールプレーンの vSwitch をクエリするには、vswitch_ids を使用してください。データプレーンの vSwitch をクエリするには、ノードプール構成内の vswitch_ids を使用してください。

vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****

subnet_cidr deprecated

string

Pod の CIDR ブロック。

172.20.xx.xx/16

zone_id deprecated

string

クラスターがデプロイされているゾーンの ID。

cn-beijing-a

master_url

string

クラスターのアクセスアドレス (内部ネットワークアクセスアドレスおよびパブリックネットワークアクセスアドレスを含む)。

{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***}

private_zone deprecated

boolean

クラスターで PrivateZone が有効かどうかを示します。

  • true: 有効。

  • false: 無効。

デフォルト値: false。

false

profile

string

クラスターの子クラス。

  • Default: ACK マネージドクラスター (ACK クラスター プロ版および ACK クラスター Basic を含む)。

  • Edge: ACK エッジクラスター (ACK エッジクラスター プロ版および ACK エッジクラスター Basic を含む)。

  • Serverless: サーバーレス Kubernetes クラスター (サーバーレス Kubernetes クラスター プロ版およびサーバーレス Kubernetes クラスター Basic を含む)。

  • Lingjun: ACK Lingjun クラスター (プロ版で利用可能)。

Default

cluster_spec

string

cluster_typeManagedKubernetes に設定され、profile が構成されている場合のクラスターのプロダクト仕様。有効な値:

  • ack.standard: Basic (値が空の場合にデフォルトで選択されます)

  • ack.pro.small: プロ版

  • 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 トレーニングや推論、超大規模クラスター、重大なワークロードに適しています。

プロ版およびプロビジョニング済みコントロールプレーンエディションのクラスター管理料金の詳細については、「クラスター管理料金」をご参照ください。

ack.pro.small

worker_ram_role_name

string

ECS インスタンスにクラスターのワーカーノードとしての権限を付与するワーカー RAM ロールの名前。

KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****

maintenance_window maintenance_window

クラスターのメンテナンスウィンドウ構成。この構成は、マネージドクラスター (コンテナサービス ACK Pro クラスター) に対してのみ効果があります。

parameters deprecated

object

クラスターの Resource Orchestration Service (ROS) パラメーターのコレクション。

string

ROS パラメーター。

"ALIYUN::Region": "cn-qingdao"

container_cidr

string

Flannel ネットワーク構成に使用される Pod の CIDR ブロック。

172.20.xx.xx/16

service_cidr

string

サービスの CIDR ブロック。

172.21.xx.xx/20

proxy_mode

string

kube-proxy プロキシモード。

  • iptables: 成熟して安定した kube-proxy モードです。Kubernetes サービスのサービス検出と負荷分散は、iptables ルールを使用して設定されます。パフォーマンスは中程度で、クラスター規模の影響を受けます。このモードは、small 数のサービスがあるクラスターに適しています。

  • ipvs: 高性能な kube-proxy モードです。Kubernetes サービスのサービス検出と負荷分散は、Linux IPVS モジュールを使用して設定されます。このモードは、多数のサービスがあり、高い負荷分散パフォーマンスが必要な large クラスターに適しています。

ipvs

timezone

string

時間ゾーン。

Asia/Shanghai

node_cidr_mask

string

Flannel ネットワークプラグインにのみ適用されます。

各ノードに割り当てられるサブネットマスクのサイズであり、ノードに割り当て可能な IP アドレスの数をコントロールします。

26

ip_stack

string

クラスターの IP プロトコルスタック。有効な値:

  • ipv4: IPv4 プロトコルスタックのみをサポートするクラスターを作成します。

  • dual: IPv4/IPv6 デュアルスタックをサポートするクラスターを作成します。

ipv4

cluster_domain

string

クラスターのローカルドメイン名。

cluster.local

extra_sans

array

API サーバー証明書のカスタム Subject Alternative Name (SAN)。

string

証明書の SAN。

192.168.xx.xx

rrsa_config

object

RAM Roles for Service Accounts (RRSA) の構成。

enabled

boolean

RRSA が有効かどうかを示します。

true

oidc_name

string

OIDC IdP の名前。

ack-rrsa-***

oidc_arn

string

OIDC IdP の Alibaba Cloud Resource Name (ARN)。

acs:ram::1138***:oidc-provider/ack-rrsa-***

max_oidc_token_expiration

string

OIDC トークンの設定可能な最大有効期間。

12h

audience

string

OIDC トークンのデフォルトのオーディエンス。複数の値はカンマ (,) で区切ります。値は OIDC トークンの aud フィールドに配列として含まれます。

https://kubernetes.default.svc,https://example.***.com

issuer

string

OIDC トークンの発行者情報。複数の値はカンマ (,) で区切ります。最初の値が OIDC トークンの iss フィールドの値および OIDC IdP の発行者 URL になります。

https://oidc-ack-***,https://kubernetes.default.svc

open_api_configuration_url

string

OIDC 構成ドキュメントの URL。

https://oidc-ack-***/c12b990***/.well-known/openid-configuration

jwks_url

string

OIDC 公開鍵情報の URL。

https://oidc-ack-***/c12b990***/keys

vswitch_ids

array

クラスターのコントロールプレーンで使用される vSwitch。

string

クラスターのコントロールプレーンで使用される vSwitch。

vsw-2zete8s4qocqg0mf6****

operation_policy

object

クラスターの自動 O&M ポリシー。

cluster_auto_upgrade

object

クラスターの自動スペックアップ構成。

enabled

boolean

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

true

channel

string

クラスターの自動スペックアップ周波数。詳細については、スペックアップ周波数を参照してください。

有効な値:

  • patch: 最新のパッチバージョン。

  • stable: 2 番目に新しいマイナーバージョン。

  • rapid: 最新のマイナーバージョン。

patch

control_plane_config

object

ACK 専用クラスターのコントロールプレーン構成。

charge_type

string

コントロールプレーンノードの課金方法。

PrePaid

period

integer

ノードのサブスクリプション期間。

1

period_unit

string

サブスクリプション期間の単位。

Month

auto_renew

boolean

ノードの自動更新が有効かどうかを示します。

true

auto_renew_period

integer

ノードの自動更新期間。

1

instance_types

array

ノードのインスタンスタイプ。

string

インスタンスタイプ。

ecs.g6.large

image_type

string

オペレーティングシステムのイメージタイプ。

AliyunLinux3

image_id

string

イメージの ID。

aliyun_3_x64_20G_alibase_20240819

key_pair

string

キーペアの名前。このパラメーターまたは login_password のいずれかを指定してください。

ack

system_disk_category

string

ノードのシステムクラウドディスクのタイプ。

cloud_essd

system_disk_size

integer

ノードのシステムクラウドディスクのサイズ。最小値: 40。

120

system_disk_snapshot_policy_id

string

ノードの自動スナップショットバックアップポリシー。

sp-2zej1nogjvovnz4z****

system_disk_performance_level

string

システムクラウドディスクのパフォーマンスレベル。このパラメーターは ESSD クラウドディスクに対してのみ効果があります。

PL1

system_disk_provisioned_iops

integer

システムクラウドディスクのプロビジョニング済み読み取り/書き込み IOPS。

1000

system_disk_bursting_enabled

boolean

システムクラウドディスクでバースト機能 (I/O パフォーマンスバースト) が有効かどうかを示します。

true

deploymentset_id

string

デプロイメントセットの ID。

ds-bp10b35imuam5amw****

cloud_monitor_flags

boolean

ノードに CloudMonitor エージェントがインストールされているかどうかを示します。

true

soc_enabled

boolean

MLPS 2.0 セキュリティ強化が有効かどうかを示します。

false

security_hardening_os

boolean

Alibaba Cloud OS のセキュリティ強化が有効かどうかを示します。

true

cpu_policy

string

ノードの CPU 管理ポリシー。

none

runtime

string

コンテナランタイムの名前。

containerd

node_port_range

string

ノードのサービスポート範囲。

30000-32767

size

integer

コントロールプレーンノードの数。

3

instance_metadata_options InstanceMetadataOptions

ECS インスタンスのメタデータアクセス構成。

auto_mode

object

インテリジェントマネージドモードの構成。

enable

boolean

インテリジェントマネージドモードが有効かどうかを示します。

false

control_plane_endpoints_config

object

クラスターの接続設定。

load_balancers_config

array<object>

クラスターアクセスの負荷分散構成。

object

endpoint_type

string

load_balancer_id

string

endpoint

string

internal_dns_config

object

クラスターの内部 DNS 構成。ACK マネージドクラスターに適用されます。内部ドメイン名は、kubelet や kube-proxy などのノード側のシステムコンポーネントが API サーバーにアクセスするために使用されます。内部ドメイン名アクセスが有効になっていない場合、ノード側のシステムコンポーネントは CLB IP アドレスを通じて API サーバーにアクセスします。

bind_vpcs

array

内部 DNS レコードの解決が有効な VPC の範囲。クラスターが所在する VPC はデフォルトで含まれます。

string

内部 DNS レコードの解決が有効な VPC。

vpc-xxxxxx

enabled

boolean

クラスターの内部 DNS アクセスを有効にするかどうかを示します。

  • true: 内部 DNS アクセスを有効にします。ノード側のコンポーネント (kubelet、kube-proxy) は内部 DNS を通じて API Server にアクセスします。

true

成功レスポンス

JSONJSON

{
  "cluster_id": "c82e6987e2961451182edacd74faf****",
  "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-2zehc05z3b8dwiifh****",
  "meta_data": "\\\"Addons\\\":***",
  "name": "cluster-demo",
  "network_mode": "vpc",
  "region_id": "cn-beijing",
  "resource_group_id": "rg-acfmyvw3wjm****",
  "security_group_id": "sg-25yq****",
  "size": 5,
  "state": "running",
  "tags": [
    {
      "key": "env",
      "value": "prod"
    }
  ],
  "updated": "2025-04-10T13:28:09+08:00",
  "vpc_id": "vpc-2zecuu62b9zw7a7qn****",
  "vswitch_id": "vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****",
  "subnet_cidr": "172.20.xx.xx/16",
  "zone_id": "cn-beijing-a",
  "master_url": "{\\\"intranet_api_server_endpoint\\\":\\\"https://192.168.xx.xx:6443\\\"***}",
  "private_zone": false,
  "profile": "Default",
  "cluster_spec": "ack.pro.small",
  "worker_ram_role_name": "KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****",
  "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"
  },
  "parameters": {
    "key": "\"ALIYUN::Region\": \"cn-qingdao\""
  },
  "container_cidr": "172.20.xx.xx/16",
  "service_cidr": "172.21.xx.xx/20",
  "proxy_mode": "ipvs",
  "timezone": "Asia/Shanghai",
  "node_cidr_mask": "26",
  "ip_stack": "ipv4",
  "cluster_domain": "cluster.local",
  "extra_sans": [
    "192.168.xx.xx"
  ],
  "rrsa_config": {
    "enabled": true,
    "oidc_name": "ack-rrsa-***",
    "oidc_arn": "acs:ram::1138***:oidc-provider/ack-rrsa-***",
    "max_oidc_token_expiration": "12h",
    "audience": "https://kubernetes.default.svc,https://example.***.com",
    "issuer": "https://oidc-ack-***,https://kubernetes.default.svc",
    "open_api_configuration_url": "https://oidc-ack-***/c12b990***/.well-known/openid-configuration",
    "jwks_url": "https://oidc-ack-***/c12b990***/keys"
  },
  "vswitch_ids": [
    "vsw-2zete8s4qocqg0mf6****"
  ],
  "operation_policy": {
    "cluster_auto_upgrade": {
      "enabled": true,
      "channel": "patch"
    }
  },
  "control_plane_config": {
    "charge_type": "PrePaid",
    "period": 1,
    "period_unit": "Month",
    "auto_renew": true,
    "auto_renew_period": 1,
    "instance_types": [
      "ecs.g6.large"
    ],
    "image_type": "AliyunLinux3",
    "image_id": "aliyun_3_x64_20G_alibase_20240819",
    "key_pair": "ack",
    "system_disk_category": "cloud_essd",
    "system_disk_size": 120,
    "system_disk_snapshot_policy_id": "sp-2zej1nogjvovnz4z****",
    "system_disk_performance_level": "PL1",
    "system_disk_provisioned_iops": 1000,
    "system_disk_bursting_enabled": true,
    "deploymentset_id": "ds-bp10b35imuam5amw****",
    "cloud_monitor_flags": true,
    "soc_enabled": false,
    "security_hardening_os": true,
    "cpu_policy": "none",
    "runtime": "containerd",
    "node_port_range": "30000-32767",
    "size": 3,
    "instance_metadata_options": {
      "http_tokens": "optional"
    }
  },
  "auto_mode": {
    "enable": false
  },
  "control_plane_endpoints_config": {
    "load_balancers_config": [
      {
        "endpoint_type": "",
        "load_balancer_id": "",
        "endpoint": ""
      }
    ],
    "internal_dns_config": {
      "bind_vpcs": [
        "vpc-xxxxxx"
      ],
      "enabled": true
    }
  }
}

エラーコード

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

変更履歴

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