Use ListClusterInterceptionConfig to query cluster defense rules - Security Center - Alibaba Cloud - Security Center

Queries the list of cluster interception rules.

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

yundun-sas:ListClusterInterceptionConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterCNNFStatus	integer	No	The container firewall status of the cluster. Valid values: -1: unknown 0: abnormal 1: normal 2: normal pending confirmation	1
ClusterName	string	No	The cluster name.	sas
PageSize	integer	No	The maximum number of entries per page in a paging query. Default value: 20.	20
CurrentPage	integer	No	The page number of the page to return. Default value: 1, which indicates the first page.	1
ClusterId	string	No	The ID of the container cluster. Note You can call the DescribeContainerInstances operation to obtain this parameter.	c22143730ab6e40b09ec7c1c51d4d****
ExcludeClusterTypes	array	No	The list of excluded cluster types.
	string	No	The excluded cluster type. Note We recommend that you exclude only ACS.	ACS

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	49FDE92F-A0B8-56CC-B7A8-23B17646****
ClusterConfigList	array<object>	The list of cluster configuration information.
	object	The cluster configuration information.
ClusterName	string	The cluster name.	container-opa-kill-02
InterceptionSwitch	integer	The status of the rule interception switch. Valid values: 0: disabled 1: enabled	1
ClusterId	string	The cluster ID.	c9051d30d8a044b4d99e1cb5d25ac****
ClusterCNNFStatus	integer	The container firewall status of the cluster. Valid values: -1: unknown 0: abnormal 1: normal 2: normal pending confirmation	0
OpenRuleCount	integer	The number of active rules.	12
TotalRuleCount	integer	The total number of rules.	123
SupportCNNF	boolean	Indicates whether the container firewall is supported.	false
ClusterType	string	The cluster type. Valid values: ManagedKubernetes: managed Kubernetes NotManagedKubernetes: non-managed Kubernetes PrivateKubernetes: private cluster kubernetes: dedicated Kubernetes ask: dedicated ASK	ManagedKubernetes
PageInfo	object	The paging information.
TotalCount	integer	The total number of cluster interception rules.	11
Count	integer	The number of cluster interception rules on the current page.	11
CurrrentPage	integer	The current page number in a paging query.	1
PageSize	integer	The number of cluster interception rules per page in a paging query.	20

Examples

Success response

JSON format

{
  "RequestId": "49FDE92F-A0B8-56CC-B7A8-23B17646****",
  "ClusterConfigList": [
    {
      "ClusterName": "container-opa-kill-02",
      "InterceptionSwitch": 1,
      "ClusterId": "c9051d30d8a044b4d99e1cb5d25ac****",
      "ClusterCNNFStatus": 0,
      "OpenRuleCount": 12,
      "TotalRuleCount": 123,
      "SupportCNNF": false,
      "ClusterType": "ManagedKubernetes"
    }
  ],
  "PageInfo": {
    "TotalCount": 11,
    "Count": 11,
    "CurrrentPage": 1,
    "PageSize": 20
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.