枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": { "createTime": 1725589924, "updateTime": 1729756428, "id": 6, "uid": "e974b0438b814fc08ec8e499643e530f", "regionId": "b342b77ef26b11ecb0ac0242ac110002", "firewallId": "c7cfe772fd3f482da630132e6548a19a", "vpatch": "on", "ddosProtect": "on", "runmode": "block", "version": 23, "avProtect": "off" }, "statusCode": "800" } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 下发dpi配置并保存配置，实现配置持久化 接口约束 传参规范 URI POST /vfw/v2dpisave 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ddosProtect 否 String DDos防护开关 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 runmode 否 String 运行模式 avProtect 否 String AV防护开关 vpatch 否 String 虚拟补丁开关 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header {"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"} 请求体body { "firewallId":"c7cfe772fd3f482da630132e6548a19a", "vpatch":"on", "runmode":"block", "ddosProtect":"on", "avProtect":"off" }

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id master NodeSpaceUsage 主节点空间使用情况 ip String 节点IP path String 节点数据目录，备份机为备份目录 diskTotal String 硬盘总大小，单位G diskUsage String 硬盘使用率，单位% slaves List 从节点空间使用信息列表，没有从节点则为空 backup NodeSpaceUsage 备机空间使用情况，无备机则为空

接口描述 为指定的Postgresql实例解绑标签,每次解绑的标签数量不能超过20个 请求方法 POST URI /v1/label/untaglabels 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 否 标签id列表,一次最多只能设置20个，unTagAllfalse时，该值必填 unTagAll body boolean 否 是否全部解绑，不传入labelIds才有效 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/label/untagLabels { "labelIds": [ 1, 3 ], "labelType": 2, "prodInstId": 60, "unTagAll": false } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 分页查询当前用户创建的标签 请求方法 GET URI /v1/label/pagetaglabel 请求参数 名称 位置 类型 必选 说明 prodInstIds query List 否 实例id列表 labelName query String 否 标签名 labelValue query String 否 标签值 pageNum query Integer 是 当前页,默认1 pageSize query Integer 是 页大小，默认10，最大限制500 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object pageNum Integer 当前页 pageSize Integer 页大小 pageTotal Integer 页码总数 total Integer 总记录数 list Array 记录 id Long 标签id labelName String 标签名称 labelValue String 标签值 prodInstId Long 实例id labelType Integer 资源标签分类标识，1主机，2实例 remark String 标签描述 示例 请求示例 /v1/label/pageTagLabel?pageNum1&pageSize10 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "id": 5, "labelName": "test2", "labelType": 2, "labelValue": "test2", "prodInstId": 53, "remark": "" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 1 }, "statusCode": 800 }

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id logTime query String 否 日志时间，只清理或者压缩该时间（包括该时间）之前的日志， 格式：yyyyMMdd HH:mm:ss， purge query Integer 否 压缩或者清理日志，0:清理，1：压缩；默认进行压缩 logFieNames query List 否 日志文件名称，若传入该值，会忽略日志时间，只清理或者压缩这些文件，限制500个， 和logTime不能同时为空

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

本节介绍如何解决证书链不完整问题。 如果证书机构提供的证书在用户平台内置信任库中查询不到，且证书链中没有颁发机构，则证明该证书是不完整的证书。使用不完整的证书，当用户访问防护域名对应的浏览器时，因不受信任而不能正常访问防护域名对应的浏览器。 按以下两种方法可解决此问题： 手动构造完整证书链，并上传证书。（WAF自动补全证书链功能正在开发中，敬请期待！） 重新上传正确的证书。 Chrome最新版本一般是支持自动验证信任链，手工构造完整的证书链步骤如下： 步骤1 查看证书 。单击浏览器前的锁，可查看证书状况。 步骤2 查看证书链 。单击“证书”，并选中“证书路径”页签，可单击证书名称查看证书状态。 步骤3 逐一将证书另存到本地 。 选中证书名称，单击“详细信息”页签，如图所示。 单击“复制到文件”，按照界面提示，单击“下一步”。 选择“Base64编码”，单击“下一步”，如图所示。 步骤4 证书全部导出到本地后，用记事本打开证书文件，图重组证书顺序，完成证书重构。

