ListSystemClientRules - Security Center - Alibaba Cloud Documentation Center

Queries system defense rules.

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:ListSystemClientRules	get	All Resources *	none	none

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: 1: alihips, process-specific defense 2: alinet, network-specific defense	1
SystemType	integer	No	The type of the OS. 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<object>	An array that consists of the system defense rules.
Rule	object	The information about the system defense rule.
Status	integer	The status of the system defense rule. Valid values: online: enabled offline: disabled	online
RuleType	integer	The type of the system defense rule. Valid values: 1: alihips, process-specific defense 2: alinet, network-specific defense	alihips
Platform	string	The type of the OS. Valid values: windows: Windows linux: Linux all: all types	linux
SwitchId	string	The switch ID of the system defense rule.	USER-ENABLE-SWITCH-TYPE_****
RuleId	long	The ID of the system defense rule.	30****
RuleName	string	The name of the system defense rule.	Rule\\\\
AggregationName	string	The name of the aggregation type for the system defense rule.	Initial entry
Description	string	The description of the system defense rule.	Supports alerting or blocking of images that have high-risk vulnerabilities\\\\
Policies	array<object>	An array that consists of policies.
policy	object	The information about the policy.
PolicyName	string	The name of the policy.	System self-starting task\\\\
PolicyKey	string	The policy key.	system_auto_****
SwitchEnable	boolean	Whether the current rule switch takes effect. Valid values: true: enabled false: disabled	true

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_****"
        }
      ],
      "SwitchEnable": true
    }
  ]
}

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
2024-10-08	The response structure of the API has changed	View Change Details