指定されたリージョン内のすべてのクラスターを一覧表示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cs:DescribeClustersForRegion |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /regions/{region_id}/clusters HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| region_id |
string |
必須 |
リージョン ID です。 |
cn-hangzhou |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| name |
string |
任意 |
クラスター名です。あいまい検索がサポートされています。 |
test-cluster |
| cluster_type |
string |
任意 |
クラスタータイプです。有効な値は次のとおりです。
列挙値:
|
Kubernetes |
| page_size |
integer |
任意 |
1 ページあたりに返されるエントリ数です。 |
3 |
| page_number |
integer |
任意 |
返されるページ番号です。 |
10 |
| profile |
string |
任意 |
クラスターのサブタイプです。有効な値は次のとおりです。
列挙値:
|
Serverless |
| cluster_spec |
string |
任意 |
クラスターのスペックです。有効な値は次のとおりです。
Pro XL、Pro 2XL、および Pro 4XL は、ACK Pro provisioned control plane で利用可能な 3 つのスペックです。これらのスペックは、コントロールプレーンのリソースを事前に割り当てて専有することで、API の同時実行数および Pod スケジューリング機能の高い安定性を確保します。AI トレーニングおよび推論、大規模クラスター、ミッションクリティカルなワークロードに適しています。 プロ版および provisioned control plane クラスターのクラスター管理料金については、リンク先のトピックをご参照ください。 列挙値:
|
ack.standard |
| cluster_id |
string |
任意 |
クラスター ID です。 |
c8155823d057948c69a**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返されたデータです。 |
||
| clusters |
array<object> |
クラスターの一覧です。 |
|
|
object |
クラスターの詳細です。 |
||
| cluster_id |
string |
クラスター ID です。 |
c905d1364c2dd4b6284a3f41790c4**** |
| cluster_type |
string |
クラスタータイプです。有効な値は次のとおりです。
|
ManagedKubernetes |
| created |
string |
クラスターの作成時刻です。 |
2020-12-01T20:40:40+08:00 |
| init_version |
string |
クラスターの初期バージョンです。 |
1.16.6-aliyun.1 |
| current_version |
string |
クラスターの現在のバージョンです。 |
1.16.6-aliyun.1 |
| next_version |
string |
利用可能なアップグレードバージョンです。 |
1.18.8-aliyun.1 |
| deletion_protection |
boolean |
クラスターに対して削除保護が有効かどうかを示します。有効にすると、コンソールまたは API 呼び出しによるクラスターの削除ができなくなります。有効な値は次のとおりです。
|
false |
| name |
string |
クラスター名です。 |
test-cluster |
| profile |
string |
クラスターのサブタイプです。有効な値は次のとおりです。
|
Default |
| region_id |
string |
リージョン ID です。 |
cn-beijing-a |
| resource_group_id |
string |
クラスターが属するリソースグループの ID です。 |
rg-acfmyvw3wjm**** |
| security_group_id |
string |
クラスターのセキュリティグループ ID です。 |
sg-2zeihch86ooz9io4**** |
| container_cidr |
string |
クラスター内の Pod 用の CIDR ブロックです。 |
172.20.0.0/16 |
| service_cidr |
string |
サービスネットワーク用の CIDR ブロックです。 |
172.21.0.0/20 |
| proxy_mode |
string |
クラスターの kube-proxy プロキシモードです。 列挙値:
|
ipvs |
| timezone |
string |
クラスターのタイムゾーンです。 |
Asia/Shanghai |
| ip_stack |
string |
クラスターの IP スタックです。 |
ipv4 |
| cluster_domain |
string |
クラスタードメインです。 |
cluster.local |
| size |
integer |
クラスター内のノード数です。 |
2 |
| state |
string |
クラスターの状態です。有効な値は次のとおりです。
|
running |
| tags |
array |
クラスターにアタッチされたタグです。 |
|
| tag |
クラスターにアタッチされたタグです。 |
||
| updated |
string |
クラスターが最後に更新された時刻です。 |
2020-12-08T15:37:00+08:00 |
| vpc_id |
string |
クラスターの VPC ID です。 |
vpc-2zeg8nf1ukc0fcmvq**** |
| vswitch_ids |
array |
コントロールプレーン用の vSwitch ID です。 |
|
|
string |
コントロールプレーン用の vSwitch ID です。 |
vsw-2vc41xuumx5z2rdma**** |
|
| cluster_spec |
string |
クラスターのスペックです。有効な値は次のとおりです。
Pro XL、Pro 2XL、および Pro 4XL は、ACK Pro provisioned control plane で利用可能な 3 つのスペックです。これらのスペックは、コントロールプレーンのリソースを事前に割り当てて専有することで、API の同時実行数および Pod スケジューリング機能の高い安定性を確保します。AI トレーニングおよび推論、大規模クラスター、ミッションクリティカルなワークロードに適しています。 プロ版および ACK Pro provisioned control plane スペックのクラスター管理料金については、リンク先のトピックをご参照ください。 |
ack.standard |
| page_info |
object |
ページネーション情報です。 |
|
| page_number |
integer |
返されたページ番号です。 |
1 |
| page_size |
integer |
1 ページあたりのエントリ数です。 |
10 |
| total_count |
integer |
クエリに一致するエントリの総数です。 |
10 |
例
成功レスポンス
JSONJSON
{
"clusters": [
{
"cluster_id": "c905d1364c2dd4b6284a3f41790c4****",
"cluster_type": "ManagedKubernetes",
"created": "2020-12-01T20:40:40+08:00",
"init_version": "1.16.6-aliyun.1",
"current_version": "1.16.6-aliyun.1",
"next_version": "1.18.8-aliyun.1",
"deletion_protection": false,
"name": "test-cluster",
"profile": "Default",
"region_id": "cn-beijing-a",
"resource_group_id": "rg-acfmyvw3wjm****",
"security_group_id": "sg-2zeihch86ooz9io4****",
"container_cidr": "172.20.0.0/16",
"service_cidr": "172.21.0.0/20",
"proxy_mode": "ipvs",
"timezone": "Asia/Shanghai",
"ip_stack": "ipv4",
"cluster_domain": "cluster.local",
"size": 2,
"state": "running",
"tags": [
{
"key": "env",
"value": "prod"
}
],
"updated": "2020-12-08T15:37:00+08:00",
"vpc_id": "vpc-2zeg8nf1ukc0fcmvq****",
"vswitch_ids": [
"vsw-2vc41xuumx5z2rdma****"
],
"cluster_spec": "ack.standard"
}
],
"page_info": {
"page_number": 1,
"page_size": 10,
"total_count": 10
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。