名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存

名称 二级节点 三级节点 位置 类型 必选 说明 labelInfos body Array 是 标签信息列表，最大长度为50 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labels body Array 否 标签列表,一次最多20个 labelName body String 是 标签名称，若传递，则不能为空字符串或者null labelValue body String 否 标签值

接口功能介绍 下载实例参数配置。 接口约束 URI GET /v1/params/downloadparam 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 setName 是 String 实例参数配置名称 实例10的参数配置 响应参数 请求成功时，返回的是一个文件流，在浏览器可以直接下载 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 810 message String 消息提示 请求失败 : 实例参数配置名称不能为空 returnObj Object 返回对象 请求示例 /v1/params/downloadparam?prodInstId10&setName实例10的参数配置 请求头header 请求体body 响应示例 json { "message": "请求失败 : 实例参数配置名称不能为空", "returnObj": {}, "statusCode": 810 } 错误码 访问ErrorCodes说明文档查看更多错误码。

步骤二：下载检测报告 步骤 1 在左侧导航栏选择“高阶功能> 内容安全检测”，进入“内容安全检测”页面。 步骤 2 在目标检测对象所在行的“操作”列，单击“下载报告”，可将检测报告下载到本地。 报告中呈现检测出的合规性风险、内容安全风险等相关内容。用户根据报告内容选择整改或者保留。 “检测状态”为“检测完成”时，才支持下载报告。检测状态为“检测中”，不支持下载报告，图中的检测状态为“检测中”，不支持下载报告，下载报告按钮不可点击。 其他操作 如果您需要对检测对象进行再次检测时，在该检测对象所在行的“操作”列，单击“复购”。

本节介绍WAF对SQL注入、XSS等漏洞的检测原理。 WAF对SQL注入的检测原理？ SQL（Structured Query Language）注入攻击是一种常见的Web攻击方法，攻击者通过把SQL命令注入到数据库的查询字符串中，最终达到欺骗服务器执行恶意SQL命令的目的。例如，可以从数据库获取敏感信息，或者利用数据库的特性执行添加用户、导出文件等一系列恶意操作，甚至有可能获取数据库乃至系统用户最高权限。 WAF针对SQL注入攻击的检测原理是检测SQL关键字、特殊符号、运算符、操作符、注释符的相关组合特征，并进行匹配。 SQL关键字（如 union，Select，from，as，asc，desc，order by，sort，and ，or，load，delete，update，execute，count，top，between，declare，distinct，distinctrow，sleep，waitfor，delay，having，sysdate，when，dbauser，case，delay 等） 特殊符号（’”,; ()） 运算符（±/%） 操作符（，>, , 、’、”） 外部链接（href“http：//xxx/”，src"http：//xxx/attack.js"） 说明 如果业务需要上传富文本，可以用multipart方式上传，不用body方式上传，放在表单里，即使base64编码也会解码。分析业务场景，建议限制引号、尖括号输入。

接口描述 查询指定的Postgresql参数模板信息。 请求方法 GET URI /v1/template/list 请求参数 名称 位置 类型 必选 说明 templateId query Long 是 参数模板ID name query String 否 参数名称 prodInstId query Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array paramName String 参数名 paramValue String 参数值 permitValue String 允许的值 desc String 简单描述 description String 描述 valueType String 参数类型 restart String 是否需要重启生效,0:否，1是 示例 请求示例 /v1/template/list?templateId1&prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "description": "设置用于对WAL文件进行归档的shell命令。", "paramName": "archivecommand", "paramValue": "''", "permitValue": "", "restart": "0", "valueType": "string" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

本章节主要介绍WAF权限及授权项。 如果您需要对您所拥有的WAF进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，IAM），如果登录账号已经能满足您的要求，不需要创建独立的IAM用户，您可以跳过本章节，不影响您使用WAF服务的其它功能。 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使用户组中的用户获得相应的权限，这一过程称为授权。授权后，用户就可以基于已有权限对云服务进行操作。 权限根据授权的精细程度，分为角色和策略。角色以服务为粒度，是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略授权更加精细，可以精确到某个操作、资源和条件，能够满足企业对权限最小化的安全管控要求。 支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。 权限：允许或拒绝某项操作。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 权限 授权项 :: 查询防敏感信息泄漏规则 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

接口描述 查询Postgresql实例数据加密状态。 请求方法 GET URI /v1/product/encryption 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Boolean true:已加密 false:未加密 示例 请求示例 /v1/product/getProductEncryption?prodInstId53 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": false, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 delayTime String 复制延迟时间

