Skip to Content
WEB应用防火墙 UEWAF添加域名黑名单 - AddWafDomainBlackList

添加域名黑名单 - AddWafDomainBlackList

简介

添加域名黑名单

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 AddWafDomainBlackListYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
ProjectIdstring
项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口
No
FullDomainstring要添加黑名单的域名Yes
Sourcestring黑名单来源, 用户自定义(custom)/机器行为检测(bot)/ bot-rule/ auto(自动拦截规则)Yes
Typestring类型:境内(internal)、境外(oversea),自定义(custom)Yes
ActionTypestring执行动作: 可选值:拦截请求(forbidden) ,验证码(captcha)Yes
ExpireTimeint过期时间,即有效时长,单位为秒,永不过期传0Yes
RecordIdint域名记录IDNo
DestIpstring目标IP; Source为bot时需传递No
CIDRS.NstringIP、网段或者IP段,传递数组;类型为custom时必填No
Remarkstring备注信息No
Namestring名称No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
Idint添加成功后返回的域名黑名单IDNo

示例

请求示例

https://api.an-link.com/?Action=AddWafDomainBlackList &ProjectId=org-xxx &FullDomain=www.test.com &Source=custom &Type=custom &ActionType=forbidden &CIDRS.0=2.2.2.2 &ExpireTime=10 &Remark=test &Name=DqXFAQfT

响应示例

{ "Action": "AddWafDomainBlackListResponse", "Id": 6, "RetCode": 0 }