名称 位置 类型 必选 说明 prodInstId query String 是 实例id

时间段 QPS平均取值说明 QPS峰值取值说明 “昨天”、“今天” 间隔1分钟，取1分钟内的平均值 间隔1分钟，取1分钟内的最大值 “3天” 间隔5分钟，取5分钟内的平均值 间隔5分钟，取5分钟内的最大值 “7天” 间隔10分钟，取每5分钟内平均值的最大值 间隔10分钟，取10分钟内最大值 “30天” 间隔1小时，取每5分钟内平均值的最大值 间隔1小时，取1小时内最大值

接口描述 查询Postgresql实例IP白名单。 请求方法 GET URI /v1/whitelist/query 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj List IP白名单列表 示例 请求示例 /v1/whiteList/queryIPWhiteList?prodInstId15 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ "127.0.0.1", "192.168.174.1" ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 位置 类型 必选 说明 labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 是 标签列表,一次最多只能新增50个 labelName body String 是 资源标签名称，同一租户下标签名称唯一、平台标签名称唯一 labelValue body String 否 标签值 remark body String 否 标签说明

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id

参数 是否必填 参数类型 说明 示例 下级对象 vpcId 否 String VPC ID cfcbed30ca9e432daa8b87ef0eb6a9aa

对于有些网站，源IP无法精准获取。例如：存在未在header中插入“XForwardedFor”字段的Proxy或其他原因，建议使用配置Cookie字段实现用户标识并开启“全局计数”。 攻击案例 竞争对手控制数台主机，与大多普通访客一样，共用同一IP，或通过代理频繁更换源IP，持续向网站“www.example.com”发起HTTP Post请求，网站并无较大的负载能力，网站连接数、带宽等资源均被该攻击者大量占用，正常用户无法访问网站，最终竞争力急剧下降。 防护措施 步骤1 根据服务访问请求统计，判断网站是否有大量同一IP请求发生，如果有则说明网站很有可能遭受了CC攻击。 步骤2 登录管理控制台，将您的网站成功接入Web应用防火墙。关于域名接入的具体操作请参见网站接入WAF。 步骤3 在目标域名所在行的“防护策略”栏中，单击“已开启N项防护”，进入“防护策略”页面，确认“CC攻击防护”的“状态”为“开启”。 步骤4 开启WAF的“CC攻击防护”后，添加CC防护规则，配置“用户限速”模式，输入用户标识，即Cookie字段中的变量名。为了更加有效的标识用户，建议使用“sessionid”或“token”这类标识网站后台颁发给用户的唯一标识字段。 说明 “防护模式”选择“阻断”模式，设置“阻断时长”，能够在攻击被拦截后，攻击者需额外等待一段时间， 该设置能进一步对攻击者行为进行限制，建议对安全要求非常高的用户设置。 添加CC防护规则 限速模式：选择“源限速”、“用户限速”，根据Cookie键值区分单个Web访问者。 用户标识：为了更加有效的标识用户，建议使用“sessionid”或“token”这类标识网站后台颁发给用户的唯一标识字段。 限速频率：单个Web访问者在限速周期内可以正常访问的次数，如果超过该访问次数，Web应用防火墙服务将暂停该Web访问者的访问。 防护动作：选择“阻断”模式。该模式可设置“阻断时长”，在攻击被拦截后，攻击者需额外等待一段时间才能访问正常的网页， 该设置能进一步对攻击者行为进行限制，建议对安全要求非常高的用户设置。 人机验证：表示在指定时间内访问超过次数限制后弹出验证码，进行人机验证，完成验证后，请求将不受访问限制。 阻断：表示在指定时间内访问超过次数限制将直接阻断。 仅记录：表示在指定时间内访问超过次数限制将只记录不阻断。 阻断页面：可选择“默认设置”或者“自定义”。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 是 标签id列表,一次最多只能设置20个

