Use the DescribePolicyDetails API to query security policy details - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the detailed information about a policy. The information includes the content, action, and severity level of the policy. Container Service for Kubernetes (ACK) provides the following types of predefined security policies: Compliance, Infra, K8s-general, and pod security policy (PSP). These policies ensure that containers are running in the production environment in a secure manner.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cs:DescribePolicyDetails

get

*All Resource

*

None

Request syntax

GET /policies/{policy_name} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
policy_name	string	Yes	The name of the policy.	ACKAllowedRepos

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
name	string	The name of the policy.	ACKAllowedRepos
category	string	The type of the policy.	k8s-general
description	string	The description of the policy.	Requires container images to begin with a repo string from a specified list
action	string	The action of the policy. Valid values: `enforce`: blocks deployments that match the policy. `inform`: generates alerts for deployments that match the policy.	enforce
severity	string	The severity level of the policy. Valid values: `high` `medium` `low`	high
template	string	The content of the policy.	详情请参见请求示例
no_config	integer	Indicates whether parameters are required. Valid values: 0: Parameters are required. 1: Parameters are optional.	0
is_deleted	integer	Indicates whether the policy is deleted. Valid values: 0: The policy is not deleted. 1: The policy is deleted.	0

Examples

Success response

JSON format

{
  "name": "ACKAllowedRepos",
  "category": "k8s-general",
  "description": "Requires container images to begin with a repo string from a specified list",
  "action": "enforce",
  "severity": "high",
  "template": "详情请参见请求示例",
  "no_config": 0,
  "is_deleted": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.