Use ListClientUserDefineRules to query custom defense rules - Security Center

Queries custom 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:ListClientUserDefineRules

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the rule.	Rule****
Type	array	No	The types of rules.
	integer	No	The type of the rule. Valid values: 1: Process hash 2: Command line 3: Process Network 4: File Read and Write 5: Operation on Registry 6: Dynamic-link Library Loading 7: File Renaming	1
CurrentPage	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393***
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.	69
UserDefineRuleList	array<object>	An array that consists of the rules.
	object	The details about the rule.
Type	integer	The type of the rule. Valid values: 1: Process hash 2: Command line 3: Process Network 4: File Read and Write 5: Operation on Registry 6: Dynamic-link Library Loading 7: File Renaming	1
Name	string	The name of the rule.	Rule****
SwitchId	string	The switch ID of the rule.	USER-DEFINE-RULE-SWITCH-TYPE_200****
Id	integer	The ID of the rule.	200****
ActionType	integer	The action of the rule. Valid values: 0: allow 1: block	0
Platform	string	The type of the operating system. Valid values: windows: Windows linux: Linux all: all types	linux

Examples

Success response

JSON format

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393***",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 69
  },
  "UserDefineRuleList": [
    {
      "Type": 1,
      "Name": "Rule****",
      "SwitchId": "USER-DEFINE-RULE-SWITCH-TYPE_200****",
      "Id": 0,
      "ActionType": 0,
      "Platform": "linux"
    }
  ]
}

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.