参数 描述 URIscheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。例如云主机产品服务在某个区域的Endpoint为“ctecsxxx.ctapi.ctyun.cn” resourcepath 资源路径，即API访问路径。从具体API的URI模块获取，例如"根据regionID查询用户资源"API的resourcepath为“/v4/region/customerResources” querystring 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名参数取值”，例如“?limit10”，表示查询不超过10条数据

为了确保网站访问者的个人数据（例如用户名、密码、手机号码等）不被未经过认证、授权的实体或者个人获取，WAF通过加密存储个人数据、控制个人数据访问权限以及记录操作日志等方法防止个人数据泄露，保证您的个人数据安全。 收集范围 对于触发攻击告警的请求，WAF在事件日志中会记录相关请求记录，收集及产生的个人数据如表所示。 类型 收集方式 是否可以修改 是否必须 请求源IP 攻击防护域名时，被WAF拦截或者记录的攻击者IP。 否 是 URL 攻击的防护域名的URL，被WAF拦截或者记录的防护域名的URL。 否 是 HTTP/HTTPS Header信息（包括Cookie） 用户在配置CC攻击、精准访问防护规则时，在配置界面输入的Cookie值和Header值。 否 否，如果配置的Cookie和Header信息不含有用户的个人信息，则WAF记录的相关请求中不会收集及产生用户的个人数据。 请求参数（Get、Post） 防护日志里，WAF记录的请求详情。 否 否，如果请求参数里不含有用户的个人信息，则WAF记录的相关请求中不会收集及产生用户的个人数据。 存储方式 对敏感字段提供了脱敏配置，其他字段在日志中明文保存。 访问权限控制 用户只能查看自己业务的相关日志。

参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI loggroup 是 String 日志组id logunit 是 String 日志单元id

错误码 请参考 错误码

本文提供SNAT防护的配置示例。 更多参数配置请参见“通过添加防护规则拦截/放行流量”。 SNAT防护配置 假如您的私网IP为“10.1.1.2”，通过NAT网关访问的外部域名为“www.ctyun.cn”，您可以参照以下参数配置NAT防护，其余参数可根据您的部署进行填写： 规则类型：NAT防护 方向：选择“SNAT” 源：选择“IP地址”，填写“10.1.1.2” 目的：选择“域名/域名组”、“网络型”，填写“www.ctyun.cn” 服务：选择“服务”、“TCP、165535、165535”

产品优势：极简部署、智能防护、可视可溯、丰富生态 极简部署 作为一款云SaaS服务，可以对公网资产、内部资产自动安全盘点，一键开启防护，支持原有安全策略一键导入，可随业务按需动态扩容。 智能防护 AI算法实时检测和拦截恶意流量；并通过自带的入侵防御引擎（IPS），对恶意流量进行实时检测和精准防御。 可视可溯 全场景流量日志、访问日志、入侵攻击日志记录，并通过报表分析呈现，支持审计及高级威胁溯源分析。 丰富生态 支持无缝集成第三方厂家威胁检测分析引擎，云上云下统一生态，客户原线下安全策略资产无缝平移。

用户组配置权限策略后，将用户加入用户组中，可以使该用户获得权限策略中定义的操作权限。 系统默认提供两种权限策略 系统策略和自定义策略。系统策略是IAM预置的策略，用户只能使用不能修改。若系统策略不满足授权要求，用户可以创建自定义策略，自由搭配需要授予的权限集。 用户组配置权限策略后，将用户加入用户组中，可以使该用户获得权限策略中定义的操作权限。

本文提供拦截某一地区的访问流量的配置示例。 更多参数配置请参见“通过添加防护规则拦截/放行流量”。 拦截某一地区的访问流量 假如您需要拦截所有来源“北京”地区的访问流量，可以参照以下参数设置防护规则。 方向：外内 源：选择“地域”、“北京” 目的：Any 服务：Any 动作：阻断

本文提供放行入方向中指定IP访问流量的配置示例。 更多参数配置请参见“通过添加防护规则拦截/放行流量”。 单独放行入方向中指定IP的访问流量 配置两条防护规则，一条拦截所有流量，优先级置于最低，设置参数如下，其余参数可根据您的部署进行填写： 方向：外内 源：Any 目的：Any 服务：Any 应用：Any 动作：阻断 一条单独放行指定IP的流量访问，优先级设置最高，设置参数如下，其余参数可根据您的部署进行填写： 方向：外内 源：选择“IP地址”，填写具体放行的IP。 目的：Any 服务：Any 应用：Any 动作：放行

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

