华为云用户手册

  • 响应参数 表2 响应参数 参数名称 类型 说明 peerings Array of peering objects peering对象列表,参见表3。 peerings_links Array of peerings_link objects peerings_link对象列表,参见表5。 只有在使用limit过滤,并且资源个数超过limit或者资源个数超过2000时(limit默认值),该参数的rel和href取值才会显示为next和其对应的link。 表3 peering对象 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位: PENDING_ACCEPTANCE:等待接受 REJECTED:已拒绝。 EXPIRED:已过期。 DELETED:已删除。 ACTIVE:活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息,请参见表4。 accept_vpc_info vpc_info object 对等连接接受端vpc信息,请参见表4。 description String 对等连接描述 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表4 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id 表5 peerings_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系
  • 响应示例 { "name": "test", "description": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "059a737356594b41b447b557bf0aae56" }, "status": "ACTIVE"}
  • 响应参数 表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
  • 响应示例 { "name": "test", "description": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "status": "REJECTED"}
  • 响应参数 表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
  • 响应参数 表4 响应参数 参数名称 类型 说明 peering peering object peering对象,请参见表5。 表5 peering对象 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位: PENDING_ACCEPTANCE:等待接受 REJECTED:已拒绝。 EXPIRED:已过期。 DELETED:已删除。 ACTIVE:活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息,请参见表6。 accept_vpc_info vpc_info object 对等连接接受端vpc信息,请参见表6。 description String 对等连接描述 created_at String 资源创建时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间,UTC时间 格式:yyyy-MM-ddTHH:mm:ss 表6 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id
  • 响应示例 { "peering": { "name": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "status": "ACTIVE" }}
  • 请求示例 创建一个对等连接,请求方vpc id为9daeac7c-a98f-430f-8e38-67f9c044e299,接收方vpc id为f583c072-0bb8-4e19-afb2-afb7c1693be5,命名为test。 POST https://{Endpoint}/v2.0/vpc/peerings { "peering": { "name": "test", "description": "test", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5" } } }
  • 端口 权限 对应API接口 授权项(Action) IAM 项目(Project) 企业项目(Enterprise Project) 查询端口 GET /v1/{project_id}/ports vpc:ports:get √ √ 查询端口详情 GET /v1/{project_id}/ports/{port_id} vpc:ports:get √ √ 更新端口 PUT /v1/{project_id}/ports/{port_id} vpc:ports:update √ √ 删除端口 DELETE /v1/{project_id}/ports/{port_id} vpc:ports:delete √ √ 创建端口 POST / v1/{project_id}/ports vpc:ports:create √ √ 父主题: 权限和授权项
  • 响应参数 状态码为 400 时: 表2 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 401 时: 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 403 时: 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 404 时: 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 409 时: 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 500 时: 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
  • 操作步骤 创建IPv6虚拟IP。 发送“POST https://VPC的Endpoint/v2.0/ports”。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,其中vip所在子网需与E CS 同子网,subnet_id需要指定为IPv6的subnets对应ID。 { "port":{ "network_id":"b0ad9b80-bb16-4550-8ce0-514f949e35ee", "device_owner":"neutron:VIP_PORT", "name":"ipv6_vip_port_test", "fixed_ips":[ { "subnet_id":"33ce2628-6246-4e3a-859f-99cd753ff704" } ] }} 查看请求响应结果。 请求成功时,响应参数如下: { "port": { "id": "d92cfee7-9ebe-4483-85c1-00ffb1e45cd8", "name": "ipv6_vip_port_test", "status": "DOWN", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "33ce2628-6246-4e3a-859f-99cd753ff704", "ip_address": "2001:db8:a583:21d:2e25:9403:6f3d:4664" } ], "mac_address": "fa:16:3e:99:2e:92", "network_id": "b0ad9b80-bb16-4550-8ce0-514f949e35ee", "tenant_id": "060576782980d5762f9ec014dd2f1148", "project_id": "060576782980d5762f9ec014dd2f1148", "device_id": "", "device_owner": "neutron:VIP_PORT", "security_groups": [], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "created_at": "2020-12-15T03:01:07", "updated_at": "2020-12-15T03:01:07" }} 请求异常时,错误码请参见错误码。 通过云服务器的ID查询网卡信息,fixed_ips中存在IPv4地址和IPv6地址。 发送“GET https://VPC的Endpoint/v2.0/ports?device_id={ecs_id}&network_id={network_id}” 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,响应参数如下: { "ports": [{ "id": "47b4cd46-cfe5-415d-957f-5068189dce94", "name": "", "status": "ACTIVE", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "0dd17989-1c23-4501-8dc1-40e4085f793f", "ip_address": "172.16.0.191" }, { "subnet_id": "33ce2628-6246-4e3a-859f-99cd753ff704", "ip_address": "2001:db8:a583:21d:dfc0:d452:e9ab:65cf" } ], "mac_address": "fa:16:3e:1e:f7:9a", "network_id": "b0ad9b80-bb16-4550-8ce0-514f949e35ee", "tenant_id": "060576782980d5762f9ec014dd2f1148", "project_id": "060576782980d5762f9ec014dd2f1148", "device_id": "ab7ca781-66bf-48a8-814b-1568cb393a38", "device_owner": "compute:xxx", "security_groups": [ "0552091e-b83a-49dd-88a7-4a5c86fd9ec3" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": { "primary_interface": true }, "binding:profile": {}, "port_security_enabled": true, "dns_assignment": [ { "hostname": "ip-172-16-0-191", "ip_address": "172.16.0.191", "fqdn": "ip-172-16-0-191.br-iaas-odin1.compute.internal." } ], "dns_name": "ip-172-16-0-191", "created_at": "2020-11-19T13:32:37", "updated_at": "2020-11-19T13:33:50" }] } 请求异常时,错误码请参见错误码。 将云服务器与虚拟IP绑定。 发送“PUT https://VPC的Endpoint/v2.0/ports/{port_id}”。port_id为上面创建的IPv6虚拟IP对应的port_id。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下,ip_address为2查询出的云服务器的网卡的IPv6 ip。 { "port": { "allowed_address_pairs": [{ "ip_address": "2001:db8:a583:21d:dfc0:d452:e9ab:65cf" }] } } 查看请求响应结果。 请求成功时,响应参数如下: { "port": { "id": "d92cfee7-9ebe-4483-85c1-00ffb1e45cd8", "name": "ipv6_vip_port_test", "status": "DOWN", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "33ce2628-6246-4e3a-859f-99cd753ff704", "ip_address": "2001:db8:a583:21d:2e25:9403:6f3d:4664" } ], "mac_address": "fa:16:3e:99:2e:92", "network_id": "b0ad9b80-bb16-4550-8ce0-514f949e35ee", "tenant_id": "060576782980d5762f9ec014dd2f1148", "project_id": "060576782980d5762f9ec014dd2f1148", "device_id": "", "device_owner": "neutron:VIP_PORT", "security_groups": [], "extra_dhcp_opts": [], "allowed_address_pairs": [{ "ip_address": "2001:db8:a583:21d:dfc0:d452:e9ab:65cf " }], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "created_at": "2020-12-15T03:01:07", "updated_at": "2020-12-15T03:01:07" }} 请求异常时,错误码请参见错误码。 关闭云服务器网卡的源/目的检查。 发送“PUT https://VPC的Endpoint/v2.0/ports/{port_id}”。port_id为2查询到的网卡ID。 在Request Header中增加“X-Auth-Token”。 在Request Body中传入参数如下:ip_address为1.1.1.1/0查询出的云服务器的网卡ip。 {"port": {"allowed_address_pairs": [{"ip_address": "1.1.1.1/0"}]}} 查看请求响应结果。 请求成功时,响应参数如下: { "port": { "id": "47b4cd46-cfe5-415d-957f-5068189dce94", "name": "", "status": "ACTIVE", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "0dd17989-1c23-4501-8dc1-40e4085f793f", "ip_address": "172.16.0.191" }, { "subnet_id": "33ce2628-6246-4e3a-859f-99cd753ff704", "ip_address": "2001:db8:a583:21d:dfc0:d452:e9ab:65cf" } ], "mac_address": "fa:16:3e:1e:f7:9a", "network_id": "b0ad9b80-bb16-4550-8ce0-514f949e35ee", "tenant_id": "060576782980d5762f9ec014dd2f1148", "project_id": "060576782980d5762f9ec014dd2f1148", "device_id": "ab7ca781-66bf-48a8-814b-1568cb393a38", "device_owner": "compute:xxx", "security_groups": [ "0552091e-b83a-49dd-88a7-4a5c86fd9ec3" ], "extra_dhcp_opts": [], "allowed_address_pairs": [{ "ip_address": "1.1.1.1/0" }], "binding:vnic_type": "normal", "binding:vif_details": { "primary_interface": true }, "binding:profile": {}, "port_security_enabled": true, "dns_assignment": [ { "hostname": "ip-172-16-0-191", "ip_address": "172.16.0.191", "fqdn": "ip-172-16-0-191.br-iaas-odin1.compute.internal." } ], "dns_name": "ip-172-16-0-191", "created_at": "2020-11-19T13:32:37", "updated_at": "2020-11-19T13:33:50" } } 请求异常时,错误码请参见错误码。
  • 请求示例 创建两个私有IP,指定在id为531dec0f-3116-411b-a21b-e612e42349fd的子网中创建,一个ip地址自动分配,一个指定ip地址为192.168.1.17。 POST https://{Endpoint}/v1/{project_id}/privateips{ "privateips": [ { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd" }, { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "ip_address": "192.168.1.17" } ]}
  • 响应参数 表4 响应参数 名称 参数类型 说明 privateips Array of privateip objects 私有IP列表对象,请参见表5。 表5 privateip字段说明 名称 参数类型 说明 status String 功能说明:私有IP的状态 取值范围: ACTIVE:活动的 DOWN:不可用 id String 私有IP标识 subnet_id String 分配IP的子网标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 tenant_id String 项目ID device_owner String 功能说明:私有IP的使用者,空表示未使用 取值范围: network:dhcp DHCP服务IP地址 network:router_interface_distributed 网关IP地址 compute:xxx(xxx对应具体的可用区名称,例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用) 虚拟机网卡IP地址 neutron:VIP_PORT 虚拟IP地址 compute:subeni 辅助弹性网卡IP地址 neutron:LOADBALANCERV2 共享ELB使用的IP地址 neutron:LOADBALANCERV3 独享ELB使用的IP地址 network:endpoint_interface VPC终端节点 使用的IP地址 约束:此处的取值范围只是本服务支持的类型,其他类型未做标注 ip_address String 申请到的私有IP
  • 响应示例 { "privateips": [ { "status": "DOWN", "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.10" }, { "status": "DOWN", "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.17" } ]}
  • 请求参数 表2 请求参数 名称 是否必选 参数类型 说明 privateips 是 Array of privateip objects 私有IP列表对象,请参见表3。 表3 privateip字段说明 名称 是否必选 参数类型 说明 subnet_id 是 String 分配IP的子网标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 ip_address 否 String 功能说明:指定IP地址申请 取值范围:子网网段中的可以使用且未分配的IP地址,不指定时由系统自动分配
  • 响应参数 表2 响应参数 名称 参数类型 说明 privateip privateip object 私有IP对象,请参见表3。 表3 privateip字段说明 名称 参数类型 说明 status String 功能说明:私有IP的状态 取值范围: ACTIVE:活动的 DOWN:不可用 id String 私有IP标识 subnet_id String 分配IP的子网标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 tenant_id String 项目ID device_owner String 功能说明:私有IP的使用者,空表示未使用 取值范围: network:dhcp DHCP服务IP地址 network:router_interface_distributed 网关IP地址 compute:xxx(xxx对应具体的可用区名称,例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用) 虚拟机网卡IP地址 neutron:VIP_PORT 虚拟IP地址 compute:subeni 辅助弹性网卡IP地址 neutron:LOADBALANCERV2 共享ELB使用的IP地址 neutron:LOADBALANCERV3 独享ELB使用的IP地址 network:endpoint_interface VPC终端节点使用的IP地址 约束:此处的取值范围只是本服务支持的类型,其他类型未做标注 ip_address String 申请到的私有IP
  • 响应示例 { "privateip": { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f78", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.11" }}
  • 请求消息 请求参数 表2 请求参数 名称 是否必选 参数类型 说明 port 是 port object 端口对象,请参见表3。 表3 port字段说明 名称 是否必选 参数类型 说明 name 否 String 功能说明:端口名称 取值:默认为空,最大长度不超过255 security_groups 否 Array of strings 安全组的UUID allowed_address_pairs 否 Array of allow_address_pair objects 功能说明:IP/Mac对列表,allow_address_pair参见表4。 约束: IP地址不允许为 “0.0.0.0”。 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关。 为虚拟IP配置后端ECS场景,allowed_address_pairs中配置的IP地址,必须为ECS网卡已有的IP地址,否则可能会导致虚拟IP通信异常。 extra_dhcp_opts 否 Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性),请参见表5。 表4 allow_address_pair对象 名称 参数类型 说明 ip_address String 功能说明:IP地址 约束:不支持0.0.0.0 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 mac_address String MAC地址 表5 extra_dhcp_opt对象 名称 是否必选 参数类型 说明 opt_name 否 String Option名称 opt_value 否 String Option值 请求样例: { "port": { "name": "adc" }}
  • 响应消息 响应参数 表6 响应参数 名称 参数类型 说明 port port object 端口对象,请参见表7。 表7 port字段说明 名称 参数类型 说明 id String 端口唯一标识 name String 功能说明:端口名称 取值:默认为空,最大长度不超过255 network_id String 功能说明:端口所属网络的ID 约束:必须是存在的网络ID admin_state_up Boolean 功能说明:管理状态 约束:只支持true,默认为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"}] 约束:一个端口只支持一个fixed_ip,且不支持更新。 device_id String 功能说明:端口所属设备ID 约束:不支持设置和更新,由系统自动维护 device_owner String 功能说明:设备所属(DHCP/Router/ lb/Nova) 约束:不支持设置和更新,由系统自动维护 tenant_id String 项目ID。 status String 功能说明:端口状态,Hana硬直通虚拟机端口状态总为DOWN 取值范围:ACTIVE、BUILD、DOWN security_groups Array of strings 安全组的UUID(扩展属性) allowed_address_pairs Array of allow_address_pairobjects 功能说明:IP/Mac对列表,allow_address_pair参见表9(扩展属性)。 约束:IP地址不允许为 “0.0.0.0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性),请参见表10 binding:vif_details Object vif的详细信息, "ovs_hybrid_plug": 是否为ovs/bridge混合模式 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功能不生效。 binding:vnic_type String 功能说明:绑定的vNIC类型 取值范围:normal或者direct。normal: 软交换,direct: SRIOV硬直通(不支持) port_security_enabled Boolean 端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效,默认为true 表8 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明:所属子网ID 约束:不支持更新 ip_address String 端口IP地址 表9 allow_address_pair对象 名称 参数类型 说明 ip_address String 功能说明:IP地址 约束:不支持0.0.0.0 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 mac_address String MAC地址 表10 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String Option名称 opt_value String Option值 响应样例: { "port": { "id": "7204e0da-40de-4207-a536-6f59b84f6f0e", "name": "adc", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "689156ca-038f-4478-b265-fd26aa8bbe31", "ip_address": "192.168.0.9" } ], "mac_address": "fa:16:3e:d7:f2:6c", "network_id": "b4152e98-e3af-4e49-bb7f-7766e2b5ec63", "tenant_id": "caa6cf4337ea47fb823b15709ebe8591", "device_id": "", "device_owner": "", "security_groups": [ "59b39002-e79b-4bac-8e27-aa884ab1beb6" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled":true }}
  • 响应消息 响应参数 表6 响应参数 名称 参数类型 说明 port port object 端口对象,请参见表7。 表7 port字段说明 名称 参数类型 说明 id String 端口唯一标识 name String 功能说明:端口名称 取值:默认为空,最大长度不超过255 network_id String 功能说明:端口所属网络的ID 约束:必须是存在的网络ID admin_state_up Boolean 功能说明:管理状态 约束:只支持true,默认为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"}] 约束:一个端口只支持一个fixed_ip,且不支持更新。 device_id String 功能说明:端口所属设备ID 约束:不支持设置和更新,由系统自动维护 device_owner String 功能说明:设备所属(DHCP/Router/ lb/Nova) 约束:不支持设置和更新,由系统自动维护 tenant_id String 项目ID。 status String 功能说明:端口状态,Hana硬直通虚拟机端口状态总为DOWN 取值范围:ACTIVE、BUILD、DOWN security_groups Array of strings 安全组的UUID(扩展属性) allowed_address_pairs Array of allow_address_pairobjects 功能说明:IP/Mac对列表,allow_address_pair参见表9(扩展属性)。 约束:IP地址不允许为 “0.0.0.0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性),请参见表10 binding:vif_details Object vif的详细信息, "ovs_hybrid_plug": 是否为ovs/bridge混合模式 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功能不生效。 binding:vnic_type String 功能说明:绑定的vNIC类型 取值范围:normal或者direct。normal: 软交换,direct: SRIOV硬直通(不支持) port_security_enabled Boolean 端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效,默认为true 表8 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明:所属子网ID 约束:不支持更新 ip_address String 端口IP地址 表9 allow_address_pair对象 名称 参数类型 说明 ip_address String 功能说明:IP地址 约束:不支持0.0.0.0 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 mac_address String MAC地址 表10 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String Option名称 opt_value String Option值 响应样例 { "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" } ], "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", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled":true }}
  • 请求消息 请求参数 表1 请求参数 名称 是否必选 参数类型 说明 port 是 port object 端口对象,请参见表2。 表2 port字段说明 名称 是否必选 参数类型 说明 name 否 String 功能说明:端口名称 取值:默认为空,最大长度不超过255 network_id 是 String 功能说明:端口所属网络的ID 约束:必须是存在的网络ID admin_state_up 否 Boolean 功能说明:管理状态 约束:只支持true,默认为true fixed_ips 否 Array of fixed_ip objects 功能说明:端口IP。请参见表3。 例如:"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}] 约束:一个端口只支持一个fixed_ip,且不支持更新。 tenant_id 否 String 项目ID。 security_groups 否 Array of strings 安全组的UUID,例如:"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"](扩展属性) allowed_address_pairs 否 Array of allow_address_pair objects 功能说明:IP/Mac对列表,allow_address_pair参见表4(扩展属性) 约束:IP地址不允许为 “0.0.0.0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关 extra_dhcp_opts 否 Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性) port_security_enabled 否 Boolean 端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效,默认为true 表3 fixed_ip对象 名称 是否必选 参数类型 说明 subnet_id 否 String 功能说明:所属子网ID 约束:不支持更新 ip_address 否 String 功能说明:端口IP地址 约束:不支持更新 表4 allow_address_pair对象 名称 是否必选 参数类型 说明 ip_address 否 String 功能说明:IP地址 约束:不支持0.0.0.0 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组 如果allowed_address_pairs为“1.1.1.1/0”,表示关闭源目地址检查开关 mac_address 否 String MAC地址 表5 extra_dhcp_opt对象 名称 是否必选 参数类型 说明 opt_name 否 String Option名称 opt_value 否 String Option值 请求样例 POST https://{Endpoint}/v1/ports{ "port": { "fixed_ips": [ { "ip_address": "192.168.0.38", "subnet_id": "06bc2359-d75e-4f96-82f4-313e39c7148c" } ], "network_id": "28a1c93c-9a5e-4a9f-813b-e495bdef7d34", "security_groups": [ "f2c5b3fc-b971-4a86-87b9-032586260e3e" ] }}
  • 路由表 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询路由表列表 GET /v1/{project_id}/routetables vpc:routeTables:list √ √ 查询路由表 GET /v1/{project_id}/routetables/{routetable_id} vpc:routeTables:get √ √ 创建路由表 POST /v1/{project_id}/routetables vpc:routeTables:create √ √ 更新路由表 PUT /v1/{project_id}/routetables/{routetable_id} vpc:routeTables:update √ √ 关联路由表与子网 POST /v1/{project_id}/routetables/{routetable_id}/action vpc:routeTables:associate √ √ 解关联路由表与子网 POST /v1/{project_id}/routetables/{routetable_id}/action vpc:routeTables:associate √ √ 删除路由表 DELETE /v1/{project_id}/routetables/{routetable_id} vpc:routeTables:delete √ √ 父主题: 权限和授权项
  • 网络ACL(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询所有网络ACL规则 GET /v2.0/fwaas/firewall_rules vpc:firewallRules:get √ × 查询特定网络ACL规则 GET /v2.0/fwaas/firewall_rules/{firewall_rule_id} vpc:firewallRules:get √ × 创建网络ACL规则 POST /v2.0/fwaas/firewall_rules vpc:firewallRules:create √ × 更新网络ACL规则 PUT /v2.0/fwaas/firewall_rules/{firewall_rule_id} vpc:firewallRules:update √ × 删除网络ACL规则 DELETE /v2.0/fwaas/firewall_rules/{firewall_rule_id} vpc:firewallRules:delete √ × 查询所有网络ACL策略 GET /v2.0/fwaas/firewall_policies vpc:firewallPolicies:get √ × 查询特定网络ACL策略 GET /v2.0/fwaas/firewall_policies/{firewall_policy_id} vpc:firewallPolicies:get √ × 创建网络ACL策略 POST /v2.0/fwaas/firewall_policies vpc:firewallPolicies:create √ × 更新网络ACL策略 PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id} vpc:firewallPolicies:update √ × 删除网络ACL策略 DELETE /v2.0/fwaas/firewall_policies/{firewall_policy_id} vpc:firewallPolicies:delete √ × 插入网络ACL规则 PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/insert_rule vpc:firewallPolicies:addRule vpc:firewallPolicies:get √ × 移除网络ACL规则 PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/remove_rule vpc:firewallPolicies:removeRule vpc:firewallPolicies:get √ × 查询所有网络ACL组 GET /v2.0/fwaas/firewall_groups vpc:firewallGroups:get √ × 查询特定网络ACL组 GET /v2.0/fwaas/firewall_groups/{firewall_group_id} vpc:firewallGroups:get √ × 创建网络ACL组 POST /v2.0/fwaas/firewall_groups vpc:firewallGroups:create √ × 更新网络ACL组 PUT /v2.0/fwaas/firewall_groups/{firewall_group_id} vpc:firewallGroups:update √ × 删除网络ACL组 DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} vpc:firewallGroups:delete √ × 父主题: 权限和授权项
  • VPC流日志 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建流日志 POST /v1/{project_id}/fl/flow_logs vpc:flowLogs:create √ × 查询流日志列表 GET /v1/{project_id}/fl/flow_logs vpc:flowLogs:get √ × 查询流日志 GET /v1/{project_id}/fl/flow_logs/{flowlog_id} vpc:flowLogs:get √ × 更新流日志 PUT /v1/{project_id}/fl/flow_logs/{flowlog_id} vpc:flowLogs:update √ × 删除流日志 DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id} vpc:flowLogs:delete √ × 父主题: 权限和授权项
  • VPC 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建VPC POST /v1/{project_id}/vpcs vpc:vpcs:create √ √ 查询VPC GET /v1/{project_id}/vpcs/{vpc_id} vpc:vpcs:get √ √ 查询VPC详情(v3) GET /v3/{project_id}/vpc/vpcs/{vpc_id} vpc:vpcs:get √ √ 查询VPC列表 GET /v1/{project_id}/vpcs vpc:vpcs:list √ √ 查询VPC列表(v3) GET /v3/{project_id}/vpc/vpcs vpc:vpcs:list √ √ 更新VPC PUT /v1/{project_id}/vpcs/{vpc_id} vpc:vpcs:update √ √ 添加VPC扩展网段(v3) PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/add-extend-cidr vpc:vpcs:update √ √ 移除VPC扩展网段(v3) PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/remove-extend-cidr vpc:vpcs:update √ √ 删除VPC DELETE /v1/{project_id}/vpcs/{vpc_id} vpc:vpcs:delete √ √ 父主题: 权限和授权项
  • VPC路由 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询VPC路由列表 GET /v2.0/vpc/routes vpc:routes:list √ × 查询VPC路由 GET /v2.0/vpc/routes/{route_id} vpc:routes:get √ × 创建VPC路由 POST /v2.0/vpc/routes vpc:routes:create √ × 删除VPC路由 DELETE /v2.0/vpc/routes/{route_id} vpc:routes:delete √ × 父主题: 权限和授权项
  • VPC标签 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建VPC资源标签 POST /v2.0/{project_id}/vpcs/{vpc_id}/tags vpc:vpcTags:create √ × 查询VPC资源标签 GET /v2.0/{project_id}/vpcs/{vpc_id}/tags vpc:vpcTags:get √ × 删除VPC资源标签 DELETE /v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} vpc:vpcTags:delete √ × 批量创建和删除VPC资源标签 POST /v2.0/{project_id}/vpcs/{vpc_id}/tags/action vpc:vpcTags:create vpc:vpcTags:delete √ × 查询VPC资源实例 POST /v2.0/{project_id}/vpcs/resource_instances/action vpc:vpcTags:get √ × 查询VPC项目标签 GET /v2.0/{project_id}/vpcs/tags vpc:vpcTags:get √ × 父主题: 权限和授权项
  • 路由器(Openstack Neutron API) 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 查询路由器列表 GET /v2.0/routers vpc:routers:get √ × 查询路由器 GET /v2.0/routers/{router_id} vpc:routers:get √ × 创建路由器 POST /v2.0/routers vpc:routers:create √ × 更新路由器 PUT /v2.0/routers/{router_id} vpc:routers:update √ × 删除路由器 DELETE /v2.0/routers/{router_id} vpc:routers:delete √ × 添加路由器接口 PUT /v2.0/routers/{router_id}/add_router_interface vpc:routers:addInterface vpc:routers:get √ × 删除路由器接口 PUT /v2.0/routers/{router_id}/remove_router_interface vpc:routers:removeInterface vpc:routers:get √ × 父主题: 权限和授权项
  • 安全组规则icmp协议名称对应关系表 icmp type port_range_min port_range_max Any NULL NULL Echo 8 0 Echo reply 0 0 Fragment need DF set 3 4 Host redirect 5 1 Host TOS redirect 5 3 Host unreachable 3 1 Information reply 16 0 Information request 15 0 Net redirect 5 0 Net TOS redirect 5 2 Net unreachable 3 0 Parameter problem 12 0 Port unreachable 3 3 Protocol unreachable 3 2 Reassembly timeout 11 1 Source quench 4 0 Source route failed 3 5 Timestamp reply 14 0 Timestamp request 13 0 TTL exceeded 11 0 父主题: 附录
  • 响应参数 状态码为 200 时: 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID sub_network_interfaces Integer 辅助弹性网卡数目 状态码为 400 时: 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 401 时: 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 403 时: 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码为 500 时: 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
共100000条