接口描述 查询Postgresql实例在指定时间范围内的增强指标监控信息 请求方法 GET URI /v1/monitor/queryenhancedmetrics 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id startTime query String 是 自定义查询开始时间,格式：yyyyMMdd HH:mm:ss endTime query String 是 自定义查询结束时间,格式：yyyyMMdd HH:mm:ss,查询时间间隔不超过30天 响应参数 名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object instId Long 实例id nodes List 实例各个节点性能信息 ip String 节点ip master boolean 是否主节点 metrics List > 时间范围内各个时间点已开启的增强性能指标 示例 请求示例 /v1/monitor/queryInstEnhancedMetrics?prodInstId14&startTime20220820 19:18:41&endTime20220820 19:19:42 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 53, "nodes": [ { "ip": "192.168.190.11", "master": true, "metrics": [ { "collectTime": "20220908 17:45:01", "con": 0, "delay": 0, "walsize": 0.00 }, { "collectTime": "20220908 17:46:01", "con": 6, "delay": 0, "walsize": 11.00 }, { "collectTime": "20220908 17:47:01", "con": 5, "delay": 0, "walsize": 11.00 } ] }, { "ip": "192.168.190.12", "master": false, "metrics": [] } ] }, "statusCode": 800 }

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

示例 请求示例 /v1/monitor/pageSwitchRecord?prodInstId1&satrtTime2022722 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "list": [ { "createTime": 1661694462000, "curSetRun": "192.168.1.116543192.168.1.126543", "oldSetRun": "192.168.1.126543192.168.1.116543", "prodInstId": 53, "prodInstName": "set11126563", "result": true, "switchTime": 1661711492000, "switchType": "auto" } ], "pageNum": 1, "pageSize": 10, "pageTotal": 1, "total": 2 }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 enableEventLog Boolean 历史事件开启情况 true：开启 false：关闭

名称 位置 类型 必选 说明 pageNum query Integer 是 页码 pageSize query Integer 是 页大小，范围1500 startTime query Long 否 自定义查询开始时间,格式:时间戳 endTime query Long 否 自定义查询结束时间,格式:时间戳

示例 请求示例 /v1/monitor/getPerformance?prodInstId14&startTime'20220819 00:00:00'&endTime'20220820 23:59:00' 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": { "instId": 14, "nodes": [ { "ip": "192.168.190.11", "master": false, "metrics": [ { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 }, { "collectTime": "20220820 15:54:48", "cpuSys": 3, "cpuUser": 1, "ioUtil": 0.1, "qps": 0, "rRateKbs": 6.2, "tps": 0, "wRateKbs": 74.5 } ] }, { "ip": "192.168.190.12", "master": true, "metrics": [] } ] }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果

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

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 34 startTime 是 String 查询开始时间，格式yyyyMMdd HH:mm:ss， 不能晚于当前时间 20221017 12:00:00 endTime 是 String 查询结束时间，格式yyyyMMdd HH:mm:ss， 与开始时间不能间隔30天，且不能早于开始时间 20221018 12:00:00

WAF如何解析/访问IPv6源站？ 当防护网站的源站地址配置为IPv6地址时，WAF直接通过IPv6地址访问源站。WAF默认在CNAME中增加IPv6地址解析，IPv6的所有访问请求将先流转到WAF，WAF检测并过滤恶意攻击流量后，将正常流量返回给源站，从而确保源站安全、稳定、可用。 WAF支持IPv6/IPv4双栈模式和NAT64机制，详细说明如下： Web应用防火墙支持IPv6/IPv4双栈，针对同一域名可以同时提供IPv6和IPv4的流量防护。 针对仍然使用IPv4协议栈的Web业务，Web应用防火墙支持NAT64机制（NAT64是一种通过网络地址转换（NAT）形式促成IPv6与IPv4主机间通信的IPv6转换机制），即WAF可以将外部IPv6访问流量转化成对内的IPv4流量。

