ListInterceptionRulePage - Security Center - Alibaba Cloud Documentation Center

Queries defense rules that are configured for the container firewall feature.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:ListInterceptionRulePage	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The ID of the container cluster.	cc41de13ab5474210bc0ce772a009****
Criteria	string	No	The query condition.	80
CriteriaType	string	No	The type of the query condition. Valid values: ID RULE_NAME SRC_TARGET DST_TARGET DST_PORT RULE_SWITCH INTERCEPTOR_TYPE	DST_PORT
CurrentPage	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	50

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	19
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	2
Count	integer	The number of entries returned on the current page.	20
InterceptionRuleList	array<object>	An array that consists of information about the defense rules.
Rule	object	The information about the defense rule.
RuleType	string	The type of the defense rule.	customize
RuleSwitch	integer	The status of the defense rule. Valid values: 1: enabled 0: disabled	1
RuleId	long	The ID of the defense rule.	30****
RuleName	string	The name of the defense rule.	test
SrcTarget	object	The source network object.
AppName	string	The name of the application.	ack-jenkins-lawr****
RuleType	string	The type of the defense rule. Valid values: suggest: intelligently recommended rule customize: custom rule system: system rule	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 assets.	containerId
ImageList	array	An array that consists of the images of the network object.
image	string	The images.	nginx:1.****
TagList	array	An array that consists of tags added to the source network object.
tag	string	The tags added to the source network object.	bpm
DstTarget	object	The destination network object.
AppName	string	The name of the application.	console
RuleType	string	The type of the defense rule. Valid values: suggest: intelligently recommended rule customize: custom rule system: system rule	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	An array that consists of information about the ports used by the destination server.
port	string	The ports.	{"tcp":"1234","udp":"5555"}
ImageList	array	An array that consists of the affected images.
image	string	The affected images.	nacos:v2.0****
TagList	array	An array that consists of tags added to the destination network object.
tag	string	The tags added to the destination network object.	111
OrderIndex	long	The order in which the entries are sorted.	1
InterceptType	long	The interception mode. Valid values: 0: monitor 1: block 2: alert 3: allow	1

Examples

Sample success responses

JSONformat

{
  "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
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation

No change history