华为云用户手册

请求示例 添加镜像源6134900d-31a6-4b71-8453-dbca7f26982e到镜像会话e15a6e40-2580-4949-bf2a-55ee7cd49392中。 PUT https://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/e15a6e40-2580-4949-bf2a-55ee7cd49392/add-sources { "traffic_mirror_session" : { "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982e" ] } }

响应示例 状态码： 200 PUT操作正常返回，更多状态码请参见状态码。 { "traffic_mirror_session" : { "name" : "test-session", "created_at" : "2023-02-23T06:57:39.000+00:00", "updated_at" : "2023-02-23T06:57:39.000+00:00", "id" : "e15a6e40-2580-4949-bf2a-55ee7cd49392", "project_id" : "7365fcd452924e398ec4cc1fe39c0d12", "description" : "", "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137", "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ], "traffic_mirror_target_id" : "1adbc9b3-df85-4343-948a-d129536fa309", "traffic_mirror_target_type" : "eni", "virtual_network_id" : 1, "packet_length" : 96, "priority" : 6, "enabled" : true, "type" : "eni" }, "request_id" : "be17b2e9-098c-4b56-ac0c-97e6b6413f12" }

URI PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}/add-sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方式请参见获取项目ID。 traffic_mirror_session_id 是 String 流量镜像会话ID。

请求示例 过滤查询ACL资源实例列表，用tags和matches过滤，限制返回100条数据，从第1条数据开始查询。 https://{{Endpoint}}/v3/{project_id}/firewalls/resource-instances/filter?limit=100&offset=0 { "tags" : [ { "key" : "key1", "values" : [ "value1" ] } ], "matches" : [ { "key" : "resource_name", "value" : "network_aclv3_test" } ] }

响应示例 状态码： 200 请求正常返回 { "resources" : [ { "resource_id" : "55046c0b-f38e-4bc4-988a-06529b34a7db", "resource_detail" : "", "resource_name" : "network_aclv3_test", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }, { "resource_id" : "1828c600-793d-4570-987b-ac59f3ef0734", "resource_detail" : "", "resource_name" : "network_aclv3_test", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key5", "value" : "value5" } ] } ], "request_id" : "2d9cef8c-4e17-40bc-9111-f3fc97b97294", "total_count" : 2 }

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 matches 否 Array of Match objects 功能说明：搜索字段，key为要匹配的字段，value为匹配的值 约束：key为固定字典值，不能包含重复的key或不支持的key，当前key仅支持resource_name tags 否 Array of ListTag objects 包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失 。 Key不能重复，同一个key中values不能重复。 结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 表4 Match 参数 是否必选 参数类型 描述 key 是 String 键。当前仅限定为resource_name 最小长度：1 最大长度：128 value 是 String 值。每个值最大长度255个unicode字符. 最小长度：0 最大长度：255 表5 ListTag 参数 是否必选 参数类型 描述 key 是 String 功能说明：标签键 约束：key不能为空 最小长度：1 最大长度：128 values 是 Array of strings 功能描述：标签值列表。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。 最大长度：255

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 resources Array of ListResourceResp objects 资源列表 total_count Integer 资源数量 request_id String 请求ID 表7 ListResourceResp 参数 参数类型 描述 resource_id String 资源ID resource_detail Object 资源详情。 资源对象，用于扩展。默认为空 resource_name String 资源名称，资源没有名称时默认为空字符串. tags Array of ResourceTag objects 标签列表，没有标签默认为空数组 表8 ResourceTag 参数 参数类型 描述 key String 功能说明：标签键。 约束：同一资源的key值不能重复。 最小长度：1 最大长度：128 value String 功能说明：标签值。 最大长度：255 状态码： 400 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码： 401 表10 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码： 403 表11 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码： 404 表12 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。

URI POST /v3/{project_id}/firewalls/resource-instances/filter 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 功能说明：查询记录数 取值范围：1-1000 约束：默认为1000 缺省值：1000 offset 否 Integer 功能说明：索引位置， 从第一条数据偏移offset条数据后开始查询 约束：默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 缺省值：0

请求示例 在id为afc52ce9-5305-4ec9-9feb-44feb8330341的ACL策略中插入规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1，插入到规则b8243448-cb3c-496e-851c-dadade4c161b后面。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule { "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", "insert_before": "" }

响应参数 表3 响应参数 参数名称 类型 说明 description String 对policy的描述信息 audited Boolean 每次policy或者它相关的rule有变动，该参数将会被置为False firewall_rules Array of strings 与当前policy相关联的rule的ID列表 id String policy ID name String Policy名称 public Boolean 如果为true，该policy对于其他项目网络ACL策略可见， 默认不可见 tenant_id String 项目ID project_id String 项目ID

响应示例 { "description": "", "firewall_rules": [ "b8243448-cb3c-496e-851c-dadade4c161b", "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712" }

请求参数 表2 请求参数 参数名称 类型 必选 说明 firewall_rule_id String 是 网络ACL规则唯一标识 insert_after String 否 insert_after参数表示已经和某个policy关联的rule，新的rule将会直接被插入到insert_after参数指定的rule后面。 如果insert_after和insert_before都被指定了，insert_after参数值将被忽略。 insert_before String 否 insert_before参数表示已经和某个policy关联的rule，新的firewall rule将会直接被插入到insert_ before参数指定的firewall rule前面。 如果insert_after和insert_before都被指定了，insert_after参数值将被忽略。

请求示例 创建地址组，命名为AutoTester746010.580123789，指定ip类型为IPv4，地址集包含：192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。 POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups { "address_group" : { "ip_version" : 4, "name" : "AutoTester746010.580123789", "ip_set" : [ "192.168.3.2", "192.168.3.40", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ], "description" : "test", "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "max_capacity" : 20 } }

响应示例 状态码： 201 POST操作正常返回，更多状态码请参见状态码。 { "address_group" : { "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08", "name" : "AutoTester746010.580123789", "tenant_id" : "b2782e6708b8475c993e6064bc456bf8", "ip_version" : 4, "max_capacity" : 20, "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.40", "192.168.3.2" ], "ip_extra_set" : [ { "ip" : "192.168.5.0/24", "remarks" : null }, { "ip" : "192.168.3.20-192.168.3.100", "remarks" : null }, { "ip" : "192.168.3.40", "remarks" : null }, { "ip" : "192.168.3.2", "remarks" : null } ], "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "created_at" : "2019-06-28T02:06:38.000+00:00", "updated_at" : "2019-06-28T02:06:38.000+00:00", "description" : "test", "status" : "NORMAL", "status_message" : "" }, "request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba" }

请求示例 创建一个子网，所在vpc的id为3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85，命名为subent，设置cidr为192.168.20.0/24，网关IP为192.168.20.1。 POST https://{Endpoint}/v1/{project_id}/subnets { "subnet": { "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "availability_zone": "aa-bb-cc", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ] } }

响应示例 { "subnet": { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "UNKNOWN", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" } }

响应示例 状态码： 200 OK { "traffic_mirror_filter" : { "id" : "59d2b2e7-0d35-41f7-a12e-f7699366cd21", "project_id" : "49a42f378df747bf8b8f6a70e25b63fb", "name" : "test1", "description" : "new_filter", "ingress_rules" : [ ], "egress_rules" : [ ], "created_at" : "2022-08-29T06:22:01.000+00:00", "updated_at" : "2022-08-29T06:22:01.000+00:00" }, "request_id" : "f05abcd9-fa75-43a5-a795-b3d8e8b7a9e9" }

响应示例 { "port": { "id": "d00f9c13-412f-4855-8af3-de5d8c24cd60", "name": "test", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "70f2e74b-e660-410a-b754-0ca46744348a", "ip_address": "10.128.1.10" } ], "dns_name": "", "mac_address": "fa:16:3e:d7:f2:6c", "network_id": "5b808927-13c9-4e60-a4f4-ed6ffe225167", "tenant_id": "43f2d1cca56a40729dcb17212482f34d", "device_id": "", "device_owner": "", "security_groups": [ "02b4e8ee-74fa-4a31-802e-5490df11245e" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "instance_type": "RDS", "instance_id": "03a4e9ee-64eb-4a31-802e-5490df22146c", "enable_efi": false } }

响应参数 表2 响应参数 名称 参数类型 说明 port port object 端口对象，请参见表3。 表3 port字段说明 名称 参数类型 说明 id String 端口唯一标识。 name String 功能说明：端口名称。 取值：默认为空，最大长度不超过255。 network_id String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 admin_state_up Boolean 功能说明：管理状态。 约束：默认为true。 mac_address String 功能说明：端口MAC地址。 约束：由系统分配，不支持指定。 fixed_ips Array of fixed_ip objects 功能说明：端口IP。例如："fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]，请参见表4 fixed_ip对象。 约束：ipv4场景下，一个端口只支持一个fixed_ip，且不支持更新。ipv6场景下，一个端口最多可以支持两个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID。 约束：不支持设置和更新，由系统自动维护。 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova）。 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的E CS 使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp。 使用说明：不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN。 取值范围：ACTIVE、BUILD、DOWN。 如果allowed_address_pairs回显值为云服务器网卡IP地址，表示虚拟IP的端口处于绑定状态。 security_groups Array of strings 安全组的UUID(扩展属性)。 allowed_address_pairs Array of allowed_address_pairs objects 功能说明：IP/Mac对列表。请参见表5 allow_address_pair对象。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表6 extra_dhcp_opt对象。 binding:vif_details binding:vif_details object vif的详细信息，参见表7。 binding:profile Object 扩展属性：提供用户设置自定义信息。 【使用说明】 internal_elb字段，布尔类型，普通租户可见。只有在创建内网ELB的虚拟IP的网卡时设置为true。普通租户没有权限更改该字段，由系统维护。 举例： {"internal_elb": true} disable_security_groups字段，布尔类型，普通租户可见。默认为false高性能通信场景下，允许指定为true普通租户可见。仅支持创建port和读取时指定。当前仅支持指定为true，不支持指定为false。 举例： {"disable_security_groups"：true }， 当前仅支持指定为true，不支持指定为false，指定为true时，FWaaS功能不生效。 仅对于“华北-北京二”区域：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 格式： {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 示例： {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 功能说明：绑定的vNIC类型。 取值范围：normal或者direct。 normal: 软交换direct: SRIOV硬直通（不支持）。 dns_assignment Array of dns_assignment objects 功能说明：主网卡默认内网 域名 信息。 约束：不支持设置和更新，由系统自动维护。 dns_name String 功能说明：主网卡默认内网DNS名称。 约束：不支持设置和更新，由系统自动维护。 instance_id String 功能说明：端口所属实例ID，例如RDS实例ID。 约束：不支持设置和更新，由系统自动维护。 instance_type String 功能说明：端口所属实例类型，例如“RDS”。 约束：不支持设置和更新，由系统自动维护。 port_security_enabled Boolean 功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。 zone_id String 端口所属的可用分区。 enable_efi Boolean 功能说明：是否使能efi，使能则表示端口支持vRoCE能力，默认为false。 ipv6_bandwidth_id String 功能说明：IPv6网卡绑定的共享带宽ID。 约束：只有IPv6网卡绑定了共享带宽，才会显示此参数。 表4 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address String 端口IP地址。 表5 allowed_address_pairs对象 名称 参数类型 说明 ip_address String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 mac_address String MAC地址。默认使用本端口的MAC地址。 表6 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String DHCP选项名称，目前仅支持填写“51”，表示DHCP租约时间。 opt_value String 功能说明：DHCP选项的值。 当“opt_name”为“51”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~30000或“-1”，“-1”表示DHCP租约时间无限长。 表7 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表8 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

响应示例 { "security_group": { "id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "name": "sg-ad3f", "description": "", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "security_group_rules": [ { "id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69", "direction": "ingress", "protocol": null, "ethertype": "IPv4", "description": null, "remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "remote_ip_prefix": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", "direction": "egress", "protocol": null, "ethertype": "IPv4", "description": null, "remote_group_id": null, "remote_ip_prefix": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", "remote_address_group_id": null } ], "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" } }

响应参数 表1 响应参数 参数名称 类型 说明 security_group security_group object security group对象。请参见表2。 表2 Security Group对象 属性 类型 说明 id String 安全组的id 使用说明：查询安全组列表非必选 tenant_id String 项目ID name String 安全组名称 description String 安全组描述 security_group_rules Array of Security Group Rule objects security_group_rule列表，参见表3 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表3 Security Group Rule对象 属性 类型 说明 id String 安全组规则id 使用说明：查询安全组规则非必选 description String 安全组规则描述 security_group_id String 所属安全组id remote_group_id String 所属安全组的对端id direction String 规则方向 remote_ip_prefix String 对端ip网段 protocol String 协议类型或直接指定IP协议号 port_range_max Integer 最大端口，当协议类型为ICMP时，该值表示ICMP的code port_range_min Integer 最小端口，当协议类型为ICMP时，该值表示ICMP的type。 protocol为tcp和udp时，port_range_max和port_range_min必须同时输入，且port_range_max应大于等于port_range_min。 protocol为icmp时，指定ICMP code（port_range_max）时，必须同时指定ICMP type（port_range_min）。 ethertype String 网络类型 支持IPv4，IPv6 tenant_id String 项目ID remote_address_group_id String 功能说明：远端IP地址组ID。 约束：和remote_ip_prefix，remote_group_id功能互斥。 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss

响应示例 状态码： 200 PUT操作正常返回，更多状态码请参见状态码。 { "firewall" : { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_test1", "description" : "network_acl_test1", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "created_at" : "2022-04-07T07:30:46.000+00:00", "updated_at" : "2022-04-07T07:30:46.000+00:00", "admin_state_up" : true, "enterprise_project_id" : "158ad39a-dab7-45a3-9b5a-2836b3cf93f9", "status" : "ACTIVE", "tags" : [ ], "ingress_rules" : [ { "id" : "e9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule test", "description" : "network_acl_rule test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : 4, "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90" } ], "egress_rules" : [ { "id" : "f9a7731d-5bd9-4250-a524-b9a076fd5629", "name" : "network_acl_rule test", "description" : "network_acl_rule test", "action" : "allow", "project_id" : "9476ea5a8a9849c38358e43c0c3a9e12", "protocol" : "tcp", "ip_version" : 4, "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90" } ], "associations" : [ { "virsubnet_id" : "8359e5b0-353f-4ef3-a071-98e67a34a143" } ] } }

请求示例 插入一条入方向规则到id为e9a7731d-5bd9-4250-a524-b9a076fd5629的网络ACL中，插入到规则e9a7731d-5bd9-4250-a524-b9a076fd5630后面。 PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/insert-rules { "firewall" : { "ingress_rules" : [ { "name" : "network_acl_rule test", "description" : "network_acl_rule test", "action" : "allow", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ], "insert_after_rule" : "e9a7731d-5bd9-4250-a524-b9a076fd5630" } } 插入一条出方向规则到id为e9a7731d-5bd9-4250-a524-b9a076fd5629的网络ACL中，插入到规则e9a7731d-5bd9-4250-a524-b9a076fd5630之后。 PUT https://{Endpoint}/v3/{project_id}/vpc/firewalls/e9a7731d-5bd9-4250-a524-b9a076fd5629/insert-rules { "firewall" : { "egress_rules" : [ { "name" : "network_acl_rule test", "description" : "network_acl_rule test", "action" : "allow", "protocol" : "tcp", "ip_version" : "4", "source_ip_address" : "192.168.3.0/24", "destination_ip_address" : "192.168.6.0/24", "source_port" : "30-40,60-90", "destination_port" : "40-60,70-90", "source_address_group_id" : null, "destination_address_group_id" : null } ], "insert_after_rule" : "e9a7731d-5bd9-4250-a524-b9a076fd5630" } }

请求示例 更新id为2be868f2-f7c9-48db-abc0-eea0b9105b0d的辅助弹性网卡，更新关联的安全组列表。 PUT https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces/2be868f2-f7c9-48db-abc0-eea0b9105b0d { "sub_network_interface" : { "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ { "ip_address" : "1.1.1.1/0" } ] } }

响应示例 状态码： 200 PUT操作正常返回，更多状态码请参见状态码。 { "sub_network_interface" : { "id" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193", "private_ip_address" : "10.0.0.225", "mac_address" : "fa:16:3e:48:f8:6f", "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ { "ip_address" : "1.1.1.1/0" } ], "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8", "parent_id" : "637748df-2986-4350-8303-95d259580fb3", "vlan_id" : 2787, "instance_type" : "", "instance_id" : "", "tags" : [ ], "created_at" : "2020-05-19T01:16:25.000+00:00" }, "request_id" : "ceb6273e-1ec9-4168-ac11-3dfeaacfc889" }

请求示例 批量创建3个辅助弹性网卡，虚拟子网id为115b5a84-31dc-4b1e-8de9-bf5a75d2c566，宿主网络接口id为8b6c46f1-c68d-4bba-a922-2d97da185af5，关联安全组6727c950-9f01-47a2-a7aa-7d3686c4c95b。 POST https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces/batch-create { "sub_network_interface" : { "virsubnet_id" : "115b5a84-31dc-4b1e-8de9-bf5a75d2c566", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "parent_id" : "8b6c46f1-c68d-4bba-a922-2d97da185af5" }, "count" : 3 }

响应示例 状态码： 201 POST操作正常返回，更多状态码请参见状态码。 { "sub_network_interfaces" : [ { "id" : "d1f8094c-bb3d-43c5-b625-52dd43eab451", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "115b5a84-31dc-4b1e-8de9-bf5a75d2c566", "private_ip_address" : "192.168.6.245", "ipv6_ip_address" : "2001:db8:a583:5d:11e8:b908:4fe6:9802", "mac_address" : "fa:16:3e:97:1f:f5", "parent_device_id" : "11185aa2-4e08-4d9e-87ed-84817280eaa7", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ ], "description" : "", "parent_id" : "8b6c46f1-c68d-4bba-a922-2d97da185af5", "vlan_id" : 41, "instance_type" : "", "instance_id" : "", "tags" : [ ] }, { "id" : "0dce57ab-00de-443b-a7fe-e8ff68bd95bc", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "115b5a84-31dc-4b1e-8de9-bf5a75d2c566", "private_ip_address" : "192.168.6.75", "ipv6_ip_address" : "2001:db8:a583:5d:6c22:8ea2:c061:a802", "mac_address" : "fa:16:3e:5a:61:84", "parent_device_id" : "11185aa2-4e08-4d9e-87ed-84817280eaa7", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ ], "description" : "", "parent_id" : "8b6c46f1-c68d-4bba-a922-2d97da185af5", "vlan_id" : 42, "instance_type" : "", "instance_id" : "", "tags" : [ ] }, { "id" : "1eca03ee-c0f1-4434-9c4c-87fe4426718c", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "115b5a84-31dc-4b1e-8de9-bf5a75d2c566", "private_ip_address" : "192.168.6.194", "ipv6_ip_address" : "2001:db8:a583:5d:2b45:a3ae:17db:ec02", "mac_address" : "fa:16:3e:b8:ec:6d", "parent_device_id" : "11185aa2-4e08-4d9e-87ed-84817280eaa7", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ ], "description" : "", "parent_id" : "8b6c46f1-c68d-4bba-a922-2d97da185af5", "vlan_id" : 43, "instance_type" : "", "instance_id" : "", "tags" : [ ] } ], "request_id" : "344544c1-d053-4ad3-b673-900a0e01db7e" }

响应示例 { "port": { "id": "a7d98f3c-b42f-460b-96a1-07601e145961", "name": "port-test", "status": "DOWN", "admin_state_up": true, "fixed_ips": [], "mac_address": "fa:16:3e:01:f7:90", "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", "project_id": "db82c9e1415a464ea68048baa8acc6b8", "device_id": "", "device_owner": "", "security_groups": [ "d0d58aa9-cda9-414c-9c52-6c3daf8534e6" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "created_at": "2018-09-20T01:45:26", "updated_at": "2018-09-20T01:45:26" } }

响应参数 表6 响应参数 参数名称 类型 说明 port port object ports信息，参见表7。 表7 port对象 属性 类型 说明 id String 端口的ID，最大长度不超过255 【使用说明】在查询端口列表时非必选 name String 端口的名称 network_id String 所属网络的ID admin_state_up Boolean 管理状态 【使用说明】默认为true mac_address String 端口MAC地址，例如："mac_address": "fa:16:3e:9e:ff:55" 【使用说明】只支持系统动态分配，不支持指定 fixed_ips Array of fixed_ip objects 端口IP，参见表8。例如："fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]， "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] device_id String 设备ID 【使用说明】不支持设置和更新，由系统自动维护，该字段非空的端口不允许删除 device_owner String 设备所属（DHCP/Router/ Nova等） 【取值范围】network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway, network:ucmp 【使用说明】不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 该字段非空的端口不允许删除。 tenant_id String 项目ID status String 端口状态，可以为ACTIVE，BUILD，DOWN； 【使用说明】Hana硬直通虚拟机端口状态总为DOWN security_groups Array of strings 扩展属性：安全组的UUID，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"] 【使用说明】不支持更新为空。 allowed_address_pairs Array of allowed_address_pairs objects 扩展属性：IP/Mac对列表，allow_address_pair参见表9 【使用说明】 IP地址不允许为 “0.0.0.0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关 硬件SDN环境不支持ip_address属性配置为CIDR格式 为虚拟IP配置后端ECS场景，allowed_address_pairs中配置的IP地址，必须为ECS网卡已有的IP地址，否则可能会导致虚拟IP通信异常 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts Array of extra_dhcp_opt objects 扩展属性：DHCP的扩展Option，参见表10 binding:vif_details binding:vif_details object vif的详细信息，参见表11 binding:profile Object 功能说明：扩展属性，提供用户设置自定义信息。 使用说明： internal_elb字段，布尔类型，普通租户可见。只有在创建内网ELB的虚拟IP的网卡时设置为true。普通租户没有权限更改该字段，由系统维护。【举例】 {"internal_elb": true} disable_security_groups字段，布尔类型，普通租户可见。默认为false高性能通信场景下，允许指定为true普通租户可见。仅支持创建port和读取时指定。当前仅支持指定为true，不支持指定为false。 【举例】 {"disable_security_groups"：true } 当前仅支持指定为true，不支持指定为false，指定为true时，FWaaS功能不生效。 仅对于“华北-北京二”：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 【格式】 {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 【示例】 {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 绑定的vNIC类型 normal: 软交换 port_security_enabled Boolean 端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效 dns_assignment Array of dns_assignment objects 扩展属性：主网卡默认内网域名信息 【使用说明】不支持设置和更新，由系统自动维护 hostname：与端口dns_name一致 ip_address：端口ipv4私有地址 fqdn：为端口创建默认内网fqdn dns_name String 扩展属性：主网卡默认内网DNS名称 【使用说明】不支持设置和更新，由系统自动维护，访问该默认内网域名前，请确保子网使用当前系统提供的DNS project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式yyyy-MM-ddTHH:mm:ss 表8 fixed_ip对象 属性 类型 说明 subnet_id String 所属子网ID 【使用说明】不支持更新 ip_address String 端口IP地址 【使用说明】不支持更新 表9 allowed_address_pairs对象 属性 类型 说明 ip_address String IP地址 【使用说明】不支持0.0.0.0 mac_address String MAC地址 表10 extra_dhcp_opt对象 属性 类型 说明 opt_name String Option名称 opt_value String Option值 表11 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表12 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

请求示例 创建端口，所在network id为00ae08c5-f727-49ab-ad4b-b069398aa171，命名为port-test。 POST https://{Endpoint}/v2.0/ports { "port": { "admin_state_up": true, "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", "name": "port-test" } }