华为云用户手册

  • 请求示例 删除项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的防护对象 id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b的规则,规则id为0475c516-0e41-4caf-990b-0c504eebd73f和8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule { "rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" }
  • 响应示例 状态码: 200 批量删除规则返回值 { "data" : { "responseDatas" : [ { "name" : "test", "id" : "0475c516-0e41-4caf-990b-0c504eebd73f" }, { "name" : "test2", "id" : "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" } ] } }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data BatchDeleteAclRulesResponseData object 批量删除ACL规则返回值data 表6 BatchDeleteAclRulesResponseData 参数 参数类型 描述 responseDatas Array of BatchDeleteRuleInfo objects 批量删除规则返回data 表7 BatchDeleteRuleInfo 参数 参数类型 描述 name String acl名称 id String aclId
  • URI DELETE /v1/{project_id}/acl-rule 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 请求示例 批量更新项目id为14181c1245cf4fd786824efe1e2b9388下防火墙id为546af3f8-88e9-47f2-a205-2346d7090925下的规则id为4e12d889-c1d3-491b-8470-3d1b3dadc1fd和f798a6a8-c4c5-42b4-838c-c922c9908cb4的规则为启用状态 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/acl-rule/action?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "action" : "enable", "rule_ids" : [ "4e12d889-c1d3-491b-8470-3d1b3dadc1fd", "f798a6a8-c4c5-42b4-838c-c922c9908cb4" ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 action 是 String 动作 rule_ids 是 Array of strings 规则ID列表
  • URI DELETE /v1/{project_id}/domain-set/domains/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id set_id 是 String 域名组id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 domain_address_ids 是 Array of strings 域名id列表
  • 请求示例 项目id为14181c1245cf4fd786824efe1e2b9388的项目,删除防火墙id为546af3f8-88e9-47f2-a205-2346d7090925的防火墙下的域名组域名,防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b,域名组id为78719348-6d79-477e-acec-676a29842ab2,域名列表为"b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "domain_address_ids" : [ "b9c23ad8-16d2-4f14-894f-29250c5d27e5", "c36f9462-467b-4303-9734-f9abc38ddb95" ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" }
  • 响应示例 状态码: 200 查询域名有效性返回值 { "data" : [ "192.168.88.85", "192.168.88.50", "192.168.88.22", "192.168.88.87", "192.168.88.86", "192.168.5.1", "192.168.88.88", "192.168.88.90", "192.168.88.83", "192.168.88.84" ] } 状态码: 400 Bad Request { "error_code" : "CFW.00109004", "error_msg" : "HTTP请求错误" }
  • URI GET /v1/{project_id}/domain/parse/{domain_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id domain_name 是 String 域名 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 address_type 否 Integer 地址类型,0 ipv4,1 ipv6
  • 请求示例 向项目id为9d80d070b6d44942af73c9c3d38e0429,防火墙id为546af3f8-88e9-47f2-a205-2346d7090925添加域名组,域名组名称为test,域名组内域名为www.aaa.com,防护对象id为fde07429-2e02-45c0-a85f-4f1cacea24d2,域名组类型为应用域名组。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "name" : "test", "domain_set_type" : 0, "description" : "", "domain_names" : [ { "domain_name" : "www.aaa.com", "description" : "" } ], "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "object_id" : "fde07429-2e02-45c0-a85f-4f1cacea24d2" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 object_id 是 String 互联网边界防护对象id,可通过调用查询防火墙实例接口,type为0的为互联网边界防护对象id。 name 是 String 域名组名称 description 否 String 描述 domain_names 是 Array of DomainSetInfoDto objects 域名信息列表 domain_set_type 是 Integer 域名组类型,0表示应用域名组,1表示网络域名组 表5 DomainSetInfoDto 参数 是否必选 参数类型 描述 domain_name 是 String 域名 description 否 String 描述
  • URI POST /v1/{project_id}/domain-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 请求示例 更新项目id为2349ba469daf4b7daf268bb0261d18b0的dns解析器的设置,服务器ip为8.8.8.8,默认服务器,更新为使用,服务器ip为192.168.0.2,非默认服务器,更新为非使用 https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers { "dns_server" : [ { "server_ip" : "8.8.8.8", "is_customized" : 0, "is_applied" : 1 }, { "server_ip" : "192.168.0.2", "is_customized" : 1, "is_applied" : 0 } ] }
  • 响应示例 状态码: 200 更新Dns服务器响应 { "data" : [ "100.95.150.83", "114.114.114.114", "223.5.5.5", "223.6.6.6", "119.29.29.29", "8.8.8.8", "100.79.1.250", "100.79.1.240" ] } 状态码: 400 Bad Request { "error_code" : "CFW.01000001", "error_msg" : "DNS服务器IP重复" }
  • URI PUT /v1/{project_id}/dns/servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。若object_Id非空,默认返回object_Id对应墙的信息;填写时object_Id需要属于fw_instance_Id对应的墙。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 dns_server 是 Array of dns_server objects DNS服务器 health_check_domain_name 否 String 健康检查域名 表5 dns_server 参数 是否必选 参数类型 描述 server_ip 否 String DNS服务器IP is_customized 否 Integer 是否是用户自定义的dns服务器,0否 1是 is_applied 否 Integer 是否应用,0否 1是
  • 响应示例 状态码: 200 日志配置DTO { "data" : { "fw_instance_id" : "4df2bcd1-6299-4fba-8e71-8d50ea807090", "lts_access_log_stream_enable" : 0, "lts_attack_log_stream_enable" : 0, "lts_enable" : 0, "lts_flow_log_stream_enable" : 0, "lts_log_group_id" : "d783ce42-7f56-4c2d-9a96-b1043d016f5a" } }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data LogConfigDto object 日志配置数据 表5 LogConfigDto 参数 参数类型 描述 fw_instance_id String 防火墙id lts_enable Integer 是否开启LTS lts_log_group_id String LTS日志分组id lts_attack_log_stream_id String 攻击日志流id lts_attack_log_stream_enable Integer 是否开启攻击日志流 lts_access_log_stream_id String 访问控制日志流id lts_access_log_stream_enable Integer 是否开启访问控制流 lts_flow_log_stream_id String 流量日志id lts_flow_log_stream_enable Integer 是否开启流量日志
  • 请求示例 查询项目id为408972e72dcd4c1a9b033e955802a36b下的防火墙id为4e113415-7811-4bb3-bf5e-eb835953f7d4的防火墙的日志配置。 https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=4e113415-7811-4bb3-bf5e-eb835953f7d4&enterprise_project_id=default
  • URI GET /v1/{project_id}/cfw/logs/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。
  • 请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的防护id为cfebd347-b655-4b84-b938-3c54317599b2的防护对象下发拦截模式为严格的防护模式。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "mode" : 1 }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data data object object 表6 data 参数 参数类型 描述 id String 防护对象id 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 否 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 mode 否 Integer ips防护模式,0:观察模式,1:严格模式,2:中等模式,3:宽松模式
  • URI POST /v1/{project_id}/ips/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 修订记录 发布日期 修改说明 2024-06-17 第四次正式发布。 优化: 全文参数正确性。 2023-12-15 第三次正式发布。 新增以下接口: 创建防火墙 获取CFW任务执行状态 删除防火墙 获取日志配置 创建日志配置 更新日志配置 2023-10-11 第二次正式发布。 新增以下接口: 查询防火墙列表 批量更新规则动作 查询规则标签 “域名解析及域名组管理”章节下全部接口。 2022-11-30 第一次正式发布。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data RuleId object 规则id列表 表6 RuleId 参数 参数类型 描述 id String id name String 名称 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 dest_rule_id 否 String 目标规则id,添加规则位于此规则之后,非置顶时不能为空,置顶时为空 top 否 Integer 是否置顶,0代表非置顶,1代表置顶 bottom 否 Integer 是否置底,0代表非置底,1代表置底
  • 请求示例 设置项目id9d80d070b6d44942af73c9c3d38e0429中规则id为ffe9af47-d893-483b-86e3-ee5242e8cb15的规则移动到规则id为69c32dc5-f801-4294-98ee-978b51f97d35后 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/order/ffe9af47-d893-483b-86e3-ee5242e8cb15 { "top" : 0, "dest_rule_id" : "69c32dc5-f801-4294-98ee-978b51f97d35" }
共100000条