クラスターの一覧を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ens:DescribeClustersV1 |
create |
*All Resource
|
なし | なし |
リクエスト構文
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 は `ens_region_id` で指定されたリージョン内に存在する必要があります。 |
|
|
string |
vSwitch の ID です。 |
vsw-xxxxxxx |
|
| PodVswitchIds |
array |
各 Pod vSwitch はワーカーノードの vSwitch に対応します。Pod vSwitch とワーカーノード vSwitch のゾーンは同一である必要があります。このパラメーターを指定しない場合、デフォルトで `vswitch_ids` の値が使用されます。 |
|
|
string |
vSwitch の ID です。 |
vsw-xxxxxxx |
|
| ContainerCidr |
string |
Pod 用の 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 サーバーは、弾力的 IP アドレス (EIP) を介して公開され、クラスターへのパブリックアクセスを可能にします。有効な値は `true` および `false` です。`true` を指定するとパブリックネットワークアクセスが有効化され、`false` を指定すると無効化されます。無効化した場合、インターネット経由でクラスターの API サーバーにアクセスできなくなります。 |
true |
| LoadBalancerId |
string |
Server Load Balancer (SLB) インスタンスの 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 |
ランタイムのタイプです。 |
containerd |
| NodePortRange |
string |
ノード上のサービスポートの範囲です。 |
30000-32767 |
| Size |
integer |
コントロールプレーンノードの数です。 |
5 |
| JoinToken |
string |
クラスターへのアクセスに使用する認証トークンです。 |
xxxxxxxxxx.yyyyyyy |
| Config |
any |
クラスターの kubeconfig です。 |
{ "kind": "Config", "apiVersion": "v1", "preferences": {}, "clusters": [ { "name": "kubernetes", "cluster": { "server": "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": { "cluster": "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"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。