クラスター ID を使用してクラスターの詳細を取得するには、DescribeClusterDetail オペレーションを呼び出します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:DescribeClusterDetail |
get |
*Cluster
|
なし | なし |
リクエスト構文
GET /clusters/{ClusterId} HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClusterId |
string |
必須 |
クラスター ID。 |
cdde1f21ae22e483ebcb068a6eb7f**** |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
リクエストパラメーターは必要ありません。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディのパラメーター。 |
||
| cluster_id |
string |
クラスター ID。 |
c82e6987e2961451182edacd74faf**** |
| cluster_type |
string |
クラスターのタイプ。
|
Kubernetes |
| created |
string |
クラスターが作成された時刻。 |
2025-04-07T09:57:26+08:00 |
| init_version |
string |
クラスターの初期バージョン。 |
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 |
docker_version
deprecated
|
string |
クラスターの Docker バージョン。 |
19.03.5 |
external_loadbalancer_id
deprecated
|
string |
Ingress LoadBalancer インスタンスの ID。 |
lb-2zehc05z3b8dwiifh**** |
| meta_data |
string |
クラスターのメタデータ。 |
\"Addons\":*** |
| name |
string |
クラスター名。 |
cluster-demo |
network_mode
deprecated
|
string |
クラスターで使用されるネットワークタイプ (Virtual Private Cloud (VPC) など)。 |
vpc |
| region_id |
string |
クラスターがデプロイされているリージョン ID。 |
cn-beijing |
| resource_group_id |
string |
クラスターが属するリソースグループの ID。 |
rg-acfmyvw3wjm**** |
| security_group_id |
string |
クラスターが属するセキュリティグループの ID。 |
sg-25yq**** |
| size |
integer |
クラスター内のノード (マスターノードとワーカーノード) の総数。 |
5 |
| state |
string |
クラスターの状態。有効な値：
|
running |
| tags |
array |
クラスターのタグ。 |
|
| tag |
クラスターにアタッチされているタグ。 |
||
| updated |
string |
クラスターが最後に更新された時刻。 |
2025-04-10T13:28:09+08:00 |
| vpc_id |
string |
クラスターが属する Virtual Private Cloud (VPC) の ID。 |
vpc-2zecuu62b9zw7a7qn**** |
vswitch_id
deprecated
|
string |
vSwitch の ID。このパラメーターは非推奨です。コントロールプレーンの vSwitch をクエリするには、このレスポンスの |
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 |
クラスターの内部およびパブリック API サーバーエンドポイント。 |
{\"intranet_api_server_endpoint\":\"https://192.168.xx.xx:6443\"***} |
private_zone
deprecated
|
boolean |
クラスターで PrivateZone が有効になっているかどうかを示します。
デフォルト値：false。 |
false |
| profile |
string |
クラスターのサブタイプ。
|
Default |
| cluster_spec |
string |
Pro XL、Pro 2XL、および Pro 4XL は、プロビジョニングされたコントロールプレーンを持つ ACK Pro が提供する 3 つのティアです。この機能は、コントロールプレーンリソースを事前に割り当てて専用化することで、高い API 同時実行性と Pod スケジューリングを保証し、AI トレーニングと推論、超大規模クラスター、およびミッションクリティカルなワークロードに最適です。 Pro 版クラスターおよびプロビジョニングされたコントロールプレーンを持つクラスターの管理料金の詳細については、「クラスター管理料金」をご参照ください。 |
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 |
Service の CIDR ブロック。 |
172.21.xx.xx/20 |
| proxy_mode |
string |
kube-proxy のプロキシモード。
|
ipvs |
| timezone |
string |
クラスターのタイムゾーン。 |
Asia/Shanghai |
| node_cidr_mask |
string |
各ノードのサブネットマスクの長さ。ノードごとに割り当て可能な IP アドレス数を決定します。このパラメーターは、Flannel ネットワークプラグインを使用するクラスターにのみ適用されます。 ノード割り当てのサブネットマスクサイズは、ノードが割り当てることができる IP アドレス数を決定します。 |
26 |
| ip_stack |
string |
クラスターの IP スタック。有効な値：
|
ipv4 |
| cluster_domain |
string |
クラスター内部のドメイン名。 |
cluster.local |
| extra_sans |
array |
API サーバー証明書のカスタムサブジェクト代替名 (SAN)。 |
|
|
string |
証明書の SAN。 |
192.168.xx.xx |
|
| rrsa_config |
object |
RAM Roles for Service Accounts (RRSA) の設定。 |
|
| enabled |
boolean |
RRSA 機能が有効になっているかどうかを示します。 |
true |
| oidc_name |
string |
OIDC ID プロバイダーの名前。 |
ack-rrsa-*** |
| oidc_arn |
string |
OIDC ID プロバイダーの ARN。 |
acs:ram::1138***:oidc-provider/ack-rrsa-*** |
| max_oidc_token_expiration |
string |
OIDC トークンの最大有効期間。 |
12h |
| audience |
string |
OIDC トークンのデフォルトのオーディエンス。複数の値を指定する場合、値はカンマ (,) で区切ります。この値は、OIDC トークンのオーディエンス ( |
https://kubernetes.default.svc,https://example.***.com |
| issuer |
string |
OIDC トークンの発行者。複数の値を指定する場合、値はカンマ (,) で区切ります。最初の値は、発行者 ( |
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 公開キーを含む JSON Web Key Set (JWKS) の URL。 |
https://oidc-ack-***/c12b990***/keys |
| vswitch_ids |
array |
コントロールプレーンの vSwitch。 |
|
|
string |
コントロールプレーンの vSwitch。 |
vsw-2zete8s4qocqg0mf6**** |
|
| operation_policy |
object |
クラスターの自動運用ポリシー。 |
|
| cluster_auto_upgrade |
object |
クラスターの自動アップグレード設定。 |
|
| enabled |
boolean |
クラスターの自動アップグレードが有効になっているかどうかを示します。 |
true |
| channel |
string |
自動アップグレードチャネル。詳細については、「アップグレードチャネル」をご参照ください。 有効な値：
|
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 |
OS イメージタイプ。 |
AliyunLinux3 |
| image_id |
string |
イメージ ID。 |
aliyun_3_x64_20G_alibase_20240819 |
| key_pair |
string |
キーペアの名前。 |
ack |
| system_disk_category |
string |
ノードのシステムディスクのタイプ。 |
cloud_essd |
| system_disk_size |
integer |
コントロールプレーンノードのシステムディスクのサイズ (GiB)。値は 40 以上である必要があります。 |
120 |
| system_disk_snapshot_policy_id |
string |
コントロールプレーンノードのシステムディスクの自動スナップショットポリシーの ID。 |
sp-2zej1nogjvovnz4z**** |
| system_disk_performance_level |
string |
ノードのシステムディスクのパフォーマンスレベル。このパラメーターは ESSD に対してのみ有効です。 |
PL1 |
| system_disk_provisioned_iops |
integer |
ノードのシステムディスクにプロビジョニングされた読み取り/書き込み IOPS。 |
1000 |
| system_disk_bursting_enabled |
boolean |
ノードのシステムディスクでバーストが有効になっているかどうかを示します。 |
true |
| deploymentset_id |
string |
配置セットの ID。 |
ds-bp10b35imuam5amw**** |
| cloud_monitor_flags |
boolean |
CloudMonitor エージェントがノードにインストールされているかどうかを示します。 |
true |
| soc_enabled |
boolean |
MLPS セキュリティ強化が有効になっているかどうかを示します。 |
false |
| security_hardening_os |
boolean |
Alibaba Cloud OS セキュリティ強化が有効になっているかどうかを示します。 |
true |
| cpu_policy |
string |
ノードの CPU 管理ポリシー。 |
none |
| runtime |
string |
コンテナランタイムの名前。 |
containerd |
| node_port_range |
string |
Service の NodePort 範囲。 |
30000-32767 |
| size |
integer |
コントロールプレーンノードの数。 |
3 |
| instance_metadata_options | InstanceMetadataOptions |
ECS インスタンスのメタデータアクセス設定。 |
|
| auto_mode |
object |
インテリジェントなホスティングモードの設定。 |
|
| enable |
boolean |
インテリジェントなホスティングモードが有効になっているかどうかを示します。 |
false |
| control_plane_endpoints_config |
object |
クラスターの接続設定。 |
|
| internal_dns_config |
object |
クラスターの内部 DNS 設定。このパラメーターは、ACK マネージドクラスターにのみ適用されます。kubelet や kube-proxy などのノードコンポーネントは、内部ドメイン名を使用して API サーバーにアクセスします。この機能が無効な場合、これらのコンポーネントは、その Classic Load Balancer (CLB) インスタンスの IP アドレスを使用して API サーバーにアクセスします。 |
|
| bind_vpcs |
array |
内部ドメイン名が有効になる VPC。デフォルトでは、これにはクラスターがデプロイされている VPC が含まれます。 |
|
|
string |
内部ドメイン名が有効になる VPC。 |
vpc-xxxxxx |
|
| enabled |
boolean |
内部 DNS ベースのアクセスが有効になっているかどうかを示します。
|
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": {
"internal_dns_config": {
"bind_vpcs": [
"vpc-xxxxxx"
],
"enabled": true
}
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。