创建端口
功能介绍
创建端口。
URI
POST /v2.0/ports
请求参数
|
属性 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
name |
否 |
String |
端口的名称 |
|
network_id |
是 |
String |
|
|
admin_state_up |
否 |
Boolean |
管理状态 【使用说明】默认为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_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] |
|
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参见表4 【使用说明】
|
|
extra_dhcp_opts |
否 |
Array of extra_dhcp_opt objects |
扩展属性：DHCP的扩展Option，参见表5 |
|
binding:profile |
否 |
Object |
扩展属性：提供用户设置自定义信息 【使用说明】 |
|
binding:vnic_type |
否 |
String |
绑定的vNIC类型 【使用说明】normal: 软交换 |
|
device_owner |
否 |
String |
功能说明：端口设备所属 取值范围：目前只支持指定""和"neutron:VIP_PORT"；neutron:VIP_PORT表示创建的是VIP |
|
属性 |
是否必选 |
类型 |
说明 |
|---|---|---|---|
|
subnet_id |
否 |
String |
所属子网ID 【使用说明】不支持更新 |
|
ip_address |
否 |
String |
端口IP地址 【使用说明】不支持更新 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
ip_address |
是 |
String |
|
|
mac_address |
否 |
String |
MAC地址 |
请求示例
创建端口，所在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"
}
}
响应参数
|
属性 |
类型 |
说明 |
|---|---|---|
|
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 【使用说明】
|
|
extra_dhcp_opts |
Array of extra_dhcp_opt objects |
扩展属性：DHCP的扩展Option，参见表10 |
|
binding:vif_details |
binding:vif_details object |
vif的详细信息，参见表11 |
|
binding:profile |
Object |
扩展属性：提供用户设置自定义信息 【使用说明】 |
|
binding:vnic_type |
String |
绑定的vNIC类型 normal: 软交换 |
|
project_id |
String |
项目ID，请参见获取项目ID。 |
|
created_at |
String |
资源创建时间，UTC时间 格式yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
资源更新时间，UTC时间 格式yyyy-MM-ddTHH:mm:ss |
响应示例
{
"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"
}
}
状态码
请参见状态码。
错误码
请参见错误码。
