DescribePolicyInstances によるポリシーインスタンスのクエリ - 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:DescribePolicyInstances

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PolicyName	string	必須	ポリシーの名前。	ACKNoEnvVarSecrets
ClusterId	string	必須	マスターインスタンスの ID。	c102fe5f1ee5d4c87a68121a77d8b****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	5BE4C329-DCC2-5B61-8F66-112B7D7FC712
Policies	array<object>	ポリシーインスタンスのリスト。
	array<object>	ポリシーインスタンス。
PolicyName	string	ポリシーの名前。	ACKPSPCapabilities
InstanceName	string	ポリシーインスタンスの名前。	no-env-var-secrets-****
PolicyCategory	string	ポリシーのタイプ。	k8s-general
PolicyDescription	string	ポリシーの説明。	Restricts secrets used in pod envs
PolicySeverity	string	ポリシーの重大度レベル。	low
PolicyScope	string	ポリシーインスタンスの適用範囲。値が * の場合は、すべての名前空間を示します。これがデフォルト値です。複数の名前空間はコンマ (,) で区切ります。	*
PolicyAction	string	ポリシーのアクション。有効な値： deny：ポリシーに一致するデプロイメントをブロックします。 warn：ポリシーに一致するデプロイメントに対してアラートを生成します。	warn
TotalViolations	integer	関連付けられたクラスター内でポリシーに一致するデプロイメントの総数。ブロックされたデプロイメントとアラートをトリガーしたデプロイメントが含まれます。	2
ClusterId	string	関連付けられたクラスターの ID。	cd0e6882394f7496589837cac3585****
PolicyParameters	object	ポリシーインスタンスのパラメーター。
	string	ポリシーインスタンスのパラメーター。	"restrictedNamespaces": [ "test" ]

例

成功レスポンス

JSONJSON

{
  "RequestId": "5BE4C329-DCC2-5B61-8F66-112B7D7FC712",
  "Policies": [
    {
      "PolicyName": "ACKPSPCapabilities",
      "InstanceName": "no-env-var-secrets-****\n",
      "PolicyCategory": "k8s-general\n",
      "PolicyDescription": "Restricts secrets used in pod envs\n",
      "PolicySeverity": "low",
      "PolicyScope": "*",
      "PolicyAction": "warn",
      "TotalViolations": 2,
      "ClusterId": "cd0e6882394f7496589837cac3585****",
      "PolicyParameters": {
        "key": "\"restrictedNamespaces\": [ \"test\" ]\n"
      }
    }
  ]
}

エラーコード

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

変更履歴

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