Container Web Defense Rules Overview - Security Center - Alibaba Cloud - Security Center

Retrieves a container file defense rule.

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:GetSasContainerWebDefenseRule

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RuleId	integer	No	The rule ID. Note You can call the ListSasContainerWebDefenseRule operation to obtain this parameter.	1600009

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	BA674E4**62FB5133
ContainerWebDefenseRule	object	The details of the container file defense rule.
RuleStatus	integer	The rule status. Valid values: 1: Enabled. 0: Disabled.	1
AliUid	integer	The user ID.	1000**0002
AppTotalCount	integer	The total number of applications.	1
Id	integer	The rule ID.	100
RuleName	string	The rule name.	防篡改规则
GmtCreate	integer	The timestamp when the rule was created. Unit: milliseconds.	1709173360000
GmtModified	integer	The timestamp when the rule was modified. Unit: milliseconds.	1655432638000
PathConfDTOList	array<object>	The list of configured file paths.
	object
ExcludeFile	string	Excluded files.	file1
GuardType	integer	Protection mode. 0: Basic mode (whitelist) 1: Advanced mode (blacklist)	0
ExcludeFilePath	string	Excluded file path.	/test2/sub1,/test2/sub2
IncludeFile	string	Included files.	webapp
DefensePath	string	Defense path	/test11*
ExcludeFileType	string	Exclude file types.	doc
DefenseMode	string	Action to be executed. block : Block audit : Alert	audit
BackupPath	string	Backup path.	/usr/path/
IncludeFileType	string	Type of included files.	doc
ProcessPathList	array	Whitelist process list.
	string	Whitelist process.	/bin/proc1a,/bin/proc1b

Examples

Success response

JSON format

{
  "RequestId": "BA674E4**62FB5133",
  "ContainerWebDefenseRule": {
    "RuleStatus": 1,
    "AliUid": 0,
    "AppTotalCount": 1,
    "Id": 100,
    "RuleName": "防篡改规则",
    "GmtCreate": 1709173360000,
    "GmtModified": 1655432638000,
    "PathConfDTOList": [
      {
        "ExcludeFile": "file1",
        "GuardType": 0,
        "ExcludeFilePath": "/test2/sub1,/test2/sub2",
        "IncludeFile": "webapp",
        "DefensePath": "/test11*",
        "ExcludeFileType": "doc",
        "DefenseMode": "audit",
        "BackupPath": "/usr/path/",
        "IncludeFileType": "doc",
        "ProcessPathList": [
          "/bin/proc1a,/bin/proc1b"
        ]
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.