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

Container Service for Kubernetes:DescribeClusterDetail

最終更新日:Sep 10, 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

レスポンスボディのパラメーター。

auto_mode

object

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

enable

boolean

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

false

cluster_domain

string

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

クラスター.local

cluster_id

string

クラスターの ID。

c82e6987e2961451182edacd74faf****

cluster_spec

string

cluster_type が ManagedKubernetes に設定され、プロファイルが構成されている場合のクラスタースペック。有効な値:

  • ack.standard: Basic (値が空の場合のデフォルト選択)

  • ack.pro.small: プロ版

  • ack.pro.xlarge: プロ版 XL

  • ack.pro.2xlarge: プロ版 2XL

  • ack.pro.4xlarge: プロ版 4XL (アカウントをホワイトリストに追加するには、カスタマーサービスの連絡先までお問い合わせください)

プロ版 XL、プロ版 2XL、およびプロ版 4XL は、コンテナサービス ACK Pro プロビジョニング済みコントロールプレーン によって提供される 3 つのティアです。コントロールプレーンリソースを事前割り当ておよび専有することで、これらのティアは API の同時実行数と Pod のスケジューリング機能が決定論的に高いレベルに維持されることを保証します。AI トレーニングおよび推論、超大規模クラスター、および重大なワークロードに適しています。

Pro およびプロビジョニング済みコントロールプレーンプロダクトのクラスター管理料金の詳細については、クラスター管理料金を参照してください。

ack.pro.small

cluster_type

string

クラスタータイプ。有効な値:

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

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

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

Kubernetes

container_cidr

string

Flannel ネットワーク構成用の Pod CIDR ブロック。

172.20.xx.xx/16

control_plane_config

object

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

auto_renew

boolean

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

true

auto_renew_period

integer

ノードの自動更新期間。

1

charge_type

string

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

PrePaid

cloud_monitor_flags

boolean

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

true

cpu_policy

string

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

none

deploymentset_id

string

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

ds-bp10b35imuam5amw****

image_id

string

イメージ ID。

aliyun_3_x64_20G_alibase_20240819

image_type

string

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

AliyunLinux3

instance_metadata_options InstanceMetadataOptions

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

instance_types

array

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

string

インスタンスタイプ。

ecs.g6.large

key_pair

string

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

ack

node_port_range

string

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

30000-32767

period

integer

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

1

period_unit

string

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

Month

runtime

string

ランタイム名。

コンテナd

security_hardening_os

boolean

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

true

size

integer

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

3

soc_enabled

boolean

等級保護セキュリティ強化が有効かどうかを示します。

false

system_disk_bursting_enabled

boolean

ノードのシステムクラウドディスクでバーストモードが有効かどうかを示します。

true

system_disk_category

string

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

cloud_essd

system_disk_performance_level

string

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

PL1

system_disk_provisioned_iops

integer

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

1000

system_disk_size

integer

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

120

system_disk_snapshot_policy_id

string

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

sp-2zej1nogjvovnz4z****

control_plane_endpoints_config

object

クラスター接続構成。

internal_dns_config

object

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

bind_vpcs

array

内部ドメイン名レコードの解決が有効になる VPC 範囲。デフォルトでは、クラスターが存在する VPC が含まれます。

string

内部ドメイン名レコードの解決が有効になる VPC。

vpc-xxxxxx

enabled

boolean

クラスターの内部ドメイン名アクセスが有効かどうかを示します。

  • true: 内部ドメイン名アクセスが有効です。ノード側コンポーネント (kubelet、kube-proxy) は内部ドメイン名を通じて API サーバーにアクセスします。

true

load_balancers_config

array<object>

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

object

endpoint

string

アクセスエンドポイント。

nlb-0ogk9aaxxxxxxx.cn-hangzhou.nlb.aliyuncsslb.com

endpoint_type

string

エンドポイントタイプ。

非公開

load_balancer_id

string

エンドポイントに関連付けられた SLB インスタンス。

nlb-0ogk9aaxxxxxxx

created

string

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

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

current_version

string

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

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 のインスタンス ID。

lb-2zehc05z3b8dwiifh****

extra_sans

array

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

string

証明書の SAN。

192.168.xx.xx

init_version

string

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

1.32.1-aliyun.1

ip_stack

string

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

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

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

ipv4

maintenance_window maintenance_window

クラスターのメンテナンスウィンドウ構成。この構成は、マネージドクラスター (コンテナサービス ACK Pro、プロ版クラスター) に対してのみ適用されます。

master_url

string

内部ネットワークアクセスエンドポイントおよびパブリックネットワークアクセスエンドポイントを含む、クラスターのアクセスエンドポイント。

{\"内部ネットワークAPIサーバーエンドポイント\":\"https://192.168.xx.xx:6443\"***}

meta_data

string

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

\"Addons\":***

name

string

クラスター名。

クラスター-demo

network_mode deprecated

string

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

vpc

next_version

string

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

1.xx.x-aliyun.1

node_cidr_mask

string

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

各ノードに割り当てられるサブネットマスクサイズ。ノードに割り当てることができる IP アドレスの数を制御します。

26

operation_policy

object

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

cluster_auto_upgrade

object

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

channel

string

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

有効な値:

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

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

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

パッチ

enabled

boolean

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

true

parameters deprecated

object

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

string

ROS パラメーター。

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

private_zone deprecated

boolean

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

  • true: 有効。

  • false: 無効。

デフォルト値: false。

false

profile

string

クラスターのサブタイプ。

  • Default: コンテナサービス ACK Pro クラスターおよび ACK クラスターを含む ACK マネージドクラスター。

  • Edge: ACK Edge プロ版 クラスターおよび ACK Edge クラスターを含む ACK Edge クラスター。

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

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

Default

proxy_mode

string

kube-proxy のプロキシモード。

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

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

ipvs

region_id

string

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

cn-beijing

resource_group_id

string

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

rg-acfmyvw3wjm****

rrsa_config

object

RAM Roles for Service Accounts (RRSA) 構成。

audience

string

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

https://kubernetes.デフォルト.svc,https://example.***.com

enabled

boolean

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

true

issuer

string

OIDC トークンの発行者。複数の値はコンマ (,) で区切られます。最初の値は、OIDC トークンの iss フィールドおよび OIDC ID プロバイダーの発行者 URL として使用されます。

https://oidc-ack-***,https://kubernetes.デフォルト.svc

jwks_url

string

OIDC 公開鍵情報の URL。

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

max_oidc_token_expiration

string

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

12h

oidc_arn

string

OIDC ID プロバイダーの Alibaba Cloud Resource Name (ARN)。

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

oidc_name

string

OIDC ID プロバイダーの名前。

ack-rrsa-***

open_api_configuration_url

string

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

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

security_group_id

string

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

sg-25yq****

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 ブロック。

172.20.xx.xx/16

tags

array

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

tag

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

timezone

string

タイムゾーン。

Asia/Shanghai

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

vswitch_ids

array

クラスターのコントロールプレーンが使用する vSwitch。

string

クラスターのコントロールプレーンが使用する vSwitch。

vsw-2zete8s4qocqg0mf6****

worker_ram_role_name

string

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

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

zone_id deprecated

string

クラスターが存在するリージョン内のゾーン ID。

cn-beijing-a

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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