指定したリージョン内のすべてのクラスターを一覧表示します。
今すぐお試しください
テスト
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 プロビジョニング済みコントロールプレーンの 3 つのティアです。これらのティアは、コントロールプレーンリソースを事前に割り当てて専用にすることで、一貫して高いレベルの API の同時実行性と Pod スケジューリング機能を保証します。AI トレーニングと推論、大規模クラスター、およびミッションクリティカルなサービスに適しています。 Pro 版およびプロビジョニング済みコントロールプレーン版のクラスター管理料金の詳細については、「クラスター管理料金」をご参照ください。 列挙値:
|
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 |
削除保護が有効かどうかを示します。このパラメーターが true に設定されている場合、クラスターはコンソールまたは 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 |
Service の 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 プロビジョニング済みコントロールプレーンで利用可能な 3 つの仕様です。これらの仕様は、コントロールプレーンリソースを事前に割り当てて専用にすることで、高い API の同時実行性と Pod スケジューリング機能を保証します。AI のトレーニングと推論、大規模クラスター、およびミッションクリティカルなサービスに適しています。 Pro 版およびプロビジョニング済みコントロールプレーン版のクラスター管理料金の詳細については、「クラスター管理料金」をご参照ください。 |
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
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。