华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 服务组名称 最小长度：1 最大长度：255 description 否 String 服务组描述信息 最小长度：1 最大长度：255

URI PUT /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对应墙的信息。

请求示例 更新项目id为9d80d070b6d44942af73c9c3d38e0429的服务组id为221cfdca-3abf-4c30-ab0d-516a03c70866的名称改为ceshi2，描述改为描述 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 { "name" : "ceshi2", "description" : "描述" }

响应参数 状态码： 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

响应示例 状态码： 200 东西向防火墙信息响应 { "data" : { "er" : { "id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", "name" : "er", "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "attachment_id" : "e978c028-0ccf-4168-a015-0094ac631e88" }, "inspection_vpc" : { "cidr" : "10.13.13.0/24", "id" : "3baa2248-03d4-47ac-aefa-ec6f9a30ed80", "name" : "inspection-vpc" }, "limit" : 50, "mode" : "er", "object_id" : "6cc31075-0b03-461d-aa3a-73c4765bf9ac", "offset" : 0, "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protect_infos" : [ { "protected_resource_id" : "09b26b83-4b7c-499f-805b-50820900cd9f", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-4", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "2956f917-af18-44a2-a0f2-f592633d4431", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t3", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "69d4c81f-80bd-4c28-9074-f26b400b3a34", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t2", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "e1b18d3e-8f7d-4c4e-a326-37db7bd89a3a", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t1", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "f91c1747-1325-4b39-9d58-7fac0bd2786f", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-5", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "bd556a7d-447e-49eb-be17-f93af09769f5", "protected_resource_mode" : "er", "protected_resource_name" : "inspct-a", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 1 } ], "status" : 0, "total" : 6, "special_vpc" : [ ] } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data GetEastWestFirewallResponseBody object 获取东西向防火墙列表返回data 表5 GetEastWestFirewallResponseBody 参数 参数类型 描述 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 project_id String 租户project_id status Integer 防护状态：0 已开启防护， 1 未开启防护 er_associated_subnet SubnetInfo object ER关联子网信息 firewall_associated_subnets Array of SubnetInfo objects 云防火墙关联子网信息 er ErInstance object 出方向关联企业路由器信息 inspection_vpc VpcDetail object 监控vpc信息 protect_infos Array of EwProtectResourceInfo objects 东西向防护资源信息 total Integer 防护VPC总数 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 mode String 防护模式 ew_vpc_route_limit Integer 东西向路由限制 表6 SubnetInfo 参数 参数类型 描述 availability_zone String 子网id cidr String vpc cidr name String 子网名称 id String 子网id gateway_ip String 子网网关ip vpc_id String vpc id status String 子网的状态 ipv6_enable Boolean 是否支持ipv6，boolean值为true表示是，false表示否 表7 ErInstance 参数 参数类型 描述 id String ER实例id name String ER名称 state String ER状态 enterprise_project_id String 企业租户id project_id String 租户id enable_ipv6 String 是否开启ipv6 attachment_id String 连接id 表8 VpcDetail 参数 参数类型 描述 id String id name String 名称 cidr String vpc cidr status String 状态 表9 EwProtectResourceInfo 参数 参数类型 描述 protected_resource_type Integer 防护资源类型：0 VPC，1 VGW protected_resource_name String 防护资源名称 protected_resource_id String 防护资源id protected_resource_nat_name String 防护资源nat网关名称 protected_resource_nat_id String 防护资源nat网关id protected_resource_project_id String 防护资源租户id protected_resource_mode String 防护资源模式 status Integer 防护VPC的防护状态，0表示已关联，1表示未关联。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/firewall/east-west 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318初始时间为1663567058000，结束时间为1664171765000的第一页数据，查询条数为10条 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/attack?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663567058000&end_time=1664171765000&limit=10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询攻击日志返回值 表5 data 参数 参数类型 描述 total Integer 返回数量 limit Integer 每页显示个数，范围为1-1024 records Array of records objects 记录 表6 records 参数 参数类型 描述 direction String 方向，有内到外和外到内两种 枚举值： out2in in2out action String 动作 event_time Long 事件时间 attack_type String 攻击类型 attack_rule String 攻击规则 level String 威胁等级 source String 来源 packet_length Long 报文长度 attack_rule_id String 攻击规则id hit_time Integer 命中时间 log_id String 日志ID src_ip String 源IP src_port Integer 源端口 最小值：0 最大值：65535 dst_ip String 目的IP dst_port Integer 目的端口 最小值：0 最大值：65535 protocol String 协议 packet String 攻击日志报文 app String 应用协议 packetMessages Array of PacketMessage objects 攻击报文信息 src_region_id String 源区域id src_region_name String 源区域名称 dst_region_id String 目的区域id dst_region_name String 目的区域名称 src_province_id String 源省份id src_province_name String 源省份名称 src_city_id String 源城市id src_city_name String 源城市名称 dst_province_id String 目的省份id dst_province_name String 目的省份名称 dst_city_id String 目的城市id dst_city_name String 目的城市名称 表7 PacketMessage 参数 参数类型 描述 hex_index String 16进制index hexs Array of strings 16进制数列 utf8_String String utf_8字符串 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/cfw/logs/attack 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间 end_time 是 Long 结束时间 src_ip 否 String 源IP src_port 否 Integer 源端口号 最小值：0 最大值：65535 dst_ip 否 String 目的IP dst_port 否 Integer 目的端口号 最小值：0 最大值：65535 protocol 否 String 协议类型，包含TCP, UDP,ICMP,ICMPV6等。 app 否 String 应用协议 log_id 否 String 文档ID,第一页为空，其他页不为空，其他页可取上一次查询最后一条数据的log_id next_date 否 Long 下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的event_time offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空 limit 是 Integer 每页显示个数，范围为1-1024 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。 action 否 String 动作包含permit，deny direction 否 String 方向，包含in2out，out2in attack_type 否 String 入侵事件类型 attack_rule 否 String 入侵事件规则 level 否 String 威胁等级，包括CRITICAL、HIGH、MEDIUM、LOW enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 dst_host 否 String 目标主机 log_type 否 String 日志类型包括：internet，vpc，nat 枚举值： internet nat vpc attack_rule_id 否 String 入侵事件id src_region_name 否 String 源region名称 dst_region_name 否 String 目的region名称 src_province_name 否 String 源省份名称 dst_province_name 否 String 目的省份名称 src_city_name 否 String 源城市名称 dst_city_name 否 String 目的城市名称

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429，服务组id为7cdebed3-af07-494e-a3c2-b88bb8d58b57的服务组成员列表 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0

