GetSiteWafSettings - Edge Security Acceleration - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get WAF Configuration for a Site

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	long	No	Site ID, which can be obtained by calling the ListSites API.	1
SiteVersion	integer	No	Site version.	0
Path	string	No	Specifies the configuration path. If not provided, all configurations will be retrieved. Enumeration Value: bot_management: Simple Mode Bots. add_security_headers: Adding security response headers. client_ip_identifier: Client IP Definition. add_bot_protection_headers: Adding security request headers. security_level: Security Level.	bot_management

Response parameters

Parameter	Type	Description	Example
	object	Response result.
RequestId	string	Request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Settings	WafSiteSettings	Details of site WAF configuration.

Examples

Sample success responses

JSONformat

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Settings": {
    "ClientIpIdentifier": {
      "Mode": "headers",
      "Headers": [
        "X-Forwarded-For"
      ]
    },
    "AddBotProtectionHeaders": {
      "Enable": true
    },
    "AddSecurityHeaders": {
      "Enable": true
    },
    "SecurityLevel": {
      "Value": "low"
    },
    "BotManagement": {
      "DefiniteBots": {
        "Id": 20000001,
        "Action": "captcha"
      },
      "LikelyBots": {
        "Id": 20000002,
        "Action": "deny"
      },
      "VerifiedBots": {
        "Id": 20000003,
        "Action": "bypass"
      },
      "JSDetection": {
        "Enable": true
      },
      "EffectOnStatic": {
        "Enable": true
      }
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-12	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-09-25	The Error code has changed	View Change Details
2024-09-18	The Error code has changed	View Change Details