Query the system default rules for the specified domain name - DescribeWafSystemRules
Overview
Query the system default rules for the specified domain name
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeWafSystemRules . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface. | No |
FullDomain | string | Domain to query | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Rules | array[SystemRuleInfo] | List of rule contents, refer to SystemRuleInfo | No |
Data Model
SystemRuleInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
SysRuleset | int | Start Rule Number | No |
Action | string | Action | No |
RiskRank | string | Risk Level | No |
RulesetType | string | Rule Set Type | No |
Priority | int | Priority | No |
AttackType | string | Attack Type | No |
Description | string | Rule Description | No |
Example
Request Example
https://api.dezai.com/?Action=DescribeWafSystemRules
&ProjectId=org-xxx
&FullDomain=www.test.com
Response Example
{
"Action": "DescribeWafSystemRulesResponse",
"RetCode": 0,
"Rules": [
{
"Action": "ACCEPT",
"AttackType": "default",
"Description": "默认放行-未做归类",
"Priority": 1,
"RiskRank": "high",
"RulesetType": "system",
"SysRuleset": 10000
}
]
}