响应示例 状态码： 200 服务组成员列表返回值 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "dest_port" : "0", "item_id" : "805b711d-c558-41e3-aab1-a4b8c3f1f90b", "description" : "", "protocol" : 1, "source_port" : "0" } ], "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57", "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 服务组成员列表 表5 data 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 记录的总数 set_id String 服务组id records Array of records objects 记录 表6 records 参数 参数类型 描述 item_id String 服务成员id protocol Integer 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 source_port String 源端口 dest_port String 目的端口 description String 服务成员描述 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/service-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 set_id 是 String 服务组id key_word 否 String 查询字段 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于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表示预定义服务组。仅当set_id为预定义服务组id时生效

请求示例 查询项目id为14181c1245cf4fd786824efe1e2b9388，企业项目id为all_granted_eps的第一页的防火墙列表 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps { "limit" : 10, "offset" : 0 }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 user_support_eps Boolean 是否支持eps has_ndr Boolean 是否存在ndr is_support_postpaid Boolean 是否支持按需购买 is_support_basic_version Boolean 是否支持基础版 is_support_buy_professional Boolean 是否支持购买专业版 data HttpFirewallInstanceListResponseData object 查询防火墙列表返回值data信息 表7 HttpFirewallInstanceListResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 project_id String 租户项目ID total Integer 总数 records Array of FirewallInstanceVO objects 查询防火墙列表记录 表8 FirewallInstanceVO 参数 参数类型 描述 fw_instance_id String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 resource_id String 资源id name String 防火墙创建时间戳 fw_instance_name String 防火墙名称 enterprise_project_id String 企业项目id，用户支持企业项目后，由企业项目生成的id。 ha_type Integer 集群类型 charge_mode Integer 计费模式 0：包年/包月 1：按需 service_type Integer 服务类型 engine_type Integer 引擎类型 flavor Flavor object 防火墙规格信息 status Integer 防火墙状态列表，包括-1：等待支付，0：创建中，1，删除中，2：运行中，3：升级中，4：删除完成：5：冻结中，6：创建失败，7：删除失败，8：冻结失败，9：存储中，10：存储失败，11：升级失败 tags String 标签列表 表9 Flavor 参数 参数类型 描述 version Integer 防火墙版本，0：标准版，1：专业版，2：铂金版，3：基础版，购买时，当防火墙“charge_mode”为“postPaid”时，仅支持专业版。“charge_mode”为“prePaid”时，支持标准版、专业版。 枚举值： 0 1 2 3 eip_count Integer eip数量 最小值：1 vpc_count Integer vpc数量 最小值：1 bandwidth Integer 带宽 最小值：1 log_storage Integer 日志存储 default_bandwidth Integer 默认防火墙带宽 default_eip_count Integer 默认eip数 default_log_storage Integer 默认日志存储 default_vpc_count Integer 默认vpc数

