计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

创建端口

更新时间:2024-04-15 GMT+08:00

功能介绍

创建端口,提供虚拟IP、网卡等功能。

URI

POST /v1/{project_id}/ports

参数说明请参见表1
表1 参数说明

名称

是否必选

说明

project_id

项目ID,请参见获取项目ID

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

port

port object

端口对象,请参见表3

表3 port字段说明

名称

是否必选

参数类型

说明

name

String

  • 功能说明:端口名称。
  • 取值范围:默认为空,最大长度不超过255。

network_id

String

  • 功能说明:端口所属网络的ID。
  • 约束:必须是存在的网络ID。

admin_state_up

Boolean

  • 功能说明:管理状态。
  • 约束:默认为true。

device_owner

String

  • 功能说明:端口设备所属。
  • 取值范围:目前只支持指定""和"neutron:VIP_PORT",neutron:VIP_PORT表示创建的是VIP。

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,且不支持更新。

tenant_id

String

项目ID。

security_groups

Array of strings

安全组的UUID,例如:"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"](扩展属性)。

allowed_address_pairs

Array of allowed_address_pairs objects

  • 功能说明:IP/Mac对列表,allowed_address_pair参见表5(扩展属性)。
  • 约束:IP地址不允许为 “0.0.0.0/0”。
  • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。
  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”,表示关闭源目地址检查开关。
  • 如果虚拟IP绑定云服务器资源,
    • 则mac_address可为空或者填写被绑定云服务器网卡的Mac地址。
    • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

extra_dhcp_opts

Array of extra_dhcp_opt objects

DHCP的扩展Option(扩展属性),请参见表6

表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”。
  • 如果填写allowed_address_pairs参数,则ip_address是必选参数。

mac_address

String

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租约时间无限长。

请求示例

  • 创建一个端口,所在network id为28a1c93c-9a5e-4a9f-813b-e495bdef7d34,指定子网id为06bc2359-d75e-4f96-82f4-313e39c7148c,指定IP地址为192.168.0.38,关联安全组f2c5b3fc-b971-4a86-87b9-032586260e3e。
    POST https://{Endpoint}/v1/{project_id}/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"
            ]
        }
    }

响应参数

表7 响应参数

名称

参数类型

说明

port

port object

端口对象,请参见表8

表8 port字段说明

名称

参数类型

说明

id

String

端口唯一标识。

name

String

  • 功能说明:端口名称。
  • 取值范围:默认为空,最大长度不超过255。

network_id

String

  • 功能说明:端口所属网络的ID。
  • 约束:必须是存在的网络ID。

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"}],请参见表9
  • 约束: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上的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

  • 功能说明:端口状态,Hana硬直通虚拟机端口状态总为DOWN。
  • 取值范围:ACTIVE、BUILD、DOWN。

security_groups

Array of strings

安全组的UUID(扩展属性)。

allowed_address_pairs

Array of allowed_address_pairs objects

  • 功能说明:IP/Mac对列表。请参见表10
  • 约束: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(扩展属性),请参见表11

binding:vif_details

binding:vif_details object

vif的详细信息,参见表12

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硬直通(不支持)。

instance_id

String

  • 功能说明:端口所属实例ID,例如RDS实例ID。
  • 约束:不支持设置和更新,由系统自动维护。

instance_type

String

  • 功能说明:端口所属实例类型,例如“RDS”。
  • 约束:不支持设置和更新,由系统自动维护。

port_security_enabled

Boolean

  • 功能说明:端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效。

ipv6_bandwidth_id

String

  • 功能说明:IPv6网卡绑定的共享带宽ID。
  • 约束:只有IPv6网卡绑定了共享带宽,才会显示此参数。
表9 fixed_ip对象

名称

参数类型

说明

subnet_id

String

  • 功能说明:所属子网ID。

    如果您使用管理控制台,此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。

  • 约束:不支持更新。

ip_address

String

端口IP地址。

表10 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地址。

表11 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租约时间无限长。

表12 binding:vif_details对象

名称

参数类型

说明

primary_interface

Boolean

取值为true,表示是虚拟机的主网卡。

port_filter

Boolean

表示该网络服务提供端口过滤特性,如安全组和反MAC/IP欺骗。

ovs_hybrid_plug

Boolean

用于通知像nova这样的API消费者,应该使用OVS的混合插入策略。

响应示例

{
    "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"
    }
}

状态码

请参见状态码

错误码

请参考错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容