DescribePolicyGovernanceInCluster を使用してクラスターのポリシーガバナンスをクエリする - 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adcp:DescribePolicyGovernanceInCluster

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	マスターインスタンスの ID。	c09946603cd764dac96135f51d1ba****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	96C6A284-0EC3-5486-9A97-E8E9EE27E9EF
PolicyGovernances	array<object>	ポリシーの詳細情報。
	array<object>	ポリシーの詳細情報。
Cluster	object	ポリシーがデプロイされている関連クラスターに関する情報。
ClusterId	string	関連クラスターの ID。	ca5cf1b5edb5c4736a6ea0dfb4061****
Name	string	関連クラスターの名前。	ack-001
RegionId	string	関連クラスターのリージョン ID。	cn-heyuan
State	string	関連クラスターのステータス。	running
ClusterType	string	関連クラスターのタイプ。	ManagedKubernetes
ClusterSpec	string	関連クラスターの仕様。	ack.pro.small
Profile	string	関連クラスターの識別子。	Default
PolicyGovernance	object	ポリシーの詳細情報。
OnState	array<object>	関連クラスターで有効になっている各深刻度レベルのポリシー数。
	object	関連クラスターで有効になっている各深刻度レベルのポリシー数。
EnabledCount	integer	関連クラスターで有効になっているポリシーのタイプ。	2
TotalCount	integer	各深刻度レベルのポリシーのタイプ。	2
Severity	string	深刻度レベル。	low
AdmitLog	object	関連クラスターによって生成された監査ログ。
Progress	string	クエリのステータス。有効な値： Complete：クエリは成功し、完全な結果が返されます。 Incomplete：クエリは成功しましたが、クエリ結果は不完全です。完全な結果を取得するには、操作を再度呼び出す必要があります。	Complete
Count	string	クエリ結果のログエントリ数。	100
Logs	array<object>	監査ログの内容。
	object	監査ログの内容。
	string	監査ログの内容。	c8155823d057948c69a****
LogProject	string	Log Service プロジェクトの名前。	demo
LogStore	string	Logstore の名前。	demo
Violation	object	ブロック済みのデプロイメントやアラートがトリガーされたデプロイメントを含む、関連クラスター内のポリシーに一致するデプロイメントの数。
TotalViolations	object	ブロック済みのデプロイメントやアラートがトリガーされたデプロイメントを含む、関連クラスター内のポリシーに一致するデプロイメントの数。デプロイメントは深刻度レベルによって分類されます。
Deny	array<object>	ブロック済みのデプロイメントに関する情報。
	object	ブロック済みのデプロイメントに関する情報。
Severity	string	深刻度レベル。	low
Violations	integer	ブロック済みのデプロイメントの数。	2
Warn	array<object>	アラートがトリガーされたデプロイメントに関する情報。
	object	アラートがトリガーされたデプロイメントに関する情報。
Severity	string	深刻度レベル。	low
Violations	string	アラートがトリガーされたデプロイメントの数。	2
Violations	object	ブロック済みのデプロイメントやアラートがトリガーされたデプロイメントを含む、関連クラスター内のポリシーに一致するデプロイメントの数。デプロイメントはポリシータイプによって分類されます。
Deny	array<object>	ブロック済みのデプロイメントに関する情報。
	object	ブロック済みのデプロイメントに関する情報。
PolicyName	string	ポリシーの名前。	ACKPSPCapabilities
PolicyDescription	string	ポリシーの説明。	Restricts secrets used in pod envs
Severity	string	ポリシーの深刻度レベル。	low
Violations	integer	ポリシーがデプロイメントをブロックした回数。	2
Warn	array<object>	アラートがトリガーされたデプロイメントに関する情報。
	object	アラートがトリガーされたデプロイメントに関する情報。
PolicyName	string	ポリシーの名前。	ACKPSPCapabilities
PolicyDescription	string	ポリシーの説明。	Restricts secrets used in pod envs
Severity	string	ポリシーの深刻度レベル。	low
Violations	integer	ポリシーがアラートを生成した回数。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "96C6A284-0EC3-5486-9A97-E8E9EE27E9EF",
  "PolicyGovernances": [
    {
      "Cluster": {
        "ClusterId": "ca5cf1b5edb5c4736a6ea0dfb4061****",
        "Name": "ack-001",
        "RegionId": "cn-heyuan",
        "State": "running",
        "ClusterType": "ManagedKubernetes",
        "ClusterSpec": "ack.pro.small ",
        "Profile": "Default"
      },
      "PolicyGovernance": {
        "OnState": [
          {
            "EnabledCount": 2,
            "TotalCount": 2,
            "Severity": "low"
          }
        ],
        "AdmitLog": {
          "Progress": "Complete",
          "Count": "100",
          "Logs": [
            {
              "key": "c8155823d057948c69a****\n"
            }
          ],
          "LogProject": "demo",
          "LogStore": "demo"
        },
        "Violation": {
          "TotalViolations": {
            "Deny": [
              {
                "Severity": "low",
                "Violations": 2
              }
            ],
            "Warn": [
              {
                "Severity": "low",
                "Violations": "2"
              }
            ]
          },
          "Violations": {
            "Deny": [
              {
                "PolicyName": "ACKPSPCapabilities",
                "PolicyDescription": "Restricts secrets used in pod envs\n",
                "Severity": "low",
                "Violations": 2
              }
            ],
            "Warn": [
              {
                "PolicyName": "ACKPSPCapabilities",
                "PolicyDescription": "Restricts secrets used in pod envs\n",
                "Severity": "low",
                "Violations": 2
              }
            ]
          }
        }
      }
    }
  ]
}

エラーコード

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

変更履歴

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