ListSystemClientRules API to query system defense rules - Security Center

Queries system 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:ListSystemClientRules

get

*All Resource

*

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 elements

Element	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.
	array<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	integer	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 images with high-risk vulnerabilities in cluster****
Policies	array<object>	An array that consists of policies.
	object	The information about the policy.
PolicyName	string	The name of the policy.	System auto-start 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

Success response

JSON format

{
  "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****",
      "AggregationName": "Initial entry",
      "Description": "Supports alerting or blocking images with high-risk vulnerabilities in cluster****",
      "Policies": [
        {
          "PolicyName": "System auto-start task****",
          "PolicyKey": "system_auto_****"
        }
      ],
      "SwitchEnable": true
    }
  ]
}

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.