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

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "message": "成功！", "returnObj": { "inFlowMax": 0, "outFlowMax": 0, "percentage": 0.0, "flowProcessingCapacity": 10, "natProtectCount": 0, "natUnProtectCount": 2, "elbProtectCount": 0, "elbUnProtectCount": 0, "ipUsedQuotaCount": 0, "ipUnUsedQuotaCount": 20, "ipProtectCount": 0, "ipUnProtectCount": 1, "ipQuotaCount": 20 } } 状态码 请参考 状态码 错误码 请参考 错误码

参数 是否必填 参数类型 说明 示例 下级对象 reportType 是 Array of Strings 报表类型 ["DAY"] subscribeUserIds 是 Array of Strings 选中的用户ids ["100054c0416811e9a6690242ac110002"]

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

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

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

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

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

参数 是否必填 参数类型 说明 示例 下级对象 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

参数 参数类型 说明 示例 下级对象 id Long 任务id taskName String 投递任务名称 deliverType String 投递方式 ZOS saveTypes Array of Strings 存储类型：AC:访问控制;IPS:入侵防御;FLOW:流量;OPERATION:操作;AV:病毒检测 taskStatus Integer 任务状态 1正常 2失败 3停止 lastTime String 上一次完成时间（UTC格式） deliverStatus Integer 投递状态 0不投递 1投递 saveTime Integer 保存时间 endPoint String 终端节点 bucketName String 桶名称 dir String 目录 ak String 鉴权ak sk String 鉴权sk dataType String 数据格式 csv、json zipType String 压缩格式 nozip、gzip

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

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

状态码 错误码 状态信息 描述 200 CFW0000 成功 成功 200 CFW0001 参数错误 参数错误 200 CFW0002 业务错误 业务错误

参数 参数类型 说明 示例 下级对象 protectionIpNumMax Integer 可防护ip最大数 1 flowProcessingCapacityMax Integer 最大公网流量处理能力 1 vpcQuotaMax Integer VPC边界防火墙最大数量 1 vpcFlowProcessingCapacityMax Integer 最大VPC流量处理能力 1

云墙VPN功能是否可以免费使用？ 云墙VPN功能支持免费使用。这是云墙的基础功能模块之一，为用户提供安全、可靠的虚拟专用网络连接。以下是相关功能详细信息： 基础功能模块：云墙VPN功能是N100的基础功能之一，旨在为用户提供安全的远程访问和站点到站点的连接服务。 IPSEC VPN链路：根据不同的版本，IPSEC VPN支持的链路条数可能有所不同。用户可以根据业务需求选择适当的版本。 SSL VPN账号限制：默认情况下，SSL VPN支持最多5个账号同时在线。如果您的业务需要更多同时在线账号，您可以联系天翼云客服进行进一步的咨询和配置。 扩展服务：如果您的业务需求超出了免费版本所提供的功能，我们提供了更高级的版本和扩展服务，以满足不同用户的需求。您可以与天翼云客服联系，了解更多关于高级版本和扩展服务的信息。

参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94

参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94

响应示例 {"statusCode": "200","error": "CFW0000","message": "成功!"} 状态码 请参考 状态码 错误码 请参考 错误码

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

参数 是否必填 参数类型 说明 示例 下级对象 description 是 String 地址簿描述 描述 content 是 String ip/端口 v4

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

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "200", "error": "CFW0000", "message": "成功!", "returnObj": [ { "content": "1.1.1.0" }, { "content": "1.1.1.1" }, { "content": "1.1.1.2", "description": "1223" }, { "content": "1.1.1.3" } ] } 状态码 请参考 状态码 错误码 请参考 错误码

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

参数 参数类型 说明 示例 下级对象 action String 动作 cnnvd String 安全漏洞库 cve String cve descCn String 描述中文 descEn String 描述 level String 等级 method Array of Strings 获取method类别的规则 methodCn Array of Strings 获取method类别的规则中文 methodCnFirst Array of Strings 获取一级method类别的规则中文 methodCnSecond Array of Strings 获取二级method类别的规则中文 methodFirst Array of Strings 获取一级method类别的规则 methodSecond Array of Strings 获取二级method类别的规则 name String 规则名称 nameCn String 规则名称中文 ruleId Long 规则id ruleid和type二选一: 指定ruleid时，获取指定id规则信息; 指定type时，指定该分类的所有规则 target Array of Strings 获取target类别的规则 targetCn Array of Strings 获取target类别的规则中文 targetCnFirst Array of Strings 获取一级target类别的规则中文 targetCnSecond Array of Strings 获取二级target类别的规则中文 targetFirst Array of Strings 获取一级target类别的规则 targetSecond Array of Strings 获取二级target类别的规则 type String 规则类别 ruleid和type二选一 base: 普通规则 vpatch: 虚拟补丁规则

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

响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 total Integer 总记录数 1 list Array of Objects 结果集 AlarmView pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 10 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 1 endRow Long 当前页面最后一个元素在数据库中的行号 1 pages Integer 总页数 1 prePage Integer 前一页 0 nextPage Integer 下一页 0 isFirstPage Boolean 是否为首页 true isLastPage Boolean 是否为末页 true hasPreviousPage Boolean 是否有前一页 false hasNextPage Boolean 是否有下一页 false navigatePages Integer 导航页码数 8 navigatepageNums Array of Integers 所有导航页号 [1] navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage String 导航条上的最后一页 1 表 AlarmView 参数 参数类型 说明 示例 下级对象 createTime String 创建时间 20241024T01:44:12Z updateTime String 修改时间 20241024T01:44:12Z alarmName String 告警名称 100.126.9.172192.168.10.5POP3WeakPasswordLoginAttempt(TCP)告警 attackType String 攻击类型 InformationDisclosureWeakPassword attackIp String 攻击ip 100.126.9.172 affectedIp String 受影响ip 192.168.10.5 attackLevel String 攻击等级 "MIDDLE" triggerCount Integer 触发次数 1 ruleId Long 命中规则id 43049 ruleName String 命中规则名称 POP3WeakPasswordLoginAttempt(TCP) sourceType String 判断来源 BASE attackDirection String 方向 1 isHandled Boolean 标记处理 false alarmId String 告警id 119320

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

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