响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": { "result": false, "error": "cidr(192.168.0.0/18)和子网(192.168.0.0/24)冲突" } } 状态码 请参考 状态码 错误码 请参考 错误码

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

接口功能介绍 获取访问规则的excel文件模板 接口约束 传参规范 URI GET /vfw/v2systemsecpolicyexportmodule 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!" } 状态码 请参考 状态码 错误码 请参考 错误码

参数 参数类型 说明 示例 下级对象 total Integer 总记录数 1 list Array of Objects 结果集 AddressGroupQueryView 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

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

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

接口功能介绍 关闭vpc资产防护 接口约束 传参规范 URI POST /vfw/v2assertcloseprotect 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String 开启防护的vpc scenarioType 是 String 类型nat;vpcPeer对等连接;cda云专线;ec云间高速 scenarioId 是 String 场景id，列表获取 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body { "vpcId": "vpcr5ka3qk24m", "scenarioType": "nat", "scenarioId": "natgwc4gcnb45fn" }

接口功能介绍 查询地址簿详情 接口约束 传参规范 URI GET /vfw/v2addressgroupitems 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 groupId 是 Integer 地址簿id 10 page 否 Integer 页码 1 size 否 Integer 页大小 10 请求参数 请求头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 结果集 GroupIpQueryView 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 表 GroupIpQueryView 参数 参数类型 说明 示例 下级对象 id Long id 1 groupId Integer 地址簿id 10 description String 地址簿描述 描述 content String ip/端口 v4

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

参数 是否必填 参数类型 说明 示例 下级对象 addressGroupName 是 String 地址簿名称 name description 否 String 地址簿描述 描述 addressType 是 String 地址簿类型v4;v6;port v4 addressContent 是 Array of Strings 地址簿ips或者ports ["1.1.1.1"]

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

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

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

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

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

枚举参数 无 请求示例 请求url 无 请求头header { "regionid": "100054c0416811e9a6690242ac110002", "urlType": "CTAPI" } 请求体body {} 响应示例 { "statusCode": "800", "error": "CFW0000", "message": "成功!", "returnObj": { "notifyList": [ { "notifyId": "c6580ef202d64af48cae1e46c140d3ae", "notifyTitle": "入侵检测告警", "notifyType": [ "SERIOUS", "HIGH", "MEDIUM" ], "notifyMethod": [ "EMAIL" ], "timeRange": [ 8, 20 ], "subscriberCount": 1, "status": 1, "users": [ { "userId": "9fed79ddab744ca2aee039454ef1dd4c", "name": "dem", "email": "dba@163.com", "selected": 0 }, { "userId": "81d45010a9824ead9e5b1a86499a2bee", "name": "dit", "email": "dba@163.com", "selected": 0 }, { "userId": "eed24db80ef942e0af4a1284d88b3fbd", "name": "t23", "email": "494@qq.com", "selected": 0 }, { "userId": "c09bbcb66d74402b9709d1deaaa0c9f1", "name": "sy", "email": "sha@chinatelecom.cn", "selected": 1 }, { "userId": "0beb89c5a9924b7d90593a414391c721", "name": "som", "email": "sec@163.com", "selected": 0 } ] } ] } }

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

ctcfweasta.ctapi.ctyun.cn

接口功能介绍 提供更新资产的提示信息接口 接口约束 无 URI POST /vfw/v2systemvrfbindtipupdate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 accountId 是 String 账号id ca888cf3674d4a83a42dbd71f4a09e94 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ids 是 String 提示 regionId 是 String 资源池ID 9f3618ee1c594598a942550985345d0d uid 是 String 租户ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 message String 返回信息 成功 error String 错误码：CFW0000 :成功!;CFW0001:参数错误！;CFW0002：业务错误！ CFW0000 returnObj Object 接口返回结果 枚举参数 无 请求示例 请求url 无 请求头header {"regionid": "100054c0416811e9a6690242ac110002","userId":"562b89493b1a40e1b97ea05e50dd8170","accountId":"ca888cf3674d4a83a42dbd71f4a09e94","urlType": "CTAPI"} 请求体body {"ids": [],"regionId": "","uid": ""}

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

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

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