错误码 访问ErrorCodes说明文档查看更多错误码。

参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象

本节介绍如何使用内容安全检测服务。 Web应用防火墙提供内容安全检测服务，基于丰富的违规样例库和内容审核专家经验，通过机器审核加人工审核结合的方式，帮助您准确检测出Web网站和新媒体平台上的关于涉黄、涉赌、涉毒、暴恐、涉政、惊悚、违禁广告等敏感违规内容，并提供文本内容纠错审校（错别字、生僻字、语法表述不当等有违准确性内容）。并提供专业检测报告助您自纠自查，降低内容违规风险。 使用须知 购买内容安全检测服务后，系统立即执行检测。 检测过程中，不支持修改检测域名、暂停任务、退费等操作。 确定网站检测配额。 “检测类型”选择“内容安全单次检测（按需）”时，下单后的7个工作日内出报告。 “检测类型”选择“文本安全监测（按月/按年）”时，下单后的检测周期（1个月）后的7个工作日内出报告。 10个工作日内检测完成。 步骤一：购买内容安全检测 购买内容安全检测，配置“检测类型”和“检测对象”，可对“检测对象”对应的文本类型进行安全检测。 支持批量购买内容安全检测，可一次输入一个或多个“检测对象”进行安全检测。购买步骤详见订购内容安全检测。 注意 检测任务创建后，一次性扣费，不支持修改和暂停任务，请您仔细核对检测信息。

名称 位置 类型 必选 说明 templateId query Long 是 参数模板ID name query String 否 参数名称 prodInstId query Long 是 实例id

权限 授权项 查询防敏感信息泄漏规则 waf:antiLeakageRule:get 查询网页防篡改规则 waf:antiTamperRule:get 查询CC攻击防护规则 waf:ccRule:get 查询精准访问防护规则 waf:preciseProtectionRule:get 查询误报屏蔽规则 waf:falseAlarmMaskRule:get 查询隐私屏蔽规则 waf:privacyRule:get 查询黑白名单规则 waf:whiteBlackIpRule:get 查询地址位置访问控制规则 waf:geoIpRule:get 查询证书 waf:certificate:get 修改WAF证书 waf:certificate:put 查询防护事件 waf:event:get 查询防护域名 waf:instance:get 查询防护策略 waf:policy:get 查询用户套餐信息 waf:bundle:get 查询防护事件下载链接 waf:dumpEventLink:get 查询页面配置信息 waf:consoleConfig:get 查询回源IP段 waf:sourceIp:get 更新防敏感信息泄漏规则 waf:antiLeakageRule:put 更新网页防篡改规则 waf:antiTamperRule:put 更新CC攻击防护规则 waf:ccRuleRule:put 更新精准访问防护规则 waf:preciseProtectionRule:put 更新误报屏蔽规则 waf:falseAlarmMaskRule:put 更新隐私屏蔽规则 waf:privacyRule:put 更新黑白名单规则 waf:whiteBlackIpRule:put 更新地址位置访问控制规则 waf:geoIpRule:put 更新防护域名 waf:instance:put 更新防护策略 waf:policy:put 删除防敏感信息泄漏规则 waf:antiLeakageRule:delete 删除网页防篡改规则 waf:antiTamperRule:delete 删除CC攻击防护规则 waf:ccRule:delete 删除精准访问防护规则 waf:preciseProtectionRule:delete 删除误报屏蔽规则 waf:falseAlarmMaskRule:delete 删除隐私屏蔽规则 waf:privacyRule:delete 删除黑白名单规则 waf:whiteBlackIpRule:delete 删除地址位置访问控制规则 waf:geoIpRule:delete 删除防护域名 waf:instance:delete 删除防护策略 waf:policy:delete 创建防敏感信息泄漏规则 waf:antiLeakageRule:create 创建网页防篡改规则 waf:antiTamperRule:create 创建CC攻击防护规则 waf:ccRule:create 创建精准访问防护规则 waf:preciseProtectionRule:create 创建误报屏蔽规则 waf:falseAlarmMaskRule:create 创建隐私屏蔽规则 waf:privacyRule:create 创建黑白名单规则 waf:whiteBlackIpRule:create 创建地址位置访问控制规则 waf:geoIpRule:create 创建证书 waf:certificate:create 创建防护域名 waf:instance:create 创建防护策略 waf:policy:create 查询防敏感信息泄漏规则列表 waf:antiLeakageRule:list 查询网页防篡改规则列表 waf:antiTamperRule:list 查询CC攻击防护规则列表 waf:ccRuleRule:list 查询精准访问防护规则列表 waf:preciseProtectionRule:list 查询误报屏蔽规则列表 waf:falseAlarmMaskRule:list 查询隐私屏蔽规则列表 waf:privacyRule:list 查询黑白名单规则列表 waf:whiteBlackIpRule:list 查询地址位置访问控制规则列表 waf:geoIpRule:list 查询防护域名列表 waf:instance:list 查询防护策略列表 waf:policy:list 查询独享引擎实例列表 waf:premiumInstance:list 查询独享引擎 waf:premiumInstance:get 创建独享引擎实例 waf:premiumInstance:create 删除独享引擎实例 waf:premiumInstance:delete 更新独享引擎 waf:premiumInstance:put

