参数 参数类型 说明 示例 下级对象 ecName String 云间高速实例名称 ecId String 云间高速实例ID cgwId String 云网关ID cgwName String 云网关名称 vpcId String vpc id vpcName String vpc名称 vpcCidr String vpc的网段 regionName String 资源池名称 protectStatus Boolean 防护状态false;true

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": { "vpcFlowMax": 31751795, "percentage": 1.16, "vpcFlowProcessingCapacity": 2600, "vpcPeerProtectCount": 2, "vpcPeerUnProtectCount": 0, "cdaProtectCount": 0, "cdaUnProtectCount": 0, "ecProtectCount": 1, "ecUnProtectCount": 2, "vpcUsedQuotaCount": 3, "vpcUnUsedQuotaCount": 7, "vpcQuotaCount": 10 } } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 查询防火墙详情 接口约束 传参规范 URI GET /vfw/v2firewallquery 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 firewallName 否 String 防火墙名称 firewallType 否 String 防火墙类型 NorthSouth 南北向 EastWest东西向 firewallState 否 String 防火墙状态 normal正常 overdue已到期 unsubscribe已退订 processing开通中 firewallStateExclude 否 String 过滤防火墙状态 normal正常 overdue已到期 unsubscribe已退订 processing开通中 masterOrderId 否 String 主订单ID masterResourceIds 否 Array of Strings 主资源IDs masterResourceId 否 String 主资源ID page 否 Integer 页码 1 size 否 Integer 条数 10 isDelete 否 Boolean 是否删除 false state 否 Boolean 是否退订 true 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果

实践 描述 介绍如何选择最适宜用户使用场景和带宽的防火墙规格，以及介绍如何启用防护配置策略，配置防护规则，适用于初次使用防火墙，不知道如何选择适宜自己场景的防火墙规格以及不知道如何启用防火墙产品的用户及场景。 介绍如何进行访问控制策略配置，在日常生产场景中，常用哪些访问控制策略应该需要配置，适用于安全应用了解较少，需要进行标准化策略防护的用户及场景。

接口功能介绍 给防火墙定义一个随机名称 接口约束 传参规范 URI GET /vfw/v2firewallrandomfirewallname 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj String 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj":"CFW8540" } 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 {"statusCode": "200","error": "CFW0000","message": "成功!","returnObj": {"endRow": 0,"hasNextPage": false,"hasPreviousPage": false,"isFirstPage": false,"isLastPage": false,"list": [{"attachedId": "aab10b211ec040108b16d76993b49d9b","attachedName": "asconfigb17cqes8","attachedPrivateIp": "172.31.0.150","attachedType": "VM","bindStatus": "bind","eip": "182.43.62.56","eipId": "eipp0weypef75","eipName": "eip1cc7","eipNum": "","firewallEdition": "","firewallId": "","ipType": "ipv4","protectStatus": false,"regionId": "a6449feab4db11e9a6b40242ac110007","subnetCidr": "","subnetId": "","subnetName": "","tip": "","uid": "6ee4c9fa71c3403eab8af44e29c3e4c1","userId": "6ee4c9fa71c3403eab8af44e29c3e4c1","vpcId": "vpccc91","vpcIp": "192.168.0.0/16","vpcName": "vpccc91"}],"navigateFirstPage": 0,"navigateLastPage": 0,"navigatePages": 0,"navigatepageNums": [],"nextPage": 0,"pageNum": 0,"pageSize": 0,"pages": 0,"prePage": 0,"size": 0,"startRow": 0,"total": 0},} 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null

参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002

状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 method String 获取method类别的规则 methodCn String 获取method类别的规则中文

参数 参数类型 说明 示例 下级对象 ddosProtect String DDos防护开关 firewallId String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 regionId String 资源池ID fecnjniakfkn2314ndekqldedcsadfg runmode String 运行模式 avProtect String AV防护开关 vpatch String 虚拟补丁开关 version Integer 版本号 1

参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002

