DescribePolicyInstances - Container Service for Kubernetes

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the detailed information about policy instances of the specified type in a Container Service for Kubernetes (ACK) cluster, such as the policy description and severity level. You can choose a type of security policy for an ACK cluster, specify the action and applicable scope of the policy, and then create and deploy a policy instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribePolicyInstances	get	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	The cluster ID.	c8155823d057948c69a****
policy_name	string	No	The name of the policy that you want to query.	ACKPSPCapabilities
instance_name	string	No	The name of the policy instance that you want to query.	allowed-repos-cz4s2

Response parameters

Parameter	Type	Description	Example
	array<object>	The list of the returned policy instances.
	object
ali_uid	string	The UID of the Alibaba Cloud account that is used to deploy the policy instance.	16298168****
cluster_id	string	The ID of the cluster.	c8155823d057948c69a****
instance_name	string	The name of the policy instance.	no-env-var-secrets-****
policy_name	string	The name of the policy.	ACKPSPCapabilities
policy_category	string	The type of policy.	k8s-general
policy_description	string	The description of the policy template.	Restricts secrets used in pod envs
policy_parameters	string	The parameters of the policy instance.	"restrictedNamespaces": [ "test" ]
policy_severity	string	The severity level of the policy instance.	low
policy_scope	string	The applicable scope of the policy instance. A value of * indicates all namespaces in the cluster. This is the default value. Multiple namespaces are separated by commas (,).	*
policy_action	string	The action of the policy. Valid values: `deny`: Deployments that match the policy are denied. `warn`: Alerts are generated for deployments that match the policy.	deny

Examples

Sample success responses

JSONformat

[
  {
    "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"
  }
]

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-23	The response structure of the API has changed	View Change Details