ListSystemClientRules - Security Center - Alibaba Cloud Documentation Center

Queries system defense rules.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
RuleName	string	No	The name of the system defense rule.	Rule\\\\
CurrentPage	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	20
RuleTypes	array	No	The types of the system defense rules.
	integer	No	The type of the system defense rule. Valid values: 0: process-specific defense 1: network-specific defense	1
SystemType	integer	No	The type of the operating system. Valid values: 2: Windows 1: Linux 0: all types	0
AggregationIds	array	No	The IDs of the aggregation types for rules.
	integer	No	The ID of the aggregation type for the rule.	38
IsContainer	integer	No	Specifies whether to query only container images. Valid values: 0: no 1: yes	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	C43CA30F-EF67-51BB-8C95-F31B8303****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	17
RuleList	array	An array that consists of the rules.
	object	The details of the rule.
Status	integer	The status of the rule. Valid values: online: enabled offline: disabled	online
RuleType	integer	The type of the rule. Valid values: 1: alihips 2: alinet 3: alidetect 4: alisecguard	alihips
Platform	string	The type of the operating system. Valid values: windows: Windows linux: Linux all: all types	linux
SwitchId	string	The switch ID of the rule.	USER-ENABLE-SWITCH-TYPE_****
RuleId	long	The ID of the rule.	30****
RuleName	string	The name of the rule.	Rule\\\\
AggregationName	string	The name of the aggregation type for the rule.	Initial entry
Description	string	The description of the rule.	Supports alerting or blocking of images that have high-risk vulnerabilities\\\\
Policies	array	An array that consists of the policies.
	object	The information about the policy.
PolicyName	string	The name of the policy.	System self-starting task\\\\
PolicyKey	string	The policy key.	system_auto_****

Examples

Sample success responses

JSONformat

{
  "RequestId": "C43CA30F-EF67-51BB-8C95-F31B8303****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 17
  },
  "RuleList": [
    {
      "Status": 0,
      "RuleType": 0,
      "Platform": "linux",
      "SwitchId": "USER-ENABLE-SWITCH-TYPE_****",
      "RuleId": 0,
      "RuleName": "Rule\\*\\*\\*\\*\n",
      "AggregationName": "Initial entry\n",
      "Description": "Supports alerting or blocking of images that have high-risk vulnerabilities\\*\\*\\*\\*\n",
      "Policies": [
        {
          "PolicyName": "System self-starting task\\*\\*\\*\\*\n",
          "PolicyKey": "system_auto_****"
        }
      ]
    }
  ]
}

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.