本文介绍如何设置监控告警规则。 通过设置WAF告警规则，用户可自定义监控目标与通知策略，设置告警规则名称、监控对象、监控指标、告警阈值、监控周期和是否发送通知等参数，帮助您及时了解WAF防护状况，从而起到预警作用。 前提条件 防护网站已接入WAF。 操作步骤 1. 登录管理控制台。 2. 单击管理控制台顶部的区域选择框，选择区域。 3. 单击页面左上方的“服务列表”，选择“管理与部署> 云监控服务”。 4. 在左侧导航栏，选择“告警> 告警规则”，进入“告警规则”页面。 5. 在页面右上方，单击“创建告警规则”，进入“创建告警规则”界面。 6. 设置告警规则名称。 7. 在“资源类型”下拉列表框中选择“Web应用防火墙”，选择“维度”、“监控范围”，设置告警模板、是否发送通知。 8. 单击“立即创建”，在弹出的提示框中，单击“确定”，告警规则创建成功。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Boolean true:已加密 false:未加密

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id nodeId query Long 是 只读实例节点id

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 自定义查询开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 是 自定义查询结束时间,格式：yyyyMMdd HH:mm:ss,查询时间间隔不超过30天

名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 开始时间，格式：yyyyMMdd HH:mm:ss endTime query String 是 结束时间，格式：yyyyMMdd HH:mm:ss pageNum query Integer 是 当前页 pageSize query Integer 是 页大小，范围1500

名称 位置 类型 必选 说明 enableEventLog query Boolean 是 开启或关闭历史事件功能

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 list Array eventId String id prodInstId String 实例ID eventType String 事件类型 eventName String 事件名称 eventTime String 事件发生时间 eventUserType String 事件发起人 eventReason String 事件产生原因 userId Integer 用户ID eventPayload String 请求参数

名称 二级节点 三级节点 四级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List 时间范围类各个时间点性能指标 cpuUser Byte 监控数据采集时间间隔内，cpu处于用户态的时间比例,单位% cpuSys Byte 监控数据采集时间间隔内，cpu处于内核态的时间比例，单位% rRateKbs BigDecimal io读速率，单位kb/s wRateKbs BigDecimal io写速率，单位kb/s ioUtil BigDecimal io利用率,单位% qps Integer 节点qps tps Integer 节点tps collectTime String 数据采集时间

名称 位置 类型 必选 说明 srcProdInstId body Long 是 源pg实例id backupId body Long 否 备份id,和restoreTime只能有一个为空 destProdInstId body Long 是 目标实例id restoreTime body String 否 备份保留周期内的任意时间点。格式：yyyyMMdd HH:mm:ss

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 backupName 是 String 备份名称 1. 长度为1100个字符 2. 由数字、中文、英文、下划线（）、短横线（）组成 test