更新端口 - UpdatePort
功能介绍
更新端口。比如,更新端口所属云服务资源的安全组,以及实现云服务器和虚拟IP的绑定等功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
vpc:ports:update
Write
port *
- vpc:SubnetId
- vpc:PortId
- vpc:VpcId
- g:EnterpriseProjectId
- g:ResourceTag/<tag-key>
- vpc:vips:update
- vpc:vips:delete
-
URI
PUT /v1/{project_id}/ports/{port_id}
请求参数
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| name | 否 | String |
|
| security_groups | 否 | Array of strings |
|
| allowed_address_pairs | 否 | Array of allowed_address_pairs objects |
|
| extra_dhcp_opts | 否 | Array of extra_dhcp_opt objects | DHCP的扩展Option(扩展属性),请参见表4。 |
| 名称 | 是否必选 | 参数类型 | 说明 |
|---|---|---|---|
| ip_address | 是 | String |
|
| mac_address | 否 | String | MAC地址。默认使用当前端口的MAC地址。 |
请求示例
- 更新id为7204e0da-40de-4207-a536-6f59b84f6f0e的端口,名称更新为abc。
PUT https://{Endpoint}/v1/{project_id}/ports/7204e0da-40de-4207-a536-6f59b84f6f0e { "port": { "name": "abc" } }
响应参数
| 名称 | 参数类型 | 说明 |
|---|---|---|
| id | String | 端口唯一标识。 |
| name | String |
|
| network_id | String |
说明: 网络ID的获取方式:
|
| admin_state_up | Boolean |
|
| mac_address | String |
|
| fixed_ips | Array of fixed_ip objects |
|
| device_id | String |
|
| device_owner | String |
|
| tenant_id | String | 项目ID。 |
| status | String |
|
| security_groups | Array of strings | 安全组的UUID(扩展属性)。 |
| allowed_address_pairs | Array of allowed_address_pairs objects |
|
| extra_dhcp_opts | Array of extra_dhcp_opt objects | DHCP的扩展Option(扩展属性),请参见表9。 |
| binding:vif_details | binding:vif_details object | vif的详细信息,参见表10。 |
| binding:profile | Object | 扩展属性:提供用户设置自定义信息。 【使用说明】 |
| binding:vnic_type | String |
|
| dns_assignment | Array of dns_assignment objects |
|
| dns_name | String |
|
| instance_id | String |
|
| instance_type | String |
|
| port_security_enabled | Boolean |
|
| zone_id | String | 端口所属的可用分区。 |
| enable_efi | Boolean |
|
| ipv6_bandwidth_id | String |
|
| 名称 | 参数类型 | 说明 |
|---|---|---|
| ip_address | String |
|
| mac_address | String | MAC地址。默认使用本端口的MAC地址。 |
| 名称 | 参数类型 | 说明 |
|---|---|---|
| opt_name | String | DHCP选项名称,目前仅支持填写“51”,表示IPv4网卡DHCP租约时间;填写“651”,表示IPv6网卡DHCP租约时间。 |
| opt_value | String |
|
| 名称 | 参数类型 | 说明 |
|---|---|---|
| primary_interface | Boolean | 取值为true,表示是虚拟机的主网卡。 |
| port_filter | Boolean | 表示该网络服务提供端口过滤特性,如安全组和反MAC/IP欺骗。 |
| ovs_hybrid_plug | Boolean | 用于通知像nova这样的API消费者,应该使用OVS的混合插入策略。 |
| vlan_id | Integer | 辅助弹性网卡的vlan ID。 |
| parent_id | String | 辅助弹性网卡的宿主网卡ID。 |
| parent_device_id | String | 辅助弹性网卡的宿主网卡所属的设备ID。 |
响应示例
{
"port": {
"id": "7204e0da-40de-4207-a536-6f59b84f6f0e",
"name": "abc",
"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",
"enable_efi": false
}
} 状态码
请参见状态码。
错误码
请参考错误码。