华为云用户手册

  • 响应示例 状态码: 200 查询服务组信息响应 { "data" : { "limit" : 50, "offset" : 0, "records" : [ { "name" : "test", "project_id" : "2349ba469daf4b7daf268bb0261d18b0", "protocols" : [ 6 ], "ref_count" : 2, "service_set_type" : 0, "set_id" : "6f475bad-5d33-45d1-98f8-c79f2f308d5a" } ], "total" : 1 } } 状态码: 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data ServiceSetRecords object 查询服务组列表返回值 表5 ServiceSetRecords 参数 参数类型 描述 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 limit Integer 每页显示个数,范围为1-1024 total Integer 查询总数 records Array of ServiceSet objects 服务组列表 表6 ServiceSet 参数 参数类型 描述 set_id String 服务组id name String 名称 description String 描述 service_set_type Integer 服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库 ref_count Integer 引用次数 project_id String 项目id protocols Array of integers 协议类型列表 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI GET /v1/{project_id}/service-sets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 互联网边界防护对象id,可通过调用查询防火墙实例接口,type为0的为互联网边界防护对象id。 key_word 否 String 关键字 limit 是 Integer 每页查询个数,范围为1-1024 最小值:1 最大值:1024 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建 云防火墙 后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 query_service_set_type 否 Integer 查询服务组类型,0表示自定义服务组,1表示预定义服务组
  • 请求示例 删除项目9d80d070b6d44942af73c9c3d38e0429地址组id为e4884376-7efb-40e7-b98b-13668d6f8b85下的地址组成员id为d072ad2e-033c-40a9-b0b5-751f9c2943a6 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85", "address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ] }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 set_id 是 String 地址组id address_item_ids 是 Array of strings 地址组成员id列表
  • URI DELETE /v1/{project_id}/address-items 表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对应墙的信息。
  • URI GET /v1/{project_id}/ips/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data IpsSwitchResponseDTO object ips开关data 表5 IpsSwitchResponseDTO 参数 参数类型 描述 id String ips开关id basic_defense_status Integer 基础防御状态 virtual_patches_status Integer 虚拟补丁状态
  • 请求示例 通过租户id14181c1245cf4fd786824efe1e2b9388查询当前租户的补丁开启状态,用来加载入侵防御页面的虚拟补丁的开关状态。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2
  • 请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的对象添加方向为源地址,地址为1.1.1.1,协议类型为tcp,端口为1的ipv4的tcp的白名单 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "list_type" : 5, "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, "port" : "1", "address_type" : 0 }
  • URI POST /v1/{project_id}/black-white-list 表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对应墙的信息。
  • 请求参数 表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。 list_type 是 Integer 黑白名单类型4:黑名单,5:白名单 direction 是 Integer 地址方向0:源地址1:目的地址 address_type 是 Integer Ip地址类型 0:ipv4,1:ipv6 address 是 String 地址类型 protocol 是 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空,自动类型为空 port 是 String 目的端口 description 否 String 描述
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data IdObject object 添加黑白名单响应data 表6 IdObject 参数 参数类型 描述 id String id值 name String 名称 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data IdObject object 删除服务组返回数据 表5 IdObject 参数 参数类型 描述 id String id值 name String 名称 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI DELETE /v1/{project_id}/service-sets/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id set_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对应墙的信息。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 互联网边界防护对象id,可通过调用查询防火墙实例接口,type为0的为互联网边界防护对象id。 name 是 String 服务组名称 最小长度:1 最大长度:255 description 否 String 服务组描述信息 最小长度:1 最大长度:255
  • 响应参数 状态码: 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
  • 请求示例 添加项目id为9d80d070b6d44942af73c9c3d38e0429,防护对象为cfebd347-b655-4b84-b938-3c54317599b2,名称为ceshi的服务组。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "name" : "ceshi", "description" : "" }
  • URI POST /v1/{project_id}/service-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为9d80d070b6d44942af73c9c3d38e0429,防火墙id为7a004e79-0b8b-4679-ab20-267f3946e8ba下的 域名 组,域名组id为89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default
  • URI DELETE /v1/{project_id}/domain-set/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id set_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为9d80d070b6d44942af73c9c3d38e0429的服务组id为688faf62-20fc-4ca6-b9f9-6fbc518df5ae下的服务组成员f837f7ae-22c9-449d-a99c-4be24533e243 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "set_id" : "688faf62-20fc-4ca6-b9f9-6fbc518df5ae", "service_item_ids" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ] }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 表4 请求Body参数 参数 是否必选 参数类型 描述 set_id 是 String 服务组id service_item_ids 是 Array of strings 服务组成员id列表
  • URI DELETE /v1/{project_id}/service-items 表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为9d80d070b6d44942af73c9c3d38e0429下的防火墙id为7a004e79-0b8b-4679-ab20-267f3946e8ba的域名组id为94da194d-24b2-4f60-919e-cf0bc76c75b3,修改名称为test。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/94da194d-24b2-4f60-919e-cf0bc76c75b3?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "name" : "test", "description" : "" }
  • URI PUT /v1/{project_id}/domain-set/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id set_id 是 String 域名组id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。
  • 响应示例 状态码: 200 EIP数据查询返回值 { "data" : { "limit" : 200, "offset" : 0, "records" : [ { "associate_instance_type" : "PORT", "device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e", "device_name" : "test", "device_owner" : "compute:test", "domain_id" : "7d07807209524a4280266db9df63c4fa", "enterprise_project_id" : "0", "fw_domain_id" : "7d07807209524a4280266db9df63c4fa", "fw_enterprise_project_id" : "default", "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "fw_instance_name" : "test", "id" : "465b34fe-e017-4831-a21c-9c6c753bb1f2", "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "public_ip" : "100.85.223.15", "status" : 0, "tags" : "combined_order_id=CBR CS 23040615138M2KW912" } ], "total" : 1 } } 状态码: 400 Bad Request { "error_code" : "CFW.00109004", "error_msg" : "HTTP请求错误" }
  • 请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429,防护对象id为cfebd347-b655-4b84-b938-3c54317599b2,非同步的第一页的数据 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data EipResponseData object 查询eip返回data 表5 EipResponseData 参数 参数类型 描述 limit Integer 每页显示个数,范围为1-1024 offset Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 total Integer 总数 records Array of EipResource objects eip资源记录 表6 EipResource 参数 参数类型 描述 id String 弹性公网ID public_ip String 弹性公网IP status Integer EIP防护状态,0表示防护中,1表示未防护 枚举值: 0 1 public_ipv6 String 弹性公网IP,IPV6 enterprise_project_id String 企业项目id device_id String 设备id device_name String 设备名称 device_owner String 设备拥有者 associate_instance_type String 关联实例类型 fw_instance_name String 防火墙名称 fw_instance_id String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口。 fw_enterprise_project_id String Eip绑定的防火墙企业项目id object_id String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 tags String 标签列表 domain_id String EIP所属用户 owner String 所属用户的名称 fw_domain_id String 防火墙所属用户 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI GET /v1/{project_id}/eips/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。 最小长度:36 最大长度:36 key_word 否 String 弹性公网ID/弹性公网IP 最小长度:0 最大长度:255 status 否 String 防护状态 null-全部 0-开启防护 1-关闭防护 枚举值: null 0 1 sync 否 Integer 是否同步租户EIP数据 0-不同步 1-同步 枚举值: 0 1 limit 是 Integer 每页显示个数,范围为1-1024 最小值:0 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 最小值:0 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 device_key 否 String 设备键 address_type 否 Integer 地址类型0 ipv4,1 ipv6 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 fw_key_word 否 String 所绑定防火墙id防火墙名称 eps_id 否 String 弹性公网ip的企业项目id tags 否 String 标签列表信息
共100000条