更新端口 - UpdatePort

功能介绍

更新端口。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

PUT /v1/ports/{port_id}

表1 路径参数
参数	是否必选	参数类型	描述
port_id	是	String	端口ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
port	是	UpdatePortOption object	更新端口对象

表4 UpdatePortOption
参数	是否必选	参数类型	描述
allowed_address_pairs	否	Array of AllowedAddressPair objects	功能说明：IP/Mac对列表约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。如果allowed_address_pairs为“1.1.1.1/0”，表示关闭源目地址检查开关为虚拟IP配置后端边缘实例场景， allowed_address_pairs中配置的IP地址，必须为边缘实例网卡已有的IP地址，否则可能会导致虚拟IP通信异常。被绑定的边缘实例网卡allowed_address_pairs填“1.1.1.1/0”
security_groups	否	Array of strings	安全组列表

表5 AllowedAddressPair
参数	是否必选	参数类型	描述
ip_address	是	String	功能说明：IP地址约束： 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地址

响应参数

状态码：200

表6 响应Body参数
参数	参数类型	描述
port	Port object	端口的字典对象。

表7 Port
参数	参数类型	描述
id	String	端口唯一标识
name	String	端口名称取值：默认为空，最大长度不超过255
status	String	端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN
admin_state_up	Boolean	管理状态约束：只支持true，默认为true
fixed_ips	Array of FixedIp objects	端口IP。约束：一个端口只支持一个fixed_ip，且不支持更新。
mac_address	String	端口MAC地址约束：由系统分配，不支持指定
network_id	String	端口所属网络的ID 约束：必须是存在的网络ID
device_id	String	端口所属设备ID 约束：不支持设置和更新，由系统自动维护
device_owner	String	设备所属（DHCP/Router/ lb/Nova）约束：不支持设置和更新，由系统自动维护
security_groups	Array of strings	安全组的UUID(扩展属性)
extra_dhcp_opts	Array of ExtraDhcpOption objects	DHCP的扩展属性。
allowed_address_pairs	Array of AllowedAddressPair objects	功能说明：IP/Mac对列表。约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关。
site_id	String	站点ID
dns_assignment	Array of DnsAssignment objects	主网卡默认内网域名信息约束：不支持设置和更新，由系统自动维护
dns_name	String	主网卡默认内网DNS名称约束：不支持设置和更新，由系统自动维护
ipv6_bandwidth_id	String	IPv6带宽ID
binding:profile	Object	功能说明：提供用户设置自定义信息(扩展属性)
binding:vif_details	VifDetails object	vif的详细信息。

表8 FixedIp
参数	参数类型	描述
subnet_id	String	所属子网ID
ip_address	String	端口IP地址

表9 ExtraDhcpOption
参数	参数类型	描述
opt_name	String	Option名称
opt_value	String	Option值

**表10** AllowedAddressPair
参数	参数类型	描述
ip_address	String	功能说明：IP地址约束： 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** DnsAssignment
参数	参数类型	描述
fqdn	String	端口内网fqdn
hostname	String	端口hostname
ip_address	String	端口IP地址

**表12** VifDetails
参数	参数类型	描述
primary_interface	Boolean	取值为true，表示是虚拟机的主网卡。

请求示例

更新端口允许访问的IP地址为1.0.0.0

PUT https://{endpoint}/v1/ports/e7715037-0352-430c-9ad5-c0d58fa7cb2c

{
  "port" : {
    "allowed_address_pairs" : [ {
      "ip_address" : "1.0.0.0"
    } ]
  }
}

响应示例

状态码：200

{
  "port" : {
    "id" : "e7715037-0352-430c-9ad5-c0d58fa7cb2c",
    "name" : " ",
    "status" : "DOWN",
    "admin_state_up" : true,
    "fixed_ips" : [ {
      "subnet_id" : "bf4a4f26-346c-444e-be42-c5a2722a43c1",
      "ip_address" : "192.168.1.125"
    } ],
    "mac_address" : "fa:16:3e:f8:00:3e",
    "network_id" : "cec75dbe-8a78-4e38-9b11-1b7dc5b59e18",
    "device_id" : "",
    "device_owner" : "neutron:VIP_PORT",
    "security_groups" : [ ],
    "extra_dhcp_opts" : [ ],
    "allowed_address_pairs" : [ {
      "ip_address" : "1.0.0.0",
      "mac_address" : "fa:16:3e:f8:00:3e"
    } ],
    "site_id" : "",
    "dns_assignment" : [ ],
    "dns_name" : ""
  }
}