名称 位置 类型 必选 说明 name query String 否 参数名称 pageNum query Integer 是 当前页,默认1 pageSize query Integer 是 页大小，默认10，最大限制500

名称 位置 类型 必选 说明 prodInstId body Long 是 实例id labelType body Integer 是 资源标签分类标识，1主机，2实例,这里固定传2 labelIds body List 否 标签id列表,一次最多只能设置20个，unTagAllfalse时，该值必填 unTagAll body boolean 否 是否全部解绑，不传入labelIds才有效

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

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

接口描述 查询Postgresql实例本地日志列表 请求方法 GET URI /v1/monitor/instlog 请求参数 名称 位置 类型 必选 说明 prodInstId query Long 是 实例id 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 logTime Long 日志时间 logFileName String 文件名称 prodInstId Long 实例id 示例 请求示例 /v1/monitor/listInstanceLog?prodInstId60 响应示例 { "message": "SUCCESS", "opMessage": "", "returnObj": [ { "logFileName": "postgresql20220909103102.log", "logTime": 1662738918000, "prodInstId": 60 } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

本节介绍WAF的使用说明等问题。 接入WAF后为什么漏洞扫描工具扫描出未开通的非标准端口？ 问题现象：域名接入WAF通过第三方漏洞扫描工具扫描后，扫描结果显示了域名的标准端口（例如443）和非标准端口（例如8000、8443等）。 可能原因：由于WAF的非标准端口引擎是所有用户间共享的，即通过第三方漏洞扫描工具可以检测到所有已在WAF中使用的非标准端口。域名的端口检测，应以源站IP开通的端口为准，即引擎的端口检测并不影响源站的使用安全，且WAF保证客户解析CNAME返回的引擎IP的安全性。 处理建议：无需处理。 使用Web应用防火墙对邮件收发和邮件端口有影响吗？ WAF是对Web应用网页进行防护，当您的网站接入WAF后，对邮件收发和邮件端口不会产生影响。 Web应用防火墙如何拦截请求内容？ WAF对请求的首部和body体都会进行检测。例如body的表单、xml、json等数据都会被WAF检测，WAF通过检测对不符合防护规则的请求内容进行拦截。 什么是并发数？ 并发数指系统能够同时处理请求的数目。对于网站而言，并发数即网站并发用户数，指同时提交请求的用户数目。 如果证书挂载在ELB上，WAF可以根据请求内容进行拦截吗？ 如果证书挂载在ELB上，通过WAF的请求都是加密的。对于HTTPS的业务，您必须将证书上传到WAF上，WAF才能根据解密之后的请求判断是否进行拦截。

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

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

接口描述 修改SQL洞察日志保存时长。 接口约束 实例需要已开启SQL洞察 URI PUT /v1/collector/sqlcollectorretention 请求参数 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 retainValue 是 Integer SQL洞察日志保存时长，单位：天，取值：30，180，365，1095，1825 30 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 请求示例 /v1/collector/sqlcollectorretention 请求体body { "prodInstId": 10, "retainValue": 30 } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array resId Integer 数据库资源唯一标识 databaseName String 数据库名称 querySql String 查询的语句 userName String 用户名 clientAddress String 客户端ip clientPort Integer 客户端端口 queryStart String 查询开始时间 queryEnd String 查询结束时间 queryPlan String 查询计划 queryCost Integer 耗时，单位:ms

接口描述 查询PostgreSQL实例支持的字符集 请求方法 GET URI /v1/database/charactersetname 请求参数 名称 位置 类型 必选 说明 engine query String 是 数据库引擎类型。取值： postgreSQL：PostgreSQL 响应参数 名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 characterSetNameItems List 支持的字符集列表,例如： ["gbk","utf8","ascii"] engine String 数据库引擎类型。取值： postgreSQL：PostgreSQL 示例 请求示例 /v1/database/getCharacterSetName?enginepostgreSQL 响应示例 { "message": "SUCCESS", "returnObj": { "characterSetNameItems": [ "utf8", "gbk", "ascii" ], "engine": "postgreSQL" }, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

接口描述 查询RDS实例的SQL洞察（SQL审计）日志 接口约束 URI GET /v1/collector/sqllogrecords 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 pageNum 是 Integer 页码最小值为1 1 pageSize 是 Integer 页大小取值范围为：1500 10 dbName 否 String 数据库名称。默认为所有数据库，也可以输入数据库名称查询，一次只能输入一个 test accountName 否 String 用户名称。默认为所有用户，也可以输入用户名称查询，一次只能输入一个 root startTime 是 String 查询开始时间,格式：yyyyMMdd HH:mm:ss endTime 是 String 查询结束时间,大于查询开始时间，与查询开始时间间隔小于等于30天,格式：yyyyMMdd HH:mm:ss queryKeywords 否 List 用于查询的关键字,​ 1.多个关键字以空格分隔，不超过10个关键字​ 2.如果SQL语句中的字段名使用了反引号（），以该字段名作为查询的关键字时，也需要输入反引号。例如，字段名为id，则输入id，而不是id SELECT 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj PageVO 返回对象 PageVO 参数 参数类型 说明 示例 下级对象 pageNum Integer 页码 1 pageSize Integer 页大小 10 pageTotal Integer 总页数 1 total Integer 总记录数 2 list List 记录 DescribeSQLLogRecordsVO DescribeSQLLogRecordsVO 参数 参数类型 说明 示例 下级对象 hostAddress String 连接数据库的客户端IP地址 192.168.0.18:50744 sqlText String SQL语句 terminating connection due to administrator command dbName String 数据库名称 postgres executeTime Long 执行时间 1667354445000 threadId String 线程id 6952 accountName String 执行操作的账号名称 test

名称 二级节点 类型 说明 message String 消息提示 statusCode Integer 状态码 returnObj Array 所有的返回信息都以JSON形式保存 prodInstId Long 实例id dbName String 数据库名称 dbEncoding String 字符集 dbCollate String 字符串排序规则 dbCtype String 字符分类 dbOwner String 数据库所有者 createTimestamp Long 创建时间 updateTimestamp Long 更新时间 dbDescription String 数据库描述

接口功能介绍 修改实例的root账户密码 接口约束 实例必须处于运行中的状态 URI PUT /v1/remote/rootpassword 请求参数 body参数 参数 是否必填 参数类型 说明 示例 prodInstId 是 Integer 实例id 54 newPassword 是 String 新密码。816位，且必须含有数字，小写字母，大写字母，特殊字符 Arcyd12EQR 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 [] 请求示例 /v1/remote/rootpassword 请求参数 json { "prodInstId":54, "newPassword":"Arcyd12EQR" } 响应示例 json { "message": "SUCCESS", "returnObj": {}, "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Object 返回对象 示例 请求示例 {URI}?/v1/instuser/hbaconfig { "prodInstId":34, "opType":"modify", "line":10, "items":{ "type":"host", "username":"test,usertest", "database":"test,test2" } } 响应示例 { "returnObj": {}, "message":"SUCCESS", "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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

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

接口描述 查询SQL洞察（SQL审计）状态。 实例必须为运行状态. 请求方法 GET URI /v1/collector/sqlcollectorpolicy 请求参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 Long 实例id 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 List DescribeSQLCollectorPolicyVO 参数 参数类型 说明 示例 下级对象 host String 数据库ip 192.168.1.11 port Integer 数据库端口 5432 sqlCollectorStatus String SQL审计状态，取值：enable disabled disabled 示例 请求示例 /v1/collector/sqlcollectorpolicy?prodInstId10 响应示例 { "message": "SUCCESS", "returnObj": [ { "host": "192.168.1.11", "port": 5200, "sqlCollectorStatus": "disabled" }, { "host": "192.168.1.12", "port": 5200, "sqlCollectorStatus": "disabled" } ], "statusCode": 800 } 错误码 访问ErrorCodes说明文档查看更多错误码。

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