响应示例 状态码： 200 查询防火墙列表返回值 { "data" : { "limit" : 1, "offset" : 0, "project_id" : "14181c1245cf4fd786824efe1e2b9388", "records" : [ { "fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "name" : "1709176078374", "fw_instance_name" : "test", "enterprise_project_id" : "default", "tags" : "{\"key_test3\":\"value_test3\"}", "ha_type" : 0, "charge_mode" : 0, "service_type" : 0, "engine_type" : 1, "flavor" : { "version" : 1, "eip_count" : 50, "vpc_count" : 6, "bandwidth" : 50, "log_storage" : 0, "default_eip_count" : 50, "default_vpc_count" : 2, "default_bandwidth" : 50, "default_log_storage" : 0 }, "status" : 2 } ], "total" : 18 }, "has_ndr" : false, "is_support_basic_version" : true, "is_support_buy_professional" : false, "is_support_postpaid" : true, "user_support_eps" : false }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id key_word 否 String 查询关键字 tags 否 Array of TagInfo objects 标签列表 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 表5 TagInfo 参数 是否必选 参数类型 描述 key 否 String 标签键 values 否 Array of strings 标签值列表

URI DELETE /v1/{project_id}/acl-rule/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project 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为0b2179bbe180d3762fb0c01a2d5725c7中acl规则id为59ff6bd9-0a76-41ec-9650-380086069965的命中次数 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count { "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ] }

URI DELETE /v1/{project_id}/address-items/{item_id} 表1 路径参数 参数 是否必选 参数类型 描述 item_id 是 String 地址组成员id 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为65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae的地址组成员 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data IdObject object 删除地址组成员id数据 表5 IdObject 参数 参数类型 描述 id String id值 name String 名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

API概览 通过使用CFW提供的接口，您可以完整的使用CFW的所有功能。 类型 说明 防火墙管理 查询防火墙信息接口，包括查询防火墙列表、查询防火墙详细信息、修改防火墙防护状态等。 EIP管理 管理EIP接口，包括开启/关闭EIP、查询EIP个数，查询EIP列表等。 ACL规则管理 ACL规则接口，包括创建、更新、删除ACL规则等接口。 黑白名单管理 管理黑白名单，包括创建、更新、删除黑/白名单等接口。 地址组管理 管理地址组，包括添加、查询、更新地址组等接口。 服务组管理 管理服务组，包括新增、查询、修改服务组等接口。 域名解析及域名组管理 管理域名组，包括添加、查询、更新域名组等接口。 IPS管理 管理IPS特性开关，包括查询IPS状态、IPS开关、查询防护模式等操作。 日志管理 管理日志接口，包括查询访问控制日志、查询攻击事件日志、查询流量日志等接口。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of DnsServersResponseDTO objects dns服务器列表 total Integer dns服务器总数 表5 DnsServersResponseDTO 参数 参数类型 描述 id Integer id is_applied Integer 是否应用，0否 1是 is_customized Integer 是否是用户自定义的dns服务器，0否 1是 server_ip String DNS服务器IP health_check_domain_name String 健康检查域名

URI GET /v1/{project_id}/dns/servers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示个数，范围为1-1024 offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 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。

响应示例 状态码： 200 获取dns服务器响应 { "data" : [ { "health_check_domain_name" : "sslstatic.xiaoyusan.com", "id" : 20165, "is_applied" : 0, "is_customized" : 1, "server_ip" : "0.0.0.0" }, { "health_check_domain_name" : "sslstatic.xiaoyusan.com", "id" : 14190, "is_applied" : 1, "is_customized" : 0, "server_ip" : "100.79.1.240" } ], "total" : 2 }

请求示例 示例为更新一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址类型为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 { "name" : "测试规则", "status" : 1, "action_type" : 0, "description" : "", "source" : { "type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address" : "2.2.2.2" }, "service" : { "type" : 0, "protocol" : 6, "source_port" : "0", "dest_port" : "0" }, "type" : 0, "address_type" : 0, "tag" : { "tag_key" : "", "tag_value" : "" }, "long_connect_enable" : 0, "direction" : 0 }

响应参数 状态码： 200 表13 响应Body参数 参数 参数类型 描述 data RuleId object 规则Id 表14 RuleId 参数 参数类型 描述 id String id name String 名称 状态码： 400 表15 响应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参数 参数 是否必选 参数类型 描述 address_type 否 Integer 地址类型，0 ipv4,1 ipv6 枚举值： 0 1 name 否 String 规则名称 sequence 否 OrderRuleAclDto object UpdateRuleAclDto direction 否 Integer 方向：0表示外到内，1表示内到外【说明：规则type=0：互联网规则 | 2：nat规则时方向值必填】 枚举值： 0 1 action_type 否 Integer 动作0：permit,1：deny 枚举值： 0 1 status 否 Integer 规则下发状态 0：禁用,1：启用 applications 否 Array of strings 应用列表 applicationsJsonString 否 String 应用列表转化为字符串 description 否 String 描述 long_connect_time_hour 否 Long 长连接时长小时 long_connect_time_minute 否 Long 长连接时长分钟 long_connect_time_second 否 Long 长连接时长秒 long_connect_time 否 Long 长连接时长 long_connect_enable 否 Integer 是否支持长连接，0表示不支持，1表示支持 枚举值： 0 1 source 否 RuleAddressDto object 源地址传输对象 destination 否 RuleAddressDto object 目的地址传输对象 service 否 RuleServiceDto object 服务对象 type 否 Integer 规则type，0：互联网规则，1：vpc规则，2：nat规则 枚举值： 0 1 2 tag 否 TagsVO object 标签显示值 表5 OrderRuleAclDto 参数 是否必选 参数类型 描述 dest_rule_id 否 String 目标规则id，添加规则位于此规则之后，非置顶时不能为空，置顶时为空 top 否 Integer 是否置顶，0代表非置顶，1代表置顶 bottom 否 Integer 是否置底，0代表非置底，1代表置底 表6 RuleAddressDto 参数 是否必选 参数类型 描述 type 是 Integer 源类型0手工输入,1关联IP地址组,2域名，3地理位置，4域名组，5多对象，6域名组-DNS解析，7域名组-URL过滤。 address_type 否 Integer 源类型0 ipv4,1 ipv6 address 否 String 源IP，手动类型不能为空，自动及domain类型为空 address_set_id 否 String 关联IP地址组ID，自动类型不能为空，手动类型合domain类型为空 address_set_name 否 String 地址组名称 domain_address_name 否 String 域名地址名称，域名类型时不能为空，手动类型及自动类型时为空 region_list_json 否 String 规则region列表json值 region_list 否 Array of IpRegionDto objects 规则region列表 domain_set_id 否 String 域名组id domain_set_name 否 String 域名组名称 ip_address 否 Array of strings IP地址列表 address_group 否 Array of strings 地址组列表 address_group_names 否 Array of AddressGroupVO objects 地址组名称列表 address_set_type 否 Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 predefined_group 否 Array of strings 预定义地址组列表 表7 IpRegionDto 参数 是否必选 参数类型 描述 region_id 否 String 区域id description_cn 否 String 中文描述 description_en 否 String 英文描述 region_type 否 Integer 区域类型，0表示国家，1表示省份，2表示大洲 表8 AddressGroupVO 参数 是否必选 参数类型 描述 address_set_type 否 Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 name 否 String 地址组名称 set_id 否 String 地址组id 表9 RuleServiceDto 参数 是否必选 参数类型 描述 type 是 Integer 服务输入类型，0为手动输入类型，1为自动输入类型 protocol 否 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 protocols 否 Array of integers 协议列表，协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 source_port 否 String 源端口 dest_port 否 String 目的端口 service_set_id 否 String 服务组id，手动类型为空，自动类型为非空 service_set_name 否 String 服务组名称 custom_service 否 Array of ServiceItem objects 自定义服务 predefined_group 否 Array of strings 预定义服务组列表 service_group 否 Array of strings 服务组列表 service_group_names 否 Array of ServiceGroupVO objects 服务组名称列表 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 表10 ServiceItem 参数 是否必选 参数类型 描述 protocol 否 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 source_port 否 String 源端口 dest_port 否 String 目的端口 description 否 String 服务成员描述 name 否 String 服务成员名称 表11 ServiceGroupVO 参数 是否必选 参数类型 描述 name 否 String 服务组名称 protocols 否 Array of integers 协议列表 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 set_id 否 String 服务组ID 表12 TagsVO 参数 是否必选 参数类型 描述 tag_id 否 String 标签id tag_key 否 String 标签键 tag_value 否 String 标签值