参数 参数类型 说明 示例 下级对象 ruleName String 规则名称 test firewallId String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 ipProto String IP协议，可能值 v4,v6。 v4 direction String 方向，可能值 in,out。 in action String 动作，可能值 drop,pass。 pass dstIp String 目的IP V4必输 1.1.1.0 dstIpMask Integer 目的IP子网掩码 V4必输 24 dstIp6 String 目的IP6 V6必输 1:: dstIp6Mask Integer 目的IP6子网掩码 V6必输 96 srcIp String 源IP V4必输 2.2.2.0 srcIpMask Integer 源IP子网掩码 V4必输 24 srcIp6 String 源IP6 V6必输 2:: srcIp6Mask Integer 源IP6子网掩码 V6必输 96 service String 服务类型，可能值 any,icmp,tcp,udp。 tcp dstPort String 目的端口 8080 srcPort String 源端口 8182 icmpType String icmpType icmpCode String icmpCode app String 应用ID 多个ID用逗号隔开 20,30 status String 规则开关，可能值 disable,enable。 disable statistics String 统计开关，可能值 disable,enable。 disable policy Integer 优先级 1 policyDesc String 防护规则描述 防护规则描述 quota Integer 占用规格数量 1 pos String 移动策略ID到最前或最后，可能值 head,remove,tail。 head privateV4Ips Array of Strings V4私网ips privateV6Ips Array of Strings V6私网ips ipv4DstBeginNum Long 目的ipv4的开始数字形式 ipv4DstEndNum Long 目的ipv4的结束数字形式 ipv4SrcBeginNum Long 源ipv4的开始数字形式 ipv4SrcEndNum Long 源ipv4的结束数字形式 ipv6DstBeginNum Long 目的ipv6的开始数字形式 ipv6DstEndNum Long 目的ipv6的结束数字形式 ipv6SrcBeginNum Long 源ipv6的开始数字形式 ipv6SrcEndNum Long 源ipv6的结束数字形式 srcIpGroupId Integer 源地址组id dstIpGroupId Integer 目的地址组id srcPortGroupId Integer 源端口组id dstPortGroupId Integer 目的端口组id srcIpGroupName String 源地址组名称 dstIpGroupName String 目的地址组名称 srcPortGroupName String 源端口组名称 dstPortGroupName String 目的端口组名称

接口功能介绍 查询黑白名单接口 接口约束 传参规范 URI GET /vfw/v2blackwhitepolicyquery 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 addressDirection 否 String 地址方向 dst blackWhiteType 是 String 黑白类型 BLACK firewallId 是 String 防火墙id dca4f9ffaca2447aa24310c1e62c4690 ip 否 String ip地址 127.0.0.1/20 ipProto 否 String ip协议 v4 page 否 Integer 页码 1 ruleId 否 Long 规则id 1099 ruleIds 否 String 规则ids [1099] ruleName 否 String 规则名称 1099 size 否 Integer 条数 10 addressGroup 否 String 地址簿名称 dst 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 total Integer 总记录数 1 list Array of Objects 结果集 BlackWhitePolicyEntity pageNum Integer 当前页的页码 1 pageSize Integer 每页的数量 10 size Integer 当前页的数量 1 startRow Long 当前页面第一个元素在数据库中的行号 1 endRow Long 当前页面最后一个元素在数据库中的行号 1 pages Integer 总页数 1 prePage Integer 前一页 0 nextPage Integer 下一页 0 isFirstPage Boolean 是否为首页 true isLastPage Boolean 是否为末页 true hasPreviousPage Boolean 是否有前一页 false hasNextPage Boolean 是否有下一页 false navigatePages Integer 导航页码数 8 navigatepageNums Array of Integers 所有导航页号 [1] navigateFirstPage Integer 导航条上的第一页 1 navigateLastPage String 导航条上的最后一页 1 表 BlackWhitePolicyEntity 参数 参数类型 说明 示例 下级对象 ruleId Long 规则id 1099 ruleName String 规则名称 1099 ipProto String ip协议 v4 blackWhiteType String 黑白类型 BLACK addressDirection String 地址方向 dst ip String ip地址 127.0.0.1/20 mask Integer 掩码 32 blackWhiteDesc String 黑白名单描述 status Integer 规则开关 10 ipBeginNum String ip的开始数字形式 127.0.0.1/20 ipEndNum String ip的结束数字形式 127.0.0.1/20 privateIps String 私网ips 192.168.1.1/24 ipGroupId Integer ip地址组 11 ipGroupName String ip地址组 562b89493b1a40e1b97ea05e50dd8170

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

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "message": "成功！", "returnObj": { "usedSize": 0.0, "totalSize": 50.0, "percentage": 0.0, "saveTypes": [ "OPERATION", "AC", "FLOW", "IPS", "AV" ], "saveTime": 7, "canCreateTask": true }, "statusCode": "800" } 状态码 请参考 状态码 错误码 请参考 错误码