
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
PUT /v1/{project_id}/ports/{port_id}
參數(shù)說明請參見
表1。
表1 參數(shù)說明
名稱
|
是否必選
|
說明
|
port_id
|
是
|
端口的唯一標(biāo)識(shí)
|
project_id
|
是
|
項(xiàng)目ID,請參見獲取項(xiàng)目ID。
|
請求參數(shù)
名稱
|
是否必選
|
參數(shù)類型
|
說明
|
port
|
是
|
port object
|
端口對象,請參見表2。
|
表2 port字段說明
名稱
|
是否必選
|
參數(shù)類型
|
說明
|
name
|
否
|
String
|
- 功能說明:端口名稱
- 取值:默認(rèn)為空,最大長度不超過255
|
security_groups
|
否
|
Array of strings
|
擴(kuò)展屬性:安全組的UUID
|
allowed_address_pairs
|
否
|
Array of allowed_address_pairs objects
|
- 功能說明:IP/Mac對列表,allow_address_pair參見表3。
- 約束:
- IP地址不允許為 “0.0.0.0/0”
- 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組。
- 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關(guān)閉源目地址檢查開關(guān)。
- 為虛擬IP配置后端ECS場景,allowed_address_pairs中配置的IP地址,必須為ECS網(wǎng)卡已有的IP地址,否則可能會(huì)導(dǎo)致虛擬IP通信異常。
- 被綁定的 云服務(wù)器 網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
|
extra_dhcp_opts
|
否
|
Array of extra_dhcp_opt objects
|
DHCP的擴(kuò)展Option(擴(kuò)展屬性),請參見表4。
|
表3 allowed_address_pairs對象
名稱
|
是否必選
|
參數(shù)類型
|
說明
|
ip_address
|
是
|
String
|
- 功能說明:IP地址
- 約束:不支持0.0.0.0/0
- 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組。
- 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關(guān)閉源目地址檢查開關(guān)。
- 被綁定的云服務(wù)器網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
- 如果填寫allowed_address_pairs參數(shù),則ip_address是必選參數(shù)。
|
mac_address
|
否
|
String
|
MAC地址
|
表4 extra_dhcp_opt對象
名稱
|
是否必選
|
參數(shù)類型
|
說明
|
opt_name
|
否
|
String
|
DHCP選項(xiàng)名稱,目前僅支持填寫“51”,表示DHCP租約時(shí)間。
|
opt_value
|
否
|
String
|
DHCP選項(xiàng)的值。
當(dāng)“opt_name”為“51”時(shí),參數(shù)格式為“Xh”,表示DHCP租約時(shí)間為X小時(shí)。
“X”的取值范圍為1~30000或“-1”,“-1”表示DHCP租約時(shí)間無限長。
|
響應(yīng)參數(shù)
表5 響應(yīng)參數(shù)
名稱
|
參數(shù)類型
|
說明
|
port
|
port object
|
端口對象,請參見表6。
|
表6 port字段說明
名稱
|
參數(shù)類型
|
說明
|
id
|
String
|
端口唯一標(biāo)識(shí)
|
name
|
String
|
- 功能說明:端口名稱
- 取值:默認(rèn)為空,最大長度不超過255
|
network_id
|
String
|
- 功能說明:端口所屬網(wǎng)絡(luò)的ID
- 約束:必須是存在的網(wǎng)絡(luò)ID
說明:
網(wǎng)絡(luò)ID的獲取方式:
- 方法1:登錄 虛擬私有云 服務(wù)的控制臺(tái)界面,單擊VPC下的子網(wǎng),進(jìn)入子網(wǎng)詳情頁面,查找網(wǎng)絡(luò)ID。
- 方法2:通過虛擬 私有云 服務(wù)的API接口查詢,具體操作可參考查詢子網(wǎng)列表
|
admin_state_up
|
Boolean
|
- 功能說明:管理狀態(tài)
- 約束:默認(rèn)為true
|
mac_address
|
String
|
- 功能說明:端口MAC地址
- 約束:由系統(tǒng)分配,不支持指定
|
fixed_ips
|
Array of fixed_ip objects
|
- 功能說明:端口IP。例如:"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}],請參見表7
- 約束:ipv4場景下,一個(gè)端口只支持一個(gè)fixed_ip,且不支持更新。ipv6場景下,一個(gè)端口最多可以支持兩個(gè)fixed_ip,且不支持更新。
|
device_id
|
String
|
- 功能說明:端口所屬設(shè)備ID
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
device_owner
|
String
|
- 功能說明:設(shè)備所屬(DHCP/Router/ lb/Nova)
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
tenant_id
|
String
|
項(xiàng)目ID。
|
status
|
String
|
- 功能說明:端口狀態(tài),Hana硬直通虛擬機(jī)端口狀態(tài)總為DOWN
- 取值范圍:ACTIVE、BUILD、DOWN
如果allowed_address_pairs回顯值為云服務(wù)器網(wǎng)卡IP地址,表示虛擬IP的端口處于綁定狀態(tài)。
|
security_groups
|
Array of strings
|
安全組的UUID(擴(kuò)展屬性)
|
allowed_address_pairs
|
Array of allowed_address_pairs objects
|
- 功能說明:IP/Mac對列表。請參見表8
- 約束:IP地址不允許為 “0.0.0.0/0”
- 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組。
- 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關(guān)閉源目地址檢查開關(guān)。
- 被綁定的云服務(wù)器網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
|
extra_dhcp_opts
|
Array of extra_dhcp_opt objects
|
DHCP的擴(kuò)展Option(擴(kuò)展屬性),請參見表9
|
binding:vif_details
|
binding:vif_details object
|
vif的詳細(xì)信息,參見表10
|
binding:profile
|
Object
|
- 功能說明:提供用戶設(shè)置自定義信息(擴(kuò)展屬性)
|
binding:vnic_type
|
String
|
- 功能說明:綁定的vNIC類型
- 取值范圍:normal或者direct
- normal: 軟交換direct: SRIOV硬直通(不支持)
|
dns_assignment
|
Array of dns_assignment objects
|
- 功能說明:主網(wǎng)卡默認(rèn)內(nèi)網(wǎng)域名信息
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
dns_name
|
String
|
- 功能說明:主網(wǎng)卡默認(rèn)內(nèi)網(wǎng)DNS名稱
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
instance_id
|
String
|
- 功能說明:端口所屬實(shí)例ID,例如RDS實(shí)例ID
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
instance_type
|
String
|
- 功能說明:端口所屬實(shí)例類型,例如“RDS”
- 約束:不支持設(shè)置和更新,由系統(tǒng)自動(dòng)維護(hù)
|
port_security_enabled
|
Boolean
|
- 功能說明:端口安全使能標(biāo)記,如果不使能則安全組和dhcp防欺騙不生效
|
zone_id
|
String
|
端口所屬的可用分區(qū)
|
enable_efi
|
Boolean
|
- 功能說明:是否使能efi,使能則表示端口支持vRoCE能力,默認(rèn)為false
|
表7 fixed_ip對象
名稱
|
參數(shù)類型
|
說明
|
subnet_id
|
String
|
功能說明:所屬子網(wǎng)ID
如果您使用管理控制臺(tái),此值即為子網(wǎng)詳情中的“IPv4子網(wǎng)ID”或“IPv6子網(wǎng)ID”參數(shù)值。
約束:不支持更新
|
ip_address
|
String
|
端口IP地址
|
表8 allowed_address_pairs對象
名稱
|
參數(shù)類型
|
說明
|
ip_address
|
String
|
- 功能說明:IP地址
- 約束:不支持0.0.0.0/0
- 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個(gè)單獨(dú)的安全組。
- 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關(guān)閉源目地址檢查開關(guān)。
- 被綁定的云服務(wù)器網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
|
mac_address
|
String
|
MAC地址
|
表9 extra_dhcp_opt對象
名稱
|
參數(shù)類型
|
說明
|
opt_name
|
String
|
DHCP選項(xiàng)名稱,目前僅支持填寫“51”,表示DHCP租約時(shí)間。
|
opt_value
|
String
|
DHCP選項(xiàng)的值。
當(dāng)“opt_name”為“51”時(shí),參數(shù)格式為“Xh”,表示DHCP租約時(shí)間為X小時(shí)。
“X”的取值范圍為1~30000或“-1”,“-1”表示DHCP租約時(shí)間無限長。
|
表10 binding:vif_details對象
名稱
|
參數(shù)類型
|
說明
|
primary_interface
|
Boolean
|
取值為true,表示是虛擬機(jī)的主網(wǎng)卡。
|
port_filter
|
Boolean
|
表示該網(wǎng)絡(luò)服務(wù)提供端口過濾特性,如安全組和反MAC/IP欺騙。
|
ovs_hybrid_plug
|
Boolean
|
用于通知像nova這樣的API消費(fèi)者,應(yīng)該使用OVS的混合插入策略。
|
表11 dns_assignment對象
名稱
|
參數(shù)類型
|
說明
|
hostname
|
String
|
端口hostname
|
ip_address
|
String
|
端口IP地址
|
fqdn
|
String
|
端口內(nèi)網(wǎng)fqdn
|
響應(yīng)示例
{
"port": {
"id": "7204e0da-40de-4207-a536-6f59b84f6f0e",
"name": "adc",
"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
}
}
