All Products
Search
Document Center

Container Service for Kubernetes:DeployPolicyInstance

Last Updated:Nov 07, 2024

Deploys a policy in the specified namespaces of a specific Container Service for Kubernetes (ACK) cluster. You can create and deploy a security policy by specifying the policy type, action of the policy such as alerting or denying, and namespaces to which the policy applies.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DeployPolicyInstanceget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringYes

The ID of the cluster.

c8155823d057948c69a****
policy_namestringYes

The policy name.

ACKNoEnvVarSecrets
bodyobjectNo

The request body.

actionstringNo

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
namespacesarrayNo

The namespaces to which the policy applies. If you leave this parameter empty, the policy is applicable to all namespaces of the cluster.

stringNo

The namespaces to which the policy applies. If you leave this parameter empty, the policy is applicable to all namespaces of the cluster.

default
parametersobjectNo

The parameter settings of the policy. For more information about the parameters supported by each policy, see Predefined security policies of ACK.

{"restrictedNamespaces": [ "test" ]}

Response parameters

ParameterTypeDescriptionExample
object
instancesarray

A list of policy instances.

instancesstring

The policy instances that are deployed.

[ "allowed-repos-kqxnc" ]

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2021-11-19The response structure of the API has changedView Change Details