All Products
Search
Document Center

Container Service for Kubernetes:DescribePolicyInstancesStatus

Last Updated:Nov 07, 2024

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.

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:DescribePolicyInstancesStatusget
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringYes

The cluster ID.

c8155823d057948c69a****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

policy_instancesarray<object>

The number of policy instances of each policy type.

policy_instancesobject
policy_categorystring

The type of the policy. For more information about different types of policies and their descriptions, see Predefined security policies of ACK.

compliance
policy_namestring

The name of the policy.

ACKRestrictRoleBindings
policy_descriptionstring

The description of the policy.

Restricts use of the cluster-admin role.
policy_severitystring

The severity level of the policy.

medium
policy_instances_countlong

The number of policy instances that are deployed. If this parameter is empty, no policy instance is deployed.

1
instances_severity_countobject

The number of policy instances that are deployed in the cluster at different severity levels.

{ "high": 11, "medium": 1 }

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history