Query the deployment status of policy instances with DescribePolicyInstancesStatus - Container Service for Kubernetes - Alibaba Cloud - Container Service for Kubernetes

Queries the deployment of policy instances in the current Container Service for Kubernetes (ACK) cluster, including the number of policy instances of each type and the number of policy types of each severity level.

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:DescribePolicyInstancesStatus

get

*Cluster

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	The cluster ID.	c8155823d057948c69a****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
policy_instances	array<object>	The number of policy instances of each policy type.
	object
policy_category	string	The type of the policy. For more information about different types of policies and their descriptions, see Predefined security policies of ACK.	compliance
policy_name	string	The name of the policy.	ACKRestrictRoleBindings
policy_description	string	The description of the policy.	Restricts use of the cluster-admin role.
policy_severity	string	The severity level of the policy.	medium
policy_instances_count	integer	The number of policy instances that are deployed. If this parameter is empty, no policy instance is deployed.	1
instances_severity_count	object	The number of policy instances that are deployed in the cluster at different severity levels.	{ "high": 11, "medium": 1 }

Examples

Success response

JSON format

{
  "policy_instances": [
    {
      "policy_category": "compliance",
      "policy_name": "ACKRestrictRoleBindings",
      "policy_description": "Restricts use of the cluster-admin role.",
      "policy_severity": "medium",
      "policy_instances_count": 1
    }
  ],
  "instances_severity_count": {
    "high": 11,
    "medium": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.