Use ListInterceptionRulePage to query container firewall defense rules - Security Center - Alibaba Cloud - Security Center

Queries micro-segmentation defense 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:ListInterceptionRulePage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the container cluster to query. This parameter must be the ID of an ACK cluster that has the container firewall feature enabled. Call DescribeClusterInfoList with Type set to interceptionSwitch, or call ListClusterInterceptionConfig to query available clusters.	cc41de13ab5474210bc0ce772a009****
Criteria	string	No	The query condition.	80
CriteriaType	string	No	The type of the search condition. Valid values: ID RULE_NAME SRC_TARGET DST_TARGET DST_PORT RULE_SWITCH INTERCEPTOR_TYPE	DST_PORT
CurrentPage	integer	Yes	The page number of the current page when using paging.	1
PageSize	integer	Yes	The number of entries per page when using paging.	50

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.	ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfo	object	The pagination information of the query result.
CurrentPage	integer	The page number of the current page when using paging.	19
PageSize	integer	The maximum number of entries per page when using paging.	20
TotalCount	integer	The total number of records in the query result.	2
Count	integer	The number of entries on the current page when using paging.	20
InterceptionRuleList	array<object>	The list of queried rules.
	array<object>	The list of queried rules.
RuleType	string	The rule type.	customize
RuleSwitch	integer	The switch status of the scheduling rule. Valid values: 1: Enabled. 0: Disabled.	1
RuleId	integer	The rule ID.	30****
RuleName	string	The rule name.	test
SrcTarget	object	The source object.
AppName	string	The application name.	ack-jenkins-lawr****
RuleType	string	The rule type. Valid values: suggest: intelligent recommendation customize: user-defined system: system	customize
TargetId	integer	The ID of the network object.	40****
TargetName	string	The name of the network object.	mhh-te****
Namespace	string	The namespace.	jenkins
TargetType	string	The type of the affected asset.	containerId
ImageList	array	The list of associated images.
	string	The list of associated images.	nginx:1.****
TagList	array	The list of source tags for the network object.
	string	The list of source tags for the network object.	bpm
DstTarget	object	The destination object.
AppName	string	The application name.	console
RuleType	string	The rule type. Valid values: suggest: intelligent recommendation customize: user-defined system: system	customize
TargetId	integer	The ID of the network object.	302001
TargetName	string	The name of the network object.	demo4****
Namespace	string	The namespace.	test
TargetType	string	The type of the network object.	IMAGE
Ports	array	The port information of the destination server.
	string	The port information.	{"tcp":"1234","udp":"5555"}
ImageList	array	The list of affected images.
	string	The list of affected images.	nacos:v2.0****
TagList	array	The list of destination tags for the network object.
	string	The list of destination tags for the network object.	111
OrderIndex	integer	The sort order.	1
InterceptType	integer	The interception mode. Valid values: 0: monitor mode 1: Block Mode 2: alert mode 3: allow mode	1

Examples

Success response

JSON format

{
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BR****",
  "PageInfo": {
    "CurrentPage": 19,
    "PageSize": 20,
    "TotalCount": 2,
    "Count": 20
  },
  "InterceptionRuleList": [
    {
      "RuleType": "customize",
      "RuleSwitch": 1,
      "RuleId": 0,
      "RuleName": "test",
      "SrcTarget": {
        "AppName": "ack-jenkins-lawr****",
        "RuleType": "customize",
        "TargetId": 0,
        "TargetName": "mhh-te****",
        "Namespace": "jenkins",
        "TargetType": "containerId",
        "ImageList": [
          "nginx:1.****"
        ],
        "TagList": [
          "bpm"
        ]
      },
      "DstTarget": {
        "AppName": "console",
        "RuleType": "customize",
        "TargetId": 302001,
        "TargetName": "demo4****",
        "Namespace": "test",
        "TargetType": "IMAGE",
        "Ports": [
          "{\"tcp\":\"1234\",\"udp\":\"5555\"}"
        ],
        "ImageList": [
          "nacos:v2.0****"
        ],
        "TagList": [
          "111"
        ]
      },
      "OrderIndex": 1,
      "InterceptType": 1
    }
  ]
}

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.