GetClientUserDefineRule - Security Center - Alibaba Cloud Documentation Center

Queries the information about a custom defense rule.

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:GetClientUserDefineRule	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Id	long	Yes	The ID of the custom defense rule.	200****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	0B48AB3C-84FC-424D-A01D-B9270EF4****
UserDefineRuleDetail	object	The information about the custom defense rule.
Type	integer	The type of the custom defense 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
ActionType	string	The action of the custom defense rule. Valid values: 0: allow 1: block	0
GmtCreate	long	The time when the custom defense rule was created.	167118088****
Md5List	string	The hash values of processes.	0c9045b5bec90f9825f1f3f64dd4****
GmtModified	long	The time when the custom defense rule was last modified.	167118088****
Name	string	The name of the custom defense rule.	Rule\\\\
Id	long	The ID of the custom defense rule.	200****
ProcPath	string	The path to the process.	c:/windows/system32/i****
Cmdline	string	The command line.	/usr/sbin/s****
Platform	string	The type of the operating system. Valid values: linux windows all	linux
IP	string	The IP address.	10.240.XX.XX
Port	integer	The port number.	22
FilePath	string	The file path.	/etc/pam****
NewFilePath	string	The new file path after the file is renamed.	/etc/pam****
RegistryKey	string	The registry key.	HKEY_DYN_****
RegistryContent	string	The registry value.	SECOH-QAD.exe
ParentProcPath	string	The path to the parent process.	c:/windows/system32/i****
ParentCmdline	string	The parent command line.	/usr/sbin/s****
PortStr	string	The port number. Valid values: 1 to 65535.	80
Domain	string	The domain name.	example.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF4****",
  "UserDefineRuleDetail": {
    "Type": 1,
    "ActionType": "0",
    "GmtCreate": 0,
    "Md5List": "0c9045b5bec90f9825f1f3f64dd4****\n",
    "GmtModified": 0,
    "Name": "Rule\\*\\*\\*\\*\n",
    "Id": 0,
    "ProcPath": "c:/windows/system32/i****\n",
    "Cmdline": "/usr/sbin/s****\n",
    "Platform": "linux",
    "IP": "10.240.XX.XX\n",
    "Port": 22,
    "FilePath": "/etc/pam****\n",
    "NewFilePath": "/etc/pam****\n",
    "RegistryKey": "HKEY_DYN_****\n",
    "RegistryContent": "*SECOH-QAD.exe*\n",
    "ParentProcPath": "c:/windows/system32/i****\n",
    "ParentCmdline": "/usr/sbin/s****\n",
    "PortStr": "80",
    "Domain": "example.com"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidId	Invalid ID.	-
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-03-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-07	The Error code has changed	View Change Details