DescribePolicyInstances - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

Container Service for Kubernetes (ACK) クラスター内の指定されたタイプのポリシーインスタンス (ポリシーの説明や深刻度レベルなど) の詳細情報を照会します。ACK クラスターのセキュリティポリシーのタイプを選択し、ポリシーのアクションと適用範囲を指定して、ポリシーインスタンスを作成およびデプロイできます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:DescribePolicyInstances

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエスト構文

GET /clusters/{cluster_id}/policies HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
cluster_id	string	必須	クラスターの ID。	c8155823d057948c69a****

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
policy_name	string	任意	照会するポリシーの名前。	ACKPSPCapabilities
instance_name	string	任意	照会するポリシーインスタンスの名前。	allowed-repos-cz4s2

レスポンスフィールド

フィールド	型	説明	例
	array	ポリシーインスタンスのリスト。
	object	ポリシーインスタンス。
ali_uid	string	ポリシーインスタンスのデプロイに使用される Alibaba Cloud アカウントの UID。	16298168****
cluster_id	string	クラスターの ID。	c8155823d057948c69a****
instance_name	string	ポリシーインスタンスの名前。	no-env-var-secrets-****
policy_name	string	ポリシーの名前。	ACKPSPCapabilities
policy_category	string	ポリシーのタイプ。	k8s-general
policy_description	string	ポリシーテンプレートの説明。	Restricts secrets used in pod envs
policy_parameters	string	ポリシーインスタンスのパラメーター。	"restrictedNamespaces": [ "test" ]
policy_severity	string	ポリシーインスタンスの深刻度レベル。	low
policy_scope	string	ポリシーインスタンスの適用範囲。値に * を指定すると、クラスター内のすべての名前空間を示します。これはデフォルト値です。複数の名前空間はコンマ (,) で区切ります。	*
policy_action	string	ポリシーのアクション。有効な値： `deny`：ポリシーに一致するデプロイメントは拒否されます。 `warn`：ポリシーに一致するデプロイメントに対してアラートが生成されます。	deny
Created `deprecated`	string	インスタンスの作成時間。このパラメーターは非推奨です。	2024-10-29T18:09:12+08:00
Updated `deprecated`	string	インスタンスの更新時間。このパラメーターは非推奨です。	2024-10-29T18:09:12+08:00
resource_id `deprecated`	string	リソースの ID。このパラメーターは非推奨です。	123456***
total_violations `deprecated`	integer	クラスターで処理された違反の数。このパラメーターは非推奨です。	0
is_deleted `deprecated`	integer	削除のステータス。このパラメーターは非推奨です。	0

例

成功レスポンス

JSONJSON

[
  {
    "ali_uid": "16298168****",
    "cluster_id": "c8155823d057948c69a****",
    "instance_name": "no-env-var-secrets-****",
    "policy_name": "ACKPSPCapabilities",
    "policy_category": "k8s-general",
    "policy_description": "Restricts secrets used in pod envs",
    "policy_parameters": "\"restrictedNamespaces\": [ \"test\" ]",
    "policy_severity": "low",
    "policy_scope": "*",
    "policy_action": "deny",
    "Created": "2024-10-29T18:09:12+08:00",
    "Updated": "2024-10-29T18:09:12+08:00",
    "resource_id": "123456***",
    "total_violations": 0,
    "is_deleted": 0
  }
]

エラーコード

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

変更履歴

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