DescribeAckClusters API による ACK クラスターステータスの確認 - Cloud Firewall

クラスタータイプや仕様などの指定された条件に基づいて、Container Service for Kubernetes (ACK) クラスターをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionNo	string	必須	ACK クラスターのリージョン ID。	cn-hangzhou
MemberUid	string	任意	ACK クラスターリソースが属するアカウントの Alibaba Cloud UID。	135809047715****
PageSize	string	必須	ページあたりのエントリ数。	10
PageNo	string	必須	ページ番号。	1
ClusterId	string	任意	ACK クラスターの ID。	cb0f5640b1b2d404cad6ba21509d7847b
ClusterName	string	任意	ACK クラスターの名前。	ack-cluster-name
ClusterSpec	string	任意	ACK クラスターの仕様。列挙値: ack.pro.small : ACK Pro エディションクラスター	ack.pro.small
ConnectorStatus	string	任意	ACK クラスターコネクタのステータス。	ready

レスポンスフィールド

フィールド	型	説明	例
	object
Clusters	array<object>	ACK クラスターのリスト。
	object	ACK クラスター。
MemberUid	string	ACK クラスターリソースが属するアカウントの Alibaba Cloud UID。	135809047715****
RegionId	string	ACK クラスターのリージョン ID。	cn-hangzhou
ClusterId	string	ACK クラスターの ID。	cb0f5640b1b2d404cad6ba21509d7847b
ClusterName	string	ACK クラスターの名前。	ack-cluster-name
ClusterType	string	ACK クラスターのタイプ。有効な値の詳細については、「DescribeClustersV1」をご参照ください。 DescribeClustersV1：クラスターのタイプや仕様など、特定の基準を満たすアカウント内の ACK クラスターのリストを返します。列挙値: ExternalKubernetes : 登録済みクラスター。 ManagedKubernetes : ACK マネージドクラスター。これには、ACK マネージドクラスター (Pro エディションおよび Basic Edition)、ACK Serverless クラスター (Pro エディションおよび Basic Edition)、ACK Edge クラスター (Pro エディションおよび Basic Edition)、および LINGJUN クラスター (Pro エディション) が含まれます。 Kubernetes : ACK 専用クラスター。	ManagedKubernetes
Profile	string	クラスターのサブタイプ。このパラメーターは、`ClusterType` が `ManagedKubernetes` に設定されている場合にのみ使用できます。有効な値の詳細については、「DescribeClustersV1」をご参照ください。 DescribeClustersV1：クラスターのタイプや仕様など、指定された条件を満たすアカウント内の ACK クラスターを一覧表示します。列挙値: Lingjun : LINGJUN クラスター。Pro エディションで利用可能です。 Serverless : ACK Serverless クラスター。これには、ACK Serverless Pro Edition および ACK Serverless Basic Edition クラスターが含まれます。 Default : ACK マネージドクラスター。これには、ACK Pro エディションおよび ACK Basic Edition クラスターが含まれます。 Edge : ACK Edge クラスター。これには、ACK Edge Pro エディションおよび ACK Edge Basic Edition クラスターが含まれます。	Default
VpcId	string	ACK クラスターがデプロイされている VPC の ID。	vpc-2vcg932hsxsxuqbgl****
Network	string	ACK クラスターのネットワークプラグイン。有効な値の詳細については、「DescribeClustersV1」をご参照ください。 DescribeClustersV1：クラスターのタイプや仕様など、指定された条件を満たすアカウント内の ACK クラスターを一覧表示します。列挙値: terway-eniip : Terway-eniip Flannel : Flannel	terway-eniip
ClusterSpec	string	ACK クラスターの仕様。列挙値: ack.pro.small : ACK Pro エディションクラスター	ack.pro.small
State	string	ACK クラスターの実行ステータス。有効な値の詳細については、「DescribeClustersV1」をご参照ください。 DescribeClustersV1：クラスターのタイプや仕様など、指定された条件を満たすアカウント内の ACK クラスターのリストを取得します。列挙値: running : クラスターは実行中です。 scaling : クラスターはスケーリング中です。 stopped : クラスターは停止しています。 upgrading : クラスターはアップグレード中です。 updating : クラスター構成は更新中です。 deleting : クラスターは削除中です。 deleted : クラスターは削除されました。 initial : クラスターは作成中です。 draining : ノードはドレイン中です。 delete_failed : クラスターの削除に失敗しました。 failed : クラスターの作成に失敗しました。 removing : ノードは削除中です。	running
PageNo	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。	10
RequestId	string	リクエスト ID。	C5DDD596-1191-5F36-A504-8733045A****
TotalCount	integer	エントリの総数。	1

例

成功レスポンス

JSONJSON

{
  "Clusters": [
    {
      "MemberUid": "135809047715****",
      "RegionId": "cn-hangzhou",
      "ClusterId": "cb0f5640b1b2d404cad6ba21509d7847b",
      "ClusterName": "ack-cluster-name",
      "ClusterType": "ManagedKubernetes",
      "Profile": "Default",
      "VpcId": "vpc-2vcg932hsxsxuqbgl****",
      "Network": "terway-eniip",
      "ClusterSpec": "ack.pro.small",
      "State": "running"
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "C5DDD596-1191-5F36-A504-8733045A****",
  "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ErrorParametersUid	The aliUid parameter is invalid.
400	ErrorParameters	Parameters error.
400	ErrorDBSelect	An error occurred while querying database.
400	ErrorRegionNo	regionNo error.
400	ErrorAckNotOpen	ACK service is not open.

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

変更履歴

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