华为云用户手册

  • 云防火墙 CFW-创建黑白名单规则:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 list_type 是 Integer 黑白名单类型4：黑名单，5：白名单 direction 是 Integer 地址方向0：源地址1：目的地址 address_type 是 Integer ip地址类型 0：ipv4，1:ipv6 address 是 String ip地址 protocol 是 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,手动类型不为空，自动类型为空 port 是 String 目的端口 description 否 String 描述
    云防火墙 CFW
  • 云防火墙 CFW-创建黑白名单规则:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data BlackWhiteListId object 添加黑白名单响应data 表6 BlackWhiteListId 参数 参数类型 描述 id String 黑白名单id name String 黑白名单名称，为黑白名单的地址 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-创建黑白名单规则:响应示例
    响应示例 状态码： 200 添加黑白名单响应 { "data" : { "id" : "6e91797b-05bd-4c69-9454-6af905178729", "name" : "10.10.1.3" } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }
    云防火墙 CFW
  • 云防火墙 CFW-创建黑白名单规则:请求示例
    请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的对象添加方向为源地址，地址为1.1.1.1，协议类型为tcp，端口为1的ipv4的白名单 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 }
    云防火墙 CFW
  • 云防火墙 CFW-删除服务组:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data ServiceSetId object 删除服务组返回数据 表5 ServiceSetId 参数 参数类型 描述 id String 服务组Id name String 服务组名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-删除服务组:响应示例
    响应示例 状态码： 200 删除服务组返回值 { "data" : { "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", "name" : "test" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200004", "error_msg" : "所删除资源被引用，删除失败" }
    云防火墙 CFW
  • 云防火墙 CFW-删除服务组:URI
    URI DELETE /v1/{project_id}/service-sets/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 set_id 是 String 服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW
  • 云防火墙 CFW-弹性IP开启关闭:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 status 是 Integer EIP切换的状态，0表示防护中，1表示未防护 ip_infos 是 Array of ip_infos objects 切换防护状态的EIP信息列表 表5 ip_infos 参数 是否必选 参数类型 描述 id 否 String 弹性公网IP ID，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.id（.表示各对象之间层级的区分）获得。 public_ip 否 String 弹性公网IP IPv4地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ip（.表示各对象之间层级的区分）获得。 public_ipv6 否 String 弹性公网IP IPv6地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ipv6（.表示各对象之间层级的区分）获得。
    云防火墙 CFW
  • 云防火墙 CFW-弹性IP开启关闭:响应示例
    响应示例 状态码： 200 开启关闭EIP防护状态返回值 { "data" : { "fail_eip_id_list" : [ ], "fail_eip_list" : [ ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "id" : "b0a2dacc-3886-4805-838e-281653d3cd1f" } }
    云防火墙 CFW
  • 云防火墙 CFW-弹性IP开启关闭:响应参数
    响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 data EIPSwitchStatusVO object 改变EIP防护状态返回值data 表7 EIPSwitchStatusVO 参数 参数类型 描述 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 fail_eip_id_list Array of strings 修改eip防护状态失败状态列表，状态包括成功"successful"，失败“fail” fail_eip_list Array of FailedEipInfo objects 修改eip防护状态失败信息列表 id String 防火墙id，可通过防火墙ID获取方式获取 表8 FailedEipInfo 参数 参数类型 描述 id String 修改状态失败的eipId。 error_message String 修改状态失败的错误码。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-弹性IP开启关闭:请求示例
    请求示例 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护 https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect { "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62", "status" : 0, "ip_infos" : [ { "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2", "public_ip" : "1.2.3.4" } ] } 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护 /v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect { "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62", "status" : 1, "ip_infos" : [ { "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2", "public_ip" : "1.2.3.4" } ] }
    云防火墙 CFW
  • 云防火墙 CFW-弹性IP开启关闭:URI
    URI POST /v1/{project_id}/eip/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW
  • 云防火墙 CFW-删除标签:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 防火墙标签列表 表4 ResourceTag 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值 update_time 否 String 标签更新时间
    云防火墙 CFW
  • 云防火墙 CFW-删除标签:请求示例
    请求示例 删除项目id为0b2179bbe180d3762fb0c01a2d5725c7，防火墙id为5e7eba7f-5de4-4ce9-8f60-11330dfc6565下的防火墙标签，标签key值为keytest，value为valuetest https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete { "tags" : [ { "key" : "keytest", "value" : "valuetest" } ] }
    云防火墙 CFW
  • 云防火墙 CFW-删除服务成员:请求示例
    请求示例 删除项目id为9d80d070b6d44942af73c9c3d38e0429，服务组成员id为6b37ed55-1e21-46a5-a7dc-a59ef418d359的服务组成员 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items/6b37ed55-1e21-46a5-a7dc-a59ef418d359
    云防火墙 CFW
  • 云防火墙 CFW-删除服务成员:URI
    URI DELETE /v1/{project_id}/service-items/{item_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 item_id 是 String 服务组成员id，可通过查询服务成员列表接口查询获得，通过返回值中的data.records.item_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW
  • 云防火墙 CFW-删除服务成员:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data DeleteServiceItemResponseBodyData object 删除服务组成员数据 表5 DeleteServiceItemResponseBodyData 参数 参数类型 描述 id String 服务组成员id name String 服务组成员名称，为源和目的端口 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-新建服务组:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 name 是 String 服务组名称 description 否 String 服务组描述信息
    云防火墙 CFW
  • 云防火墙 CFW-新建服务组:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data ServiceSetId object 创建服务组返回数据 表6 ServiceSetId 参数 参数类型 描述 id String 服务组Id name String 服务组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-新建服务组:请求示例
    请求示例 添加项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象为cfebd347-b655-4b84-b938-3c54317599b2，名称为ceshi的服务组。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "name" : "ceshi", "description" : "" }
    云防火墙 CFW
  • 云防火墙 CFW-新建服务组:URI
    URI POST /v1/{project_id}/service-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW
  • 云防火墙 CFW-标签创建接口:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of CreateTag objects 创建防火墙标签列表 表4 CreateTag 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值
    云防火墙 CFW
  • 云防火墙 CFW-标签创建接口:请求示例
    请求示例 给项目id为0b2179bbe180d3762fb0c01a2d5725c7，防火墙id为5e7eba7f-5de4-4ce9-8f60-11330dfc6565添加标签，标签的键为keytest，值为valuetest。 https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create { "tags" : [ { "key" : "keytest", "value" : "valuetest" } ] }
    云防火墙 CFW
  • 云防火墙 CFW-更新黑白名单列表:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 direction 否 Integer 地址方向0：源地址1：目的地址 address_type 否 Integer 地址类型0：ipv4，1:ipv6 address 是 String ip地址 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1 port 否 String 端口 description 否 String 描述
    云防火墙 CFW 黑白名单管理
  • 云防火墙 CFW-更新黑白名单列表:URI
    URI PUT /v1/{project_id}/black-white-list/{list_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 list_id 是 String 黑白名单列表id，可通过查询黑白名单列表接口查询获得，通过返回值中的data.records.list_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW 黑白名单管理
  • 云防火墙 CFW-更新黑白名单列表:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data BlackWhiteListId object 更新黑白名单响应数据 表6 BlackWhiteListId 参数 参数类型 描述 id String 黑白名单id name String 黑白名单名称，为黑白名单的地址 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW 黑白名单管理
  • 云防火墙 CFW-更新黑白名单列表:响应示例
    响应示例 状态码： 200 更新黑白名单响应 { "data" : { "id" : "5d37afe6-c5b4-400d-8ff3-a8d6396d7ace", "name" : "10.1.1.10" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }
    云防火墙 CFW 黑白名单管理
  • 云防火墙 CFW-更新黑白名单列表:请求示例
    请求示例 更新项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址，地址为1.1.1.1，协议类型为tcp，端口为1的ipv4的tcp https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b { "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, "port" : "1", "address_type" : 0 }
    云防火墙 CFW 黑白名单管理
  • 云防火墙 CFW-查询地址组列表:URI
    URI GET /v1/{project_id}/address-sets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 key_word 否 String 关键字，包括地址组名称或描述的一部分 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 address 否 String ip地址 address_type 否 Integer 地址类型0 ipv4，1 ipv6 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 query_address_set_type 否 Integer 查询地址组类型，0表示自定义地址组，1表示预定义地址组，当address_set_type不为0时，query_address_set_type为1时才可以生效。 address_set_type 否 Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组
    云防火墙 CFW
  • 云防火墙 CFW-查询地址组列表:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询地址组列表返回数据 表5 data 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 地址组总数 records Array of records objects 地址组列表 表6 records 参数 参数类型 描述 set_id String 地址组id ref_count Integer 地址组被规则引用次数 description String 描述信息 address_type Integer 地址类型0 ipv4，1 ipv6 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 address_set_type Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 name String 地址组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
推荐文章