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

ENS:DescribeClusterDetail

最終更新日:Sep 11, 2026

クラスターの詳細を照会します。

操作説明

  • ユーザーごとの呼び出し周波数: 1 秒あたり 100 回。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeClusterDetail

get

*すべてのリソース。

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ClusterId

string

必須

クラスターの ID。

eck- プレフィックスを持つ ECK クラスター ID のみを受け付けます。レガシの短い 16 進数クラスター ID はサポートされていません。ID を取得するには、DescribeClustersV1 を呼び出します。クラスターを一覧表示する場合は、Name パラメーターを渡します。

eck-11111111

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

RequestId

string

リクエストの ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984

ClusterId

string

クラスターの ID。

eck-11111111

Name

string

クラスター名。

your-クラスター-name

AliUid

string

ユーザーの ID。

1574790082031102

EnsRegionId

string

ENS エッジゾーンの ID。

cn-fuzhou-23

KubernetesVersion

string

クラスターのバージョン。Kubernetes コミュニティのベースラインバージョンと一致します。最新バージョンを選択することを推奨します。このパラメーターを指定しない場合、デフォルトで最新バージョンが使用されます。

1.32.1.aliyunエッジ.1

VpcId

string

クラスターが使用する VPC。

n-xxxxxxxxx

VswitchIds

array

クラスターノードの vSwitch の ID。

string

クラスターノードの vSwitch の ID。

vsw-xxxxxxxxx

PodVswitchIds

array

Pod 用の vSwitch の ID。

string

Pod 用の vSwitch の ID。

vsw-xxxxxxxx

ContainerCidr

string

Pod 用の CIDR ブロック。

172.20.0.0/16

ServiceCidr

string

サービス用の CIDR ブロック。

172.19.0.0/20

PublicAccess

boolean

パブリックネットワークアクセスが有効かどうかを示します。

true

LoadBalancerId

string

API サーバーの CLB インスタンスの ID。

lb-5snthcyu1x10g7tywj7iu****

ControlPlaneConfig

object

コントロールプレーンの構成。

InstanceSpec

string

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

ens.esk.sn1.medium

ImageId

string

コントロールプレーン仮想マシンのイメージの ID。

m-5ul335umat4e2y9ynwi84p3f9

SystemDiskCategory

string

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

cloud_efficiency

SystemDiskSize

integer

ノードのシステムクラウドディスクサイズ。

120

ContainerRuntime

string

コンテナランタイムタイプ。

コンテナd

NodePortRange

string

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

30000-32767

Size

integer

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

3

JoinToken

string

クラスターアクセス用の認証トークン。

xxxx.yyy

Config

any

クラスターの kubeconfig。

apiVersion: v1 クラスター: - クラスター: certificate-authority-data: x サーバー: https://111.111.111.111:6443 name: kubernetes contexts: - context: クラスター: kubernetes user: user name: eck-xxxxx current-context: eck-xxxx kind: Config preferences: {} users: - name: user user: client-certificate-data: x client-key-data: x

State

string

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

  • initial: 作成中。

  • failed: 作成に失敗した。

  • running: 実行中。

  • deleting: リリース中。

実行中

例

成功レスポンス

JSONJSON

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ClusterId": "eck-11111111",
  "Name": "your-cluster-name",
  "AliUid": "1574790082031102",
  "EnsRegionId": "cn-fuzhou-23",
  "KubernetesVersion": "1.32.1.aliyunedge.1",
  "VpcId": "n-xxxxxxxxx",
  "VswitchIds": [
    "vsw-xxxxxxxxx"
  ],
  "PodVswitchIds": [
    "vsw-xxxxxxxx"
  ],
  "ContainerCidr": "172.20.0.0/16",
  "ServiceCidr": "172.19.0.0/20",
  "PublicAccess": true,
  "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
  "ControlPlaneConfig": {
    "InstanceSpec": "ens.esk.sn1.medium",
    "ImageId": "m-5ul335umat4e2y9ynwi84p3f9",
    "SystemDiskCategory": "cloud_efficiency",
    "SystemDiskSize": 120,
    "ContainerRuntime": "containerd",
    "NodePortRange": "30000-32767",
    "Size": 3
  },
  "JoinToken": "xxxx.yyy",
  "Config": "apiVersion: v1\nclusters:\n- cluster:\n    certificate-authority-data: x\n    server: https://111.111.111.111:6443\n  name: kubernetes\ncontexts:\n- context:\n    cluster: kubernetes\n    user: user\n  name: eck-xxxxx\ncurrent-context: eck-xxxx\nkind: Config\npreferences: {}\nusers:\n- name: user\n  user:\n    client-certificate-data: x\n    client-key-data: x",
  "State": "running"
}

エラーコード

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

変更履歴

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