华为云用户手册

  • 云防火墙 CFW-添加地址组:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data AddressSetId object 添加地址组返回数据 表6 AddressSetId 参数 参数类型 描述 id String 地址组id name String 地址组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-添加地址组:URI
    URI POST /v1/{project_id}/address-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-添加地址组:请求参数
    请求参数 表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 地址组描述 address_type 否 Integer 地址类型0 ipv4，1 ipv6
    云防火墙 CFW
  • 云防火墙 CFW-获取域名组下域名列表:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data ListDomainResponseData object 查询 域名 列表返回值数据 表5 ListDomainResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 project_id String 项目ID records Array of DomainInfo objects 域名信息列表 set_id String 域名组id total Integer 域名总数 表6 DomainInfo 参数 参数类型 描述 domain_address_id String 域名地址id domain_name String 域名，如www.test.com description String 域名描述
    云防火墙 CFW
  • 云防火墙 CFW-获取域名组下域名列表:请求示例
    请求示例 查询项目id为14181c1245cf4fd786824efe1e2b9388下的域名列表，域名组id为78719348-6d79-477e-acec-676a29842ab2，防火墙id为546af3f8-88e9-47f2-a205-2346d7090925。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=200&offset=0
    云防火墙 CFW
  • 云防火墙 CFW-获取域名组下域名列表:响应示例
    响应示例 状态码： 200 查询域名列表返回值 { "data" : { "limit" : 200, "offset" : 0, "project_id" : "14181c1245cf4fd786824efe1e2b9388", "records" : [ { "description" : "", "domain_address_id" : "6718279e-9761-4623-a48d-b16957b19e1b", "domain_name" : "www.test.com" } ], "set_id" : "78719348-6d79-477e-acec-676a29842ab2", "total" : 1 } }
    云防火墙 CFW
  • 云防火墙 CFW-获取域名组下域名列表:URI
    URI GET /v1/{project_id}/domain-set/domains/{domain_set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 domain_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获取方式获取 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 domain_name 否 String 域名名称，如www.test.com 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（.表示各对象之间层级的区分）获得
    云防火墙 CFW
  • 云防火墙 CFW-获取规则击中次数:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data RuleHitCountRecords object 获取规则击中次数响应数据 表6 RuleHitCountRecords 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 total Integer 获取规则击中次数总条数 records Array of RuleHitCountObject objects 规则击中次数信息列表 表7 RuleHitCountObject 参数 参数类型 描述 rule_id String 规则id rule_hit_count Integer 规则击中次数，当acl规则被触发时，对应规则id的击中次数会添加一次。
    云防火墙 CFW
  • 云防火墙 CFW-获取规则击中次数:请求示例
    请求示例 查询项目id为0b2179bbe180d3762fb0c01a2d5725c7中acl规则id为59ff6bd9-0a76-41ec-9650-380086069965的命中次数 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count { "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ] }
    云防火墙 CFW
  • 云防火墙 CFW-获取规则击中次数:响应示例
    响应示例 状态码： 200 获取规则击中次数响应 { "data" : { "limit" : 1, "offset" : 1, "records" : [ { "rule_hit_count" : 0, "rule_id" : "59ff6bd9-0a76-41ec-9650-380086069965" } ], "total" : 1 } }
    云防火墙 CFW
  • 云防火墙 CFW-获取规则击中次数:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 rule_ids 是 Array of strings 规则id列表，规则id，可通过查询防护规则接口查询获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。
    云防火墙 CFW
  • 云防火墙 CFW-获取规则击中次数:URI
    URI POST /v1/{project_id}/acl-rule/count 表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-修改东西向防火墙防护状态:响应参数
    响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data ChangeEastWestFirewallStatusResponseData object 改变东西向防护返回值data 表6 ChangeEastWestFirewallStatusResponseData 参数 参数类型 描述 id String 东西向防护对象ID，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-修改东西向防火墙防护状态:请求示例
    请求示例 将项目id为09bb24e6fe80d23d2fa2c010b53b418c的项目的防护对象74820b38-1cc0-4f0b-8cce-32490fa840a3修改东西向防火墙防护状态为开启 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/firewall/east-west/protect { "object_id" : "74820b38-1cc0-4f0b-8cce-32490fa840a3", "status" : 1 }
    云防火墙 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为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 status 是 Integer 防护状态：0 开启，1 关闭
    云防火墙 CFW
  • 云防火墙 CFW-修改东西向防火墙防护状态:URI
    URI POST /v1/{project_id}/firewall/east-west/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-查询防护VPC数:响应示例
    响应示例 状态码： 200 查询东西向防护返回值 { "data" : { "other_protect_vpcs" : [ ], "other_total" : 0, "protect_vpcs" : [ ], "self_protect_vpcs" : [ ], "self_total" : 0, "total" : 0, "total_assets" : 5 } } 状态码： 400 Bad Request { "error_code" : "CFW.00109004", "error_msg" : "HTTP请求错误" }
    云防火墙 CFW
  • 云防火墙 CFW-查询防护VPC数:请求示例
    请求示例 查询项目id为0b2179bbe180d3762fb0c01a2d5725c7，防护对象id为8839526e-b804-4a15-a082-a2c797dce633的东西向墙防护信息 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633
    云防火墙 CFW
  • 云防火墙 CFW-查询防护VPC数:URI
    URI GET /v1/{project_id}/vpcs/protection 表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为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取
    云防火墙 CFW
  • 云防火墙 CFW-查询防护VPC数:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data VPCProtectsVo object 防护vpc返回值 表5 VPCProtectsVo 参数 参数类型 描述 total Integer 总防护VPC数 self_total Integer 防火墙东西向防护可进行跨账号防护VPC，self_total表示本项目防护VPC总数。 other_total Integer 防火墙东西向防护可进行跨账号防护VPC，other_total表示其他项目防护VPC数 protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，protect_vpcs指的是总体防护VPC列表 self_protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，self_protect_vpcs指的是本项目防护VPC列表 other_protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，other_protect_vpcs指的是其他项目防护VPC列表 total_assets Integer 租户的所有VPC资产数量 表6 VpcAttachmentDetail 参数 参数类型 描述 vpc_id String 东西向防护添加的防护vpc的id 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
    云防火墙 CFW
  • 云防火墙 CFW-创建抓包任务:请求参数
    请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 destination 是 CaptureRuleAddressDto object 抓包规则目的地址请求体 duration 是 Integer 抓包时长，以分钟为单位 max_packets 是 Integer 最大抓包数，以个为单位 name 是 String 抓包任务名称 service 是 CaptureServiceDto object 抓包任务服务请求体 source 是 CaptureRuleAddressDto object 抓包规则源地址请求体 表5 CaptureServiceDto 参数 是否必选 参数类型 描述 dest_port 否 String 目的端口 protocol 是 Integer 协议类型:TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1，手动类型不为空，自动类型为空 source_port 否 String 源端口 表6 CaptureRuleAddressDto 参数 是否必选 参数类型 描述 address 是 String 地址 address_type 是 Integer 目的地址类型0 ipv4，1 ipv6 type 是 Integer 输入地址类型，目前只支持0，手工输入类型
    云防火墙 CFW
  • 云防火墙 CFW-创建抓包任务:请求示例
    请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c，防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务，任务名称为zhuabaotest，最大抓包数为100000，抓包时长为3分钟，剩余保留天数为7天，源地址协议为tcp协议，地址类型为ipv4，地址为1.1.1.1，端口号为1-65535，目的地址协议为tcp协议，地址类型为ipv4，地址为2.2.2.2，端口号为1-65535。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default { "name" : "zhuabaotest", "max_packets" : 100000, "duration" : 3, "source" : { "type" : 0, "address_type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address_type" : 0, "address" : "2.2.2.2" }, "service" : { "protocol" : -1, "source_port" : "", "dest_port" : "" } }
    云防火墙 CFW
  • 云防火墙 CFW-创建抓包任务:URI
    URI POST /v1/{project_id}/capture-task 表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-查询规则标签:请求示例
    请求示例 查询项目id为14181c1245cf4fd786824efe1e2b9388的防火墙id为546af3f8-88e9-47f2-a205-2346d7090925的已有acl标签。 https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
    云防火墙 CFW
  • 云防火墙 CFW-查询规则标签:响应示例
    响应示例 状态码： 200 查询规则标签返回值 { "data" : { "limit" : 1000, "offset" : 0, "records" : [ { "tag_id" : "98fdf013-e7ad-4581-9c71-6de04c76a18f", "tag_key" : "1", "tag_value" : "1" }, { "tag_id" : "36e6fbfe-7fcd-48be-872b-4f6074e1e4e8", "tag_key" : "1", "tag_value" : "2" }, { "tag_id" : "0bf41046-6587-42f2-8399-a6864022b504", "tag_key" : "测试", "tag_value" : "测试" } ], "total" : 3 } }
    云防火墙 CFW
  • 云防火墙 CFW-查询规则标签:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data HttpGetAclTagResponseData object 获取规则标签数据 表5 HttpGetAclTagResponseData 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 规则标签总数 records Array of TagsVO objects 规则标签列表 表6 TagsVO 参数 参数类型 描述 tag_id String 规则id tag_key String 规则标签键 tag_value String 规则标签值
    云防火墙 CFW
  • 云防火墙 CFW-查询规则标签:URI
    URI GET /v2/{project_id}/cfw-acl/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit 是 Integer 每页显示个数，范围为1-1024
    云防火墙 CFW
  • 云防火墙 CFW-IPS特性开关操作:请求参数
    请求参数 表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（.表示各对象之间层级的区分）获得。 ips_type 是 Integer 补丁类型，仅支持虚拟补丁，值为2。 status 是 Integer ips特性开关状态，0表示关闭，1表示开启
    云防火墙 CFW
  • 云防火墙 CFW-IPS特性开关操作:请求示例
    请求示例 ips开关接口，该接口是租户界面通过开关控制引擎的基础补丁和虚拟补丁的开闭状态。以下示例为开启项目id为14181c1245cf4fd786824efe1e2b9388，防护对象id为1530de8a-522d-4771-9067-9fa4e2f53b48的基础补丁开关。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "ips_type" : 1, "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", "status" : 1 }
    云防火墙 CFW
  • 云防火墙 CFW-IPS特性开关操作:URI
    URI POST /v1/{project_id}/ips/switch 表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
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

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