华为云用户手册

  • 响应示例 状态码: 200 查询服务组成员详情响应 { "data" : { "service_set_type" : 0, "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", "name" : "ceshi2" } } 状态码: 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data ServiceSetDetailResponseDto object 服务组详情数据 表5 ServiceSetDetailResponseDto 参数 参数类型 描述 id String 服务组id name String 服务组名称 最小长度:1 最大长度:255 description String 服务组描述信息 最小长度:1 最大长度:255 service_set_type Integer 服务组类型,0表示自定义服务组,1表示常用WEB服务,2表示常用远程登录和PING,3表示常用数据库 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data IdObject object 添加地址组返回数据 表6 IdObject 参数 参数类型 描述 id String id值 name String 名称 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI POST /v1/{project_id}/address-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建 云防火墙 后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,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。具体可参考APIExlorer和帮助中心FAQ。 name 是 String 地址组名称 description 否 String 地址组描述 address_type 否 Integer 地址类型0 ipv4,1 ipv6 枚举值: 0 1
  • 请求示例 添加项目id为14181c1245cf4fd786824efe1e2b9388,防护对象 id为1530de8a-522d-4771-9067-9fa4e2f53b48,名称为ceshi的ipV4的地址组。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/address-set { "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", "name" : "ceshi", "description" : "", "address_type" : 0 }
  • URI GET /v1/{project_id}/domain-set/domains/{domain_set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID domain_set_id 是 String 域名组id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 limit 是 Integer 每页显示个数,范围为1-1024 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 domain_name 否 String 域名名称 description 否 String 描述 set_id 否 String 域名组id object_Id 否 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data ListDomainResponseData object 查询域名返回值data 表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 域名 description String 描述 dns_ips Array of strings 域名服务器列表
  • 请求示例 查询项目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
  • 响应示例 状态码: 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 } }
  • 响应示例 状态码: 200 获取规则击中次数响应 { "data" : { "limit" : 1, "offset" : 1, "records" : [ { "rule_hit_count" : 0, "rule_id" : "59ff6bd9-0a76-41ec-9650-380086069965" } ], "total" : 1 } }
  • 响应参数 状态码: 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 规则击中次数
  • 请求示例 查询项目id为0b2179bbe180d3762fb0c01a2d5725c7中acl规则id为59ff6bd9-0a76-41ec-9650-380086069965命中次数 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count { "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ] }
  • URI POST /v1/{project_id}/acl-rule/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 请求示例 给项目id为09bb24e6fe80d23d2fa2c010b53b418c的项目的防护对象74820b38-1cc0-4f0b-8cce-32490fa840a3修改东西向防火墙防护状态为开启 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/firewall/east-west/protect { "object_id" : "74820b38-1cc0-4f0b-8cce-32490fa840a3", "status" : 1 }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 data data object 响应体 trace_id String trace id 表6 data 参数 参数类型 描述 id String 标识ID 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI POST /v1/{project_id}/firewall/east-west/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,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。具体可参考APIExlorer和帮助中心FAQ。 status 是 Integer 防护状态:0 开启,1 关闭 枚举值: 0 1
  • 响应示例 状态码: 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请求错误" }
  • 请求示例 查询项目id为0b2179bbe180d3762fb0c01a2d5725c7,防护对象id为8839526e-b804-4a15-a082-a2c797dce633的东西向墙防护信息 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633
  • URI GET /v1/{project_id}/vpcs/protection 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 trace_id String 调用链id data VPCProtectsVo object 防护vpc返回值 表5 VPCProtectsVo 参数 参数类型 描述 total Integer 总VPC数 self_total Integer 本项目防护VPC数 other_total Integer 其他项目防护VPC数 protect_vpcs Array of VpcAttachmentDetail objects 防护VPC self_protect_vpcs Array of VpcAttachmentDetail objects 本项目防护VPC other_protect_vpcs Array of VpcAttachmentDetail objects 其他项目防护VPC total_assets Integer 所有资产数量 表6 VpcAttachmentDetail 参数 参数类型 描述 id String id name String 名称 vpc_id String vpc id virsubnet_id String 子网id state String 状态 created_at String 创建时间 updated_at String 更新时间 tags Array of Tag objects 标签 description String 描述 project_id String 项目id vpc_project_id String vpc项目id enterprise_project_id String 企业项目id 表7 Tag 参数 参数类型 描述 key String 键 value String 值 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:8 最大长度:36 error_msg String 错误描述 最小长度:2 最大长度:512
  • URI GET /v2/{project_id}/cfw-acl/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。 offset 是 Integer 偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0 limit 是 Integer 每页显示个数,范围为1-1024
  • 响应参数 状态码: 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 标签值
  • 请求示例 查询项目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
  • 响应示例 状态码: 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 } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) X-Language 否 String 语言头部,默认为zh-cn,如需使用英文,请选择en-us 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id,是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id,可通过调用查询防火墙实例接口获得,注意type为0的为互联网边界防护对象id,type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 ips_type 是 Integer 补丁类型,仅支持虚拟补丁,值为2。 枚举值: 1 2 status 是 Integer 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 }
  • URI POST /v1/{project_id}/ips/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project_id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id,用户支持企业项目后,由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。
  • 请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2第一页的白名单,查询条数为5条 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5
共100000条