华为云用户手册

响应参数 表2 响应参数 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位： PENDING_ACCEPTANCE：等待接受 REJECTED：已拒绝。 EXPIRED：已过期。 DELETED：已删除。 ACTIVE：活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息，请参见表3。 accept_vpc_info vpc_info object 对等连接接受端vpc信息，请参见表3。 description String 对等连接描述 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表3 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id

响应示例 { "firewall_group": { "status": "ACTIVE", "public": false, "egress_firewall_policy_id": null, "name": "bobby_fwg1", "admin_state_up": true, "ports": [ "16e6d779-15e9-48fb-abc5-b86457792a15" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "id": "a504a4cf-9300-40e0-b2d4-649bd157c55a", "ingress_firewall_policy_id": "fed2d88f-d0e7-4cc5-bd7e-c495f67037b6", "description": "test", "project_id": "23c8a121505047b6869edf39f3062712", "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" }}

响应参数 表2 响应参数 参数名称 类型 说明 firewall_group firewall_group object firewall group对象。请参见表3。 表3 Firewall Group对象 属性 类型 说明 id String 网络ACL组的uuid标识。 name String 网络ACL组名称。 description String 网络ACL组描述。 tenant_id String 项目ID ingress_firewall_policy_id String 入方向网络ACL策略。 egress_firewall_policy_id String 出方向网络ACL策略。 ports Array of strings 网络ACL组绑定的端口列表。 public Boolean 是否支持跨租户共享。 status String 网络ACL策略的状态。 取值范围： ACTIVE：正常 INACTIVE：未激活 ERROR：错误 PENDING_CREATE：创建中 PENDING_UPDATE：更新中 PENDING_DELETE：删除中 admin_state_up Boolean 网络ACL的管理状态。 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss

请求示例 在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参数值将被忽略。

请求示例 更新id为2fb0e81f-9f63-44b2-9894-c13a3284594a的ACL策略，关联ACL规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a { "firewall_policy": { "firewall_rules": [ "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ] }}

响应示例 { "firewall_policy": { "description": "", "firewall_rules": [ "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "2fb0e81f-9f63-44b2-9894-c13a3284594a", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712" }}

响应参数 表3 响应参数 参数名称 类型 说明 firewall_policy firewall_policy object firewall policy对象。请参见表4。 表4 Firewall Policy对象 属性 类型 说明 id String 网络ACL策略uuid标识。 name String 网络ACL策略名称。 description String 网络ACL策略描述。 tenant_id String 项目ID firewall_rules Array of strings 策略引用的网络ACL规则链。 audited Boolean 审计标记。 public Boolean 是否支持跨租户共享。 project_id String 项目ID，请参见获取项目ID。

请求参数 表1 请求参数 参数名称 类型 必选 说明 firewall_policy firewall_policy object 是 firewall policy对象。请参见表2。 表2 Firewall Policy对象 属性 是否必选 类型 说明 name 否 String 网络ACL策略名称。 使用说明：最长255个字符 description 否 String 网络ACL策略描述。 使用说明：最长255个字符 firewall_rules 否 Array of strings 策略引用的网络ACL规则链。 audited 否 Boolean 审计标记。 取值范围：true/false

响应示例 { "firewall_policy": { "description": "", "firewall_rules": [ "3c0e6267-73df-4d9a-87a6-e226f2db2036" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "fed2d88f-d0e7-4cc5-bd7e-c495f67037b6", "audited": false, "name": "bobby_fwp1", "project_id": "23c8a121505047b6869edf39f3062712" }}

响应参数 表2 响应参数 参数名称 类型 说明 firewall_policy firewall_policy object firewall policy对象。请参见表3。 表3 Firewall Policy对象 属性 类型 说明 id String 网络ACL策略uuid标识。 name String 网络ACL策略名称。 description String 网络ACL策略描述。 tenant_id String 项目ID firewall_rules Array of strings 策略引用的网络ACL规则链。 audited Boolean 审计标记。 public Boolean 是否支持跨租户共享。 project_id String 项目ID，请参见获取项目ID。

响应参数 表3 响应参数 参数名称 类型 说明 firewall_rule firewall_rule object firewall rule对象。请参见表4。 表4 Firewall Rule对象 属性 类型 说明 id String 网络ACL规则的uuid标识。 name String 网络ACL规则名称。 description String 网络ACL规则描述。 tenant_id String 项目ID public Boolean 是否支持跨租户共享。 protocol String IP协议。 source_port String 源端口号或者一段端口范围。 destination_port String 目的端口号或者一段端口范围。 ip_version Integer IP协议版本。 source_ip_address String 源地址或者CIDR。 destination_ip_address String 目的地址或者CIDR。 action String 对通过网络ACL的流量执行的操作。 enabled Boolean 是否使能网络ACL规则。 project_id String 项目ID，请参见获取项目ID。

请求参数 表1 请求参数 参数名称 类型 必选 说明 firewall_rule firewall_rule object 是 firewall rule对象。请参见表2。 表2 Firewall Rule对象 属性 是否必选 类型 说明 name 否 String 网络ACL规则名称。 使用说明：最长255个字符 description 否 String 网络ACL规则描述。 使用说明：最长255个字符 protocol 否 String IP协议。 取值范围：支持TCP，UDP，ICMP， ICMPV6， 或者0-255 source_port 否 String 源端口号或者一段端口范围。 取值范围：位于[1,65535]中一个整数或者一段端口范围a:b destination_port 否 String 目的端口号或者一段端口范围。 取值范围：位于[1,65535]中一个整数或者一段端口范围a:b ip_version 否 Integer IP协议版本。 取值范围：4、6，分别表示创建ipv4和ipv6。 source_ip_address 否 String 源地址或者CIDR。 destination_ip_address 否 String 目的地址或者CIDR。 action 否 String 对通过网络ACL的流量执行的操作。 取值范围：deny（拒绝）/allow（允许） enabled 否 Boolean 是否使能网络ACL规则。 取值范围：true/false

请求示例 更新id为b94acf06-efc2-485d-ba67-a61acf2a7e28的ACL规则，action更新为deny。 PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28{ "firewall_rule": { "action": "deny" }}

响应示例 { "firewall_rule": { "protocol": "tcp", "description": "", "source_ip_address": null, "destination_ip_address": null, "source_port": null, "destination_port": "80", "id": "b94acf06-efc2-485d-ba67-a61acf2a7e28", "name": "ALLOW_HTTP", "tenant_id": "23c8a121505047b6869edf39f3062712", "enabled": true, "action": "deny", "ip_version": 4, "public": false, "project_id": "23c8a121505047b6869edf39f3062712" }}

响应参数 表3 响应参数 参数名称 类型 说明 firewall_rule firewall_rule object firewall rule对象。请参见表4。 表4 Firewall Rule对象 属性 类型 说明 id String 网络ACL规则的uuid标识。 name String 网络ACL规则名称。 description String 网络ACL规则描述。 tenant_id String 项目ID public Boolean 是否支持跨租户共享。 protocol String IP协议。 source_port String 源端口号或者一段端口范围。 destination_port String 目的端口号或者一段端口范围。 ip_version Integer IP协议版本。 source_ip_address String 源地址或者CIDR。 destination_ip_address String 目的地址或者CIDR。 action String 对通过网络ACL的流量执行的操作。 enabled Boolean 是否使能网络ACL规则。 project_id String 项目ID，请参见获取项目ID。

响应示例 { "firewall_rule": { "protocol": "tcp", "description": "", "source_ip_address": null, "destination_ip_address": null, "source_port": null, "destination_port": "80", "id": "b94acf06-efc2-485d-ba67-a61acf2a7e28", "name": "ALLOW_HTTP", "tenant_id": "23c8a121505047b6869edf39f3062712", "enabled": true, "action": "allow", "ip_version": 4, "public": false, "project_id": "23c8a121505047b6869edf39f3062712" }}

请求参数 表1 请求参数 参数名称 是否必选 类型 说明 firewall_rule 是 firewall_rule object firewall rule对象。请参见表2。 表2 Firewall Rule对象 属性 是否必选 类型 约束 说明 name 否 String 最长255个字符 网络ACL规则名称。 使用说明：最长255个字符 description 否 String 最长255个字符 网络ACL规则描述。 使用说明：最长255个字符 protocol 否 String 支持TCP，UDP，ICMP， ICMPV6 IP协议。 取值范围：支持TCP，UDP，ICMP， ICMPV6 source_port 否 String 位于[1,65535]中一个整数或者一段端口范围a:b 源端口号或者一段端口范围。 取值范围：位于[1,65535]中一个整数或者一段端口范围a:b destination_port 否 String 位于[1,65535]中一个整数或者一段端口范围a:b 目的端口号或者一段端口范围。 取值范围：位于[1,65535]中一个整数或者一段端口范围a:b ip_version 否 Integer 4/6 IP协议版本。 取值范围：4、6，分别表示创建ipv4和ipv6。 source_ip_address 否 String N/A 源地址或者CIDR。 destination_ip_address 否 String N/A 目的地址或者CIDR。 action 否 String deny/allow 对通过网络ACL的流量执行的操作。 取值范围：deny（拒绝）/allow（允许） enabled 否 Boolean true/false 是否使能网络ACL规则。 取值范围：true/false

请求示例 创建ACL规则，action为allow，IP协议为tcp，目的端口为80。 POST https://{Endpoint}/v2.0/fwaas/firewall_rules{ "firewall_rule": { "action": "allow", "enabled": true, "destination_port": "80", "protocol": "tcp", "name": "ALLOW_HTTP" }}

两者区别 子网接口分为VPC子网接口、子网接口两种。两者均可以正常创建、查询、更新、删除子网。 两者的区别及容易混淆的地方在于网络ID、子网ID两个参数的含义。 登录管理控制台，查看子网的基本信息，可以看到网络ID、子网ID两个字段。 图1 子网基本信息 调用VPC子网接口时，使用的子网ID为图1所示的网络ID，例如：a22724a0-b77b-44b4-b731-afd3a4839863。 调用OpenStack neutron子网接口时，使用的子网ID为图1所示的子网ID，例如：f32a3acf-2312-41d0-947c-13d377a35059。

示例 以查询子网详情为例，对比两者之间的区别。 VPC子网接口 GET /v1/049d06b7f20037e12f0dc0137381822f/subnets/a22724a0-b77b-44b4-b731-afd3a4839863 { "subnet": { "id": "a22724a0-b77b-44b4-b731-afd3a4839863", //对应管理控制台上的网络ID "name": "subnet-54eb", "description": "", "cidr": "192.168.0.0/24", "dnsList": [ "100.125.1.202", "100.125.1.230" ], "status": "ACTIVE", "tags": [], "vpc_id": "f4d0ebd4-2a62-4396-980b-96e73b3386de", "ipv6_enable": false, "gateway_ip": "192.168.0.1", "dhcp_enable": true, "primary_dns": "100.125.1.202", "secondary_dns": "100.125.1.230", "availability_zone": "az1.dc1", "neutron_network_id": "a22724a0-b77b-44b4-b731-afd3a4839863", //对应管理控制台上的网络ID "neutron_subnet_id": "f32a3acf-2312-41d0-947c-13d377a35059", //对应管理控制台上的子网ID "extra_dhcp_opts": [] }} OpenStack neutron子网接口 GET /v2.0/subnets/f32a3acf-2312-41d0-947c-13d377a35059 { "subnet": { "name": "subnet-54eb", "cidr": "192.168.0.0/24", "id": "f32a3acf-2312-41d0-947c-13d377a35059", //对应管理控制台上的子网ID "enable_dhcp": true, "network_id": "a22724a0-b77b-44b4-b731-afd3a4839863", //对应管理控制台上的网络ID "tenant_id": "049d06b7f20037e12f0dc0137381822f", "project_id": "049d06b7f20037e12f0dc0137381822f", "dns_nameservers": [ "100.125.1.202", "100.125.1.230" ], "allocation_pools": [ { "start": "192.168.0.2", "end": "192.168.0.252" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "192.168.0.1", "created_at": "2019-04-09T08:03:58", "updated_at": "2019-04-09T08:03:59" }}

请求示例 更新id为99d9d709-8478-4b46-9f3f-2206b1023fd3的vpc，将名称更新为vpc1，描述更新为test1，cidr更新为192.168.0.0/16。 PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3{ "vpc": { "name": "vpc1", "description": "test1", "cidr": "192.168.0.0/16" }}

响应示例 { "vpc": { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc1", "description": "test1", "cidr": "192.168.0.0/16", "status": "OK", "enterprise_project_id": "0", "routes": [], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:25:11", "updated_at": "2022-12-15T06:23:15" }}

响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects tag对象列表，请参见表3。 表3 tag对象 属性 类型 说明 key String 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。

请求参数 表2 请求参数 参数名称 类型 是否必选 说明 tag tag object 是 tag对象，请参见表3。 表3 tag对象 属性 类型 是否必选 说明 key String 是 标签名称。 不能为空。 长度不超过128个字符(当前控制台操作key长度不超过36个字符)。 由英文字母、数字、下划线、中划线、中文字符组成。 同一资源的key值不能重复。 value String 是 标签值。 长度不超过255个字符(当前控制台操作value长度不超过43个字符)。 由英文字母、数字、下划线、点、中划线、中文字符组成。

响应示例 { "routetable": { "id": "05250d7e-0396-4fc9-9c9c-e4d5594784e4", "name": "rtb-vpc-l2cg-1", "routes": [ { "type": "local", "destination": "192.168.4.0/24", "nexthop": "-" }, { "type": "local", "destination": "192.168.1.0/24", "nexthop": "-" }, { "type": "local", "destination": "198.19.128.0/20", "nexthop": "-" }, { "type": "local", "destination": "127.0.0.0/8", "nexthop": "-" }, { "type": "local", "destination": "100.64.0.0/10", "nexthop": "-" } ], "subnets": [ { "id": "0e0faa8f-ea73-47aa-b919-8c133e98d5ac" }, { "id": "e007e005-10aa-4614-b439-c9a14e55130e" } ], "vpc_id": "7978e43c-f892-49d8-9fab-9bb90a51709b", "default": true, "tenant_id": "05e369f07a800f802f41c002632ba5f9", "created_at": "2022-12-15T02:56:40", "updated_at": "2022-12-15T02:56:40" }}

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 功能说明：操作标识 取值范围：delete tags 是 Array of ResourceTag objects 标签列表 表3 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 功能说明：标签键 约束：同一资源的key值不能重复。 最小长度：0 最大长度：36 value 是 String 功能说明：标签值 最小长度：0 最大长度：43

请求示例 example-1：创建资源标签 POST https://{Endpoint}/v2.0/{project_id}/security-groups/{security_group_id}/tags/action{ "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value3" } ]} example-2：删除资源标签 POST https://{Endpoint}/v2.0/{project_id}/security-groups/{security_group_id}/tags/action{ "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value3" } ]}