DeployPolicyInstance-阿里云帮助中心

Call the DeployPolicyInstance operation to deploy a policy instance to specified namespaces in an ACK cluster. To create a policy instance, select a security policy, configure a governance action (alert or deny), and specify the target namespaces for the policy.

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

get

*Cluster

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

None

Request syntax

POST /clusters/{cluster_id}/policies/{policy_name} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
cluster_id	string	Yes	The ID of the target cluster.	c8155823d057948c69a****
policy_name	string	Yes	The name of the policy governance rule.	ACKAllowedRepos

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
action	string	No	The governance action. Valid values: `deny`: Denies deployments that violate the rule. `warn`: Generates an alert for deployments that violate the rule.	deny
namespaces	array	No	The namespaces where the policy applies. If you omit this parameter, the policy applies to all namespaces.
	string	No	A namespace where the policy applies.	default
parameters	object	No	For details on the parameters supported by each policy governance rule, see Container security policy rules.	{ "repos": [ "registry-vpc.cn-hangzhou.aliyuncs.com/acs/", "registry.cn-hangzhou.aliyuncs.com/acs/" ] }

Response elements

Element	Type	Description	Example
	object
instances	array	The names of the deployed policy instances.
	string	The name of a deployed policy instance.	[ "allowed-repos-kqxnc" ]

Examples

Success response

JSON format

{
  "instances": [
    "[ \"allowed-repos-kqxnc\" ]"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.