更新时间:2025-01-07 gmt 08:00

更新端口-九游平台

功能介绍

更新端口。

此接口可用于更改ecs的安全组,其中port_id是ecs的网卡id。

调试

您可以在中调试该接口。

uri

put /v1/{project_id}/ports/{port_id}

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

名称

是否必选

说明

port_id

端口的唯一标识。

project_id

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

请求参数

名称

是否必选

参数类型

说明

port

object

端口对象,请参见。

更新操作时至少指定一项属性。

表2 port字段说明

名称

是否必选

参数类型

说明

name

string

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

security_groups

array of strings

  • 扩展属性:安全组的uuid。
  • 约束:不支持更新为空。

allowed_address_pairs

array of objects

  • 功能说明:ip/mac对列表,allow_address_pair参见。
  • 约束:ip地址不允许为 “0.0.0.0/0”。
  • 如果allowed_address_pairs配置地址池较大的cidr(掩码小于24位),建议为该port配置一个单独的安全组。
  • 如果allowed_address_pairs的ip地址为“1.1.1.1/0”,表示关闭源目的地址检查开关。
  • 为虚拟ip配置后端ecs场景,allowed_address_pairs中配置的ip地址,必须为ecs网卡已有的ip地址,否则可能会导致虚拟ip通信异常。
  • 被绑定的云服务器网卡allowed_address_pairs的ip地址填“1.1.1.1/0”。

extra_dhcp_opts

array of objects

dhcp的扩展option(扩展属性),请参见。

表3 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地址。默认使用当前端口的mac地址。

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

请求示例

  • 更新id为7204e0da-40de-4207-a536-6f59b84f6f0e的端口,名称更新为abc。
    put https://{endpoint}/v1/{project_id}/ports/7204e0da-40de-4207-a536-6f59b84f6f0e
     
    {
        "port": {
            "name": "abc"
        }
    }

响应参数

表5 响应参数

名称

参数类型

说明

port

object

端口对象,请参见。

表6 port字段说明

名称

参数类型

说明

id

string

端口唯一标识。

name

string

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

network_id

string

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

网络id的获取方式:

  • 方法1:登录虚拟私有云服务的控制台界面,单击vpc下的子网,进入子网详情页面,查找网络id。
  • 方法2:通过虚拟私有云服务的api接口查询,具体操作可参考查询子网列表

admin_state_up

boolean

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

mac_address

string

  • 功能说明:端口mac地址。
  • 约束:由系统分配,不支持指定。

fixed_ips

array of objects

  • 功能说明:端口ip,请参见。例如:"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]。
  • 约束: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 objects

  • 功能说明:ip/mac对列表,请参见。
  • 约束: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地址,表示虚拟ip的端口处于绑定状态。
  • 被绑定的云服务器网卡allowed_address_pairs的ip地址填“1.1.1.1/0”。

extra_dhcp_opts

array of objects

dhcp的扩展option(扩展属性),请参见。

binding:vif_details

object

vif的详细信息,参见。

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功能不生效。

  • 仅对于“华北-北京二”区域:udp_srvports和tcp_srvports,字段,字符串类型,默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号,表示这些端口的tcp报文和udp报文可支持高并发连接,但是此类报文不受acl和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。
    • 格式:

      {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"}

      端口号之间以空格间隔,最多允许指定的端口号总共为15个,端口号范围是1到65535。

    • 示例:

      {"tcp_srvports": "80 443", "udp_srvports": "53"}

      示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受acl和安全组规则的限制。

binding:vnic_type

string

  • 功能说明:绑定的vnic类型。
  • 取值范围:normal,软交换;direct,sriov硬直通(不支持)。

dns_assignment

array of objects

  • 功能说明:主网卡默认内网域名信息。
  • 约束:不支持设置和更新,由系统自动维护。

dns_name

string

  • 功能说明:主网卡默认内网dns名称。
  • 约束:不支持设置和更新,由系统自动维护。

instance_id

string

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

instance_type

string

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

port_security_enabled

boolean

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

zone_id

string

端口所属的可用分区。

enable_efi

boolean

  • 功能说明:是否使能efi,使能则表示端口支持vroce能力,默认为false。

ipv6_bandwidth_id

string

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

名称

参数类型

说明

subnet_id

string

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

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

  • 约束:不支持更新。

ip_address

string

端口ip地址。

表8 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地址。默认使用本端口的mac地址。

表9 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租约时间无限长。
表10 binding:vif_details对象

名称

参数类型

说明

primary_interface

boolean

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

port_filter

boolean

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

ovs_hybrid_plug

boolean

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

表11 dns_assignment对象

名称

参数类型

说明

hostname

string

端口hostname。

ip_address

string

端口ip地址。

fqdn

string

端口内网fqdn。

响应示例

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

状态码

请参见状态码

错误码

请参考错误码

相关文档

网站地图