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

ENS:DescribeClustersV1

最終更新日:Sep 22, 2026

クラスターのリストを照会します。

今すぐお試しください

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

create

*すべてのリソース。

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

Name

string

任意

クラスター名。

test-eck-name

ClusterId

string

任意

クラスターの ID。

eck-xxxxxxxx

EnsRegionId

string

任意

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

cn-hangzhou-58

レスポンスフィールド

フィールド

型

説明

例

object

レスポンスのスキーマ。

RequestId

string

リクエストの ID。

C0003E8B-B930-4F59-ADC0-0E209A9012A8

Clusters

array<object>

クラスターのリスト。

array<object>

クラスターの詳細。

ClusterId

string

クラスターインスタンスの ID。

eck-xxxxxxx

Name

string

クラスター名。

test-eck-name

AliUid

string

ユーザーの ID。

1375383353108460

EnsRegionId

string

ENS ノードの ID。

cn-hangzhou-55

KubernetesVersion

string

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

1.31.9-aliyunedge.1

VpcId

string

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

n-5wsgr3xeolb2ist303wp3cscp

VswitchIds

array

クラスターノードの vSwitch の ID。vSwitch の ID の ENS リージョンは、ens_region_id の値と同じである必要があります。

string

vSwitch の ID。

vsw-xxxxxxx

PodVswitchIds

array

Pod 用の vSwitch の ID。各 Pod vSwitch はワーカーノード vSwitch に対応し、Pod vSwitch とワーカーノード vSwitch のゾーンは同じである必要があります。このパラメーターを空のままにすると、デフォルトで vswitch_ids の値が使用されます。

string

vSwitch の ID。

vsw-xxxxxxx

ContainerCidr

string

Pod ネットワークの CIDR ブロック。値は有効な非公開 CIDR ブロックである必要があり、次の CIDR ブロックおよびそのサブネットが含まれます: 10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。CIDR ブロックは、VPC の CIDR ブロック、または VPC 内の既存の Kubernetes クラスターで使用されている CIDR ブロックと重複できません。クラスターの作成後にこの値を変更することはできません。

10.0.0.0/8

ServiceCidr

string

サービスネットワークの CIDR ブロック。有効値: 10.0.0.0/16-24、172.16-31.0.0/16-24、192.168.0.0/16-24。CIDR ブロックは、VPC の CIDR ブロック 10.1.0.0/21、または VPC 内の既存の Kubernetes クラスターで使用されている CIDR ブロックと重複できません。クラスターの作成後にこの値を変更することはできません。

192.168.0.0/16

PublicAccess

boolean

パブリックネットワークアクセスが有効かどうかを示します。API Server が EIP を介して公開され、クラスターへのパブリックアクセスが有効になります。有効な値:

  • true: パブリックネットワークアクセスが有効です。

  • false: パブリックネットワークアクセスが無効です。このオプションを選択すると、クラスターの API Server にインターネットからアクセスできなくなります。

true

LoadBalancerId

string

負荷分散インスタンスの ID。

lb-58dngw0fyimzzvwljfec7hy0z

ControlPlaneConfig

object

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

InstanceSpec

string

インスタンスタイプ。

ens.sn1.medium

ImageId

string

イメージの ID。

m-68be8cb9f71fhyvjekxa23qsf

SystemDiskCategory

string

ノードのシステムクラウドディスクタイプ。有効な値: local_ssd、cloud_ssd、cloud_efficiency、local_hdd。

cloud_ssd

SystemDiskSize

integer

システムクラウドディスクのサイズ。単位: GB。

100

ContainerRuntime

string

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

コンテナd

NodePortRange

string

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

30000-32767

Size

integer

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

5

JoinToken

string

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

xxxxxxxxxx.yyyyyyy

Config

any

クラスターの kubeconfig。

{ "kind": "Config", "apiVersion": "v1", "preferences": {}, "clusters": [ { "name": "kubernetes", "クラスター": { "サーバー": "https://000.000.000.000:6443", "certificate-authority-data": "" } } ], "users": [ { "name": "kubernetes-admin", "user": { "client-certificate-data": "", "client-key-data": "" } } ], "contexts": [ { "name": "kubernetes-admin@kubernetes", "context": { "クラスター": "kubernetes", "user": "kubernetes-admin" } } ], "current-context": "kubernetes-admin@kubernetes" }

State

string

クラスターのステータス。

running

例

成功レスポンス

JSONJSON

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "Clusters": [
    {
      "ClusterId": "eck-xxxxxxx",
      "Name": "test-eck-name",
      "AliUid": "1375383353108460",
      "EnsRegionId": "cn-hangzhou-55",
      "KubernetesVersion": "1.31.9-aliyunedge.1",
      "VpcId": "n-5wsgr3xeolb2ist303wp3cscp",
      "VswitchIds": [
        "vsw-xxxxxxx"
      ],
      "PodVswitchIds": [
        "vsw-xxxxxxx"
      ],
      "ContainerCidr": "10.0.0.0/8",
      "ServiceCidr": "192.168.0.0/16",
      "PublicAccess": true,
      "LoadBalancerId": "lb-58dngw0fyimzzvwljfec7hy0z",
      "ControlPlaneConfig": {
        "InstanceSpec": "ens.sn1.medium",
        "ImageId": "m-68be8cb9f71fhyvjekxa23qsf",
        "SystemDiskCategory": "cloud_ssd",
        "SystemDiskSize": 100,
        "ContainerRuntime": "containerd",
        "NodePortRange": "30000-32767",
        "Size": 5
      },
      "JoinToken": "xxxxxxxxxx.yyyyyyy",
      "Config": "{\n        \"kind\": \"Config\",\n        \"apiVersion\": \"v1\",\n        \"preferences\": {},\n        \"clusters\": [\n          {\n            \"name\": \"kubernetes\",\n            \"cluster\": {\n              \"server\": \"https://000.000.000.000:6443\",\n              \"certificate-authority-data\": \"\"\n            }\n          }\n        ],\n        \"users\": [\n          {\n            \"name\": \"kubernetes-admin\",\n            \"user\": {\n              \"client-certificate-data\": \"\",\n              \"client-key-data\": \"\"\n            }\n          }\n        ],\n        \"contexts\": [\n          {\n            \"name\": \"kubernetes-admin@kubernetes\",\n            \"context\": {\n              \"cluster\": \"kubernetes\",\n              \"user\": \"kubernetes-admin\"\n            }\n          }\n        ],\n        \"current-context\": \"kubernetes-admin@kubernetes\"\n      }",
      "State": "running"
    }
  ]
}

エラーコード

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

変更履歴

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