DescribeClusterBasicInfo を使用したクラスター基本情報の取得 - Security Center - Alibaba Cloud - Security Center

クラスター ID でクラスター情報を照会します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-sas:DescribeClusterBasicInfo

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クエリするクラスターの ID。説明 DescribeGroupedContainerInstances 操作を呼び出して、このパラメーターを取得できます。	c870ec78ecbcb41d2a35c679823ef****
Type	string	必須	構成タイプ。有効な値: containerNetwork: コンテナネットワークトポロジースイッチ interceptionSwitch: クラスターマイクロセグメンテーションスイッチ。	containerNetwork
TargetType	string	必須	ターゲットスイッチ構成の操作ディメンション。有効な値: Cluster: クラスター ID。	Cluster

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。Alibaba Cloud がリクエストに対して生成する一意の識別子であり、問題のトラブルシューティングに使用できます。	24A20733-10A0-4AF6-BE6B-E3322413BB68
ClusterInfo	object	クラスターの詳細。
InstanceCount	integer	クラスター内のインスタンス数。	10
ClusterType	string	クラスタータイプ。有効な値: ManagedKubernetes: マネージド Kubernetes NotManagedKubernetes: 非マネージド Kubernetes PrivateKubernetes: 非公開クラスター kubernetes: 専用 Kubernetes ask: 専用 ASK。	kubernetes
State	string	可用性ステータス。有効な値: unavailable: 利用不可。 Available: 利用可能。 Creating: 作成中。 CreateFailed: 作成に失敗した。	Available
CreateTime	integer	クラスターが作成されたタイムスタンプ。単位: ミリ秒。	1662038134000
ClusterName	string	クラスター名。	testackpro
CurrentVersion	string	クラスターのバージョン情報。	1.22.10-aliyun.1
TargetResult	boolean	クラスタースイッチのステータス。 true: 有効 false: 無効。	true
RegionId	string	クラスターのリージョン ID。	cn-hangzhou
ClusterId	string	クラスター ID。	c870ec78ecbcb41d2a35c679823ef****

例

成功レスポンス

JSONJSON

{
  "RequestId": "24A20733-10A0-4AF6-BE6B-E3322413BB68",
  "ClusterInfo": {
    "InstanceCount": 10,
    "ClusterType": "kubernetes",
    "State": "Available",
    "CreateTime": 1662038134000,
    "ClusterName": "testackpro",
    "CurrentVersion": "1.22.10-aliyun.1",
    "TargetResult": true,
    "RegionId": "cn-hangzhou",
    "ClusterId": "c870ec78ecbcb41d2a35c679823ef****\n"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	ServerError	ServerError
403	NoPermission	caller has no permission

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

変更履歴

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