ListContainerDefenseRule - Security Center - Alibaba Cloud Documentation Center

Queries a list of rules for non-image program defense.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RuleType	integer	No	The rule type. Valid values: 1: system rule 2: user-defined rule	1
Conditions	object []	No	The details of the condition.
Type	string	No	The condition type. Valid values: ruleName: the rule name	ruleName
Value	string	No	The rule content.	auto-test-rule-**
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	zh
IsDefaultRule	integer	No	Specifies whether to query system rules. Note This parameter is deprecated.	1

Response parameters

Parameter	Type	Description	Example
	object	PageResult
List	object []	The rules.
RuleId	long	The ID of the rule.	181
RuleType	integer	The type of the rule. Valid values: 1: system rule 2: custom rule	1
RuleName	string	The name of the rule.	test-rule-01
Description	string	The description of the rule.	defense rule.
RuleAction	integer	The action specified in the rule. Valid values: 1: alert 2: block	1
RuleSwitch	integer	The status of the rule. Valid values: 1: enabled 0: disabled	0
ClusterCount	integer	The total number of clusters.	1
ClusterIdList	string	The clusters specified in the rule.	cfb41a8**8a106
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	45
Count	integer	The number of entries returned on the current page.	9
LastRowKey	string	The key of the last data entry.	CAESGgo***jE2NDc4NjE=
NextToken	string	The query credential.	B60***
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.	200
Message	string	The returned message.	successful
RequestId	string	The request ID.	5E3A63BA-***843
HttpStatusCode	integer	The HTTP status code that is returned.	200

Examples

Sample success responses

JSONformat

{
  "List": [
    {
      "RuleId": 181,
      "RuleType": 1,
      "RuleName": "test-rule-01",
      "Description": "defense rule.",
      "RuleAction": 1,
      "RuleSwitch": 0,
      "ClusterCount": 1,
      "ClusterIdList": "cfb41a8**8a106"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 45,
    "Count": 9,
    "LastRowKey": "CAESGgo***jE2NDc4NjE=",
    "NextToken": "B60***"
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5E3A63BA-***843",
  "HttpStatusCode": 200
}

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.