接口描述 解锁PostgreSQL实例的账号，PostgreSQL实例被锁定的账号无法使用，需要解锁后才能继续使用。 请求方法 POST URI /v1/instuser/unlock 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 返回结果 示例 请求示例 /v1/instuser/unlockUser { "prodInstId": "165776586159600008", "username": "pguser" } 响应示例 { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id username body String 是 用户账号 password body String 是 用户密码

本节介绍如何处理WAF误拦截了“非法请求”访问请求。 问题现象 防护网站接入WAF后，访问请求被WAF拦截，在“防护事件”页面查看防护日志，显示访问请求为“非法请求”且误报处理按钮置灰不能使用。 可能原因 当遇到以下情况时，WAF将判定该访问请求为非法请求并拦截该访问请求： POST/PUT使用“formdata”时，表单的参数个数多于8192个。 URI的参数个数多于2048个。 Header个数超过512个。 处理建议 当确认访问请求为正常请求时，请参见配置精准访问防护规则放行该访问请求。

本节介绍如何处理域名/IP接入状态显示“未接入”问题。 故障现象 添加防护域名或IP后，域名或IP接入WAF失败，即防护网站“域名接入进度”未显示“已接入”。 WAF每隔一小时就会自动检测防护网站的“接入状态”，当WAF统计防护网站在5分钟内达到20次访问请求时，将认定该防护网站已成功接入WAF。 排查思路和处理建议 防护网站的“部署模式”为“独享模式”时，请参考图进行排查处理。 独享模式接入WAF失败问题处理 可能原因 处理建议 原因一：域名 /IP “接入状态”未刷新 在防护网站“接入状态”栏，单击刷新按钮刷新状态。 原因二：访问流量未达到WAF统计要求 说明 防护网站接入WAF后，当WAF统计防护网站在5分钟内有20次请求时，将认定该防护网站已接入WAF。 1. 在1分钟内多次访问防护网站。 2. 在防护网站“接入状态”栏，单击刷新按钮刷新状态。 原因三：域名 /IP参数配置错误 检查域名/IP参数是否正确。 如果域名/IP配置错误，删除该域名/IP后重新添加防护网站。 原因四：没有为独享模式实例配置负载均衡，配置的负载均衡未绑定弹性公网IP 1. 为独享引擎实例配置负载均衡。 2. 为弹性负载均衡绑定弹性公网IP。 原因五：独享模式实例负载均衡配置错误或负载均衡绑定弹性公网IP错误 配置负载均衡后，当WAF独享引擎实例的“健康检查结果”为“正常”时，说明弹性负载均衡配置成功。 为弹性负载均衡绑定弹性公网IP后，可以查看绑定的弹性公网IP，说明绑定成功。

参数 参数类型 说明 示例 下级对象 fileName String 文件名称 postgresql20221101174412.csv logDownloadUrl String 下载地址 logSize String 日志文件大小，单位：byte 5438349 logTime Long 审计文件时间 1667297102000 sqlStartTime Long sql开始时间 1667296096000 sqlEndTime Long sql结束时间 1667297102000

参数 是否必填 参数类型 说明 示例 下级对象 projectid 是 String 项目id

购买内容安全检测服务时，如何确定网站检测配额？ WAF内容安全检测服务按新媒体账号或网站地址个数确定检测配额，1个新媒体账号或1个网站地址占1个检测配额。 基于网站内容来判定配置几个检测网站，同一个组织和同一类内容被认定成一个网站，具体可参见以下几个场景。 说明 WAF支持批量购买内容安全检测服务，可一次输入一个或多个检测对象（新媒体或网站）进行安全检测，最多支持一次输入100个检测对象。 “检测对象类型”为“网站”时，检测对象的每一行表示一个检测网址，多个网址以回车换行分割；同一行内的网址和备注之间以英文逗号分割，如无备注，可只输入网址，每行最多支持500个英文字符（1个中文字符等于2个英文字符）。 “检测对象类型”为“新媒体”时，检测对象的每一行表示一个新媒体账号，多个新媒体账号以回车换行分割；同一行内的新媒体账号和备注之间以英文逗号分割，每行最多支持500个英文字符（1个中文字符等于2个英文字符）。 场景一：同一官网域名对应的内容，占一个网站检测配额 举例：XX官网里有“产品中心”、“品牌活动”、“网络商城”等板块，但这些板块都同属于官网域名，算一个网站，占一个检测网站配额，即在购买内容安全检测服务时，“检测对象类型”选择“网站”，“检测对象”配置为XX官网的网址即可。 场景二：不同域名对应的网站，检测配额独立计算 举例 ：某官网（ 场景三：域名相同但网站名称不同，检测配额独立计算 举例 ：某省省法院官网（

参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 34 sqlCollectorStatus 是 String 开启或关闭SQL洞察（SQL审计），取值：enable disabled enable restartInstance 否 boolean 是否重启实例，默认false。若要生效，需要重启实例 true

名称 二级节点 三级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array pageNum Integer 页码 pageSize Integer 每页最大条数 total Integer 总记录数 pageTotal Integer 总页数 list Array id String 错误日志id resId String 数据库资源唯一标识 host String 数据库所在服务器ip port String 数据库所在服务器端口 level String 日志级别 message String 错误信息 createTime String 创建时间 lineNumber Integer 行数

名称 位置 类型 必选 说明 resId body Long 是 数据库资源唯一标识 limit body Integer 是 查询数量，限制500 flag body String 否 数据库类型，OpenGauss:OpenGauss,PostgreSQL:PostgreSQL, 若不传，则根据resId的数据库类型进行过滤 order body String 否 排序字段，不传默认avgCost，取值 calls total avgCost beginTime body String 否 自定义开始时间,格式：yyyyMMdd HH:mm:ss，开始时间默认为结束时间的一小时前。 endTime body String 否 自定义结束时间,格式：yyyyMMdd HH:mm:ss，结束时间默认为当前时间。

接口描述 修改Postgresql实例IP白名单。 请求方法 PUT URI /v1/whitelist/modify 请求参数 名称 位置 类型 必选 说明 prodInstId body Long 是 实例id mode body String 是 修改模式： cover：用ipList中的IP覆盖原白名单 delete：把ipList的IP从白名单中移除,如果有白名单中不存在的IP，会被跳过 append：把ipList中的IP加入白名单 ipList body List 是 IP列表 响应参数 名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存 示例 请求示例 /v1/whiteList/modifyIPWhiteList { "ipList": [ "127.0.0.1", "192.168.174.1" ], "mode": "delete", "prodInstId": 15 } 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id description body String 是 最大长度不超过1KB,最小长度为0；输入空字符串表示清空描述

名称 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Object 所有的返回信息都以JSON形式保存