GetSiteWafSettings - 获取站点的WAF配置_边缘安全加速(ESA)-阿里云帮助中心

该接口用于获取站点WAF配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
esa:GetSiteWafSettings	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	无	无

请求参数

名称	类型	必填	描述	示例值
SiteId	long	否	站点 ID，可通过调用 ListSites 接口获取	1
SiteVersion	integer	否	站点版本。	0
Path	string	否	指定配置路径，不填则代表全部获取。枚举值： bot_management：简易模式Bots。 add_security_headers：添加安全响应头。 client_ip_identifier：客户端IP定义。 add_bot_protection_headers：添加安全请求头。 security_level：安全级别。	bot_management

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	36af3fcc-43d0-441c-86b1-428951dc8225
Settings	WafSiteSettings	站点 WAF 配置详情。

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-12	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2024-09-25	OpenAPI 错误码发生变更	查看变更详情
2024-09-18	OpenAPI 错误码发生变更	查看变更详情