華為云計算 云知識 查詢端口NeutronShowPort
查詢端口NeutronShowPort

 

功能介紹

查詢端口詳情。

調試

您可以在API Explorer中調試該接口。

URI

GET /v2.0/ports/{port_id}

參數(shù)說明請參見表1。

表1 參數(shù)說明

名稱

是否必選

說明

port_id

端口唯一標識

請求參數(shù)

請求示例

GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08

響應參數(shù)

表2 響應參數(shù)

參數(shù)名稱

類型

說明

port

port object

port對象列表,參見表3。

表3 port對象

屬性

類型

說明

id

String

端口的ID,最大長度不超過255

【使用說明】在查詢端口列表時非必選

name

String

端口的名稱

network_id

String

所屬網(wǎng)絡的ID

admin_state_up

Boolean

管理狀態(tài)

【使用說明】默認為true

mac_address

String

端口MAC地址,例如:"mac_address": "fa:16:3e:9e:ff:55"

【使用說明】只支持系統(tǒng)動態(tài)分配,不支持指定

fixed_ips

Array of fixed_ip objects

端口IP,參見表4。例如:"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]

device_id

String

設備ID

【使用說明】不支持設置和更新,由系統(tǒng)自動維護,該字段非空的端口不允許刪除

device_owner

String

設備所屬(DHCP/Router/ Nova等)

【取值范圍】network:dhcp,network:router_interface_distributed,compute:xxx(xxx對應具體的可用區(qū)名稱,例如compute:aa-bb-cc表示是被可用區(qū)aa-bb-cc上的ECS使用),neutron:VIP_PORT

【使用說明】不支持更新,只允許用戶在創(chuàng)建虛擬IP端口時,為虛擬IP端口設置device_owner為neutron:VIP_PORT,當端口的該字段不為空時,僅支持該字段為neutron:VIP_PORT時的端口刪除。

該字段非空的端口不允許刪除。

tenant_id

String

項目ID

status

String

端口狀態(tài),可以為ACTIVE,BUILD,DOWN;

【使用說明】Hana硬直通虛擬機端口狀態(tài)總為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參見表5

【使用說明】

  • IP地址不允許為 “0.0.0.0”
  • 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個單獨的安全組
  • 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關閉源目地址檢查開關。
  • 硬件SDN環(huán)境不支持ip_address屬性配置為CIDR格式
  • 為虛擬IP配置后端ECS場景,allowed_address_pairs中配置的IP地址,必須為ECS網(wǎng)卡已有的IP地址,否則可能會導致虛擬IP通信異常。
  • 被綁定的 云服務器 網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

extra_dhcp_opts

Array of extra_dhcp_opt objects

擴展屬性:DHCP的擴展Option,參見表6

binding:vif_details

binding:vif_details object

vif的詳細信息, 參見表8

binding:profile

binding:profile object

擴展屬性:提供用戶設置自定義信息

【使用說明】

  • internal_elb字段,布爾類型,普通租戶可見。只有在創(chuàng)建內網(wǎng)ELB的虛擬IP的網(wǎng)卡時設置為true。普通租戶沒有權限更改該字段,由系統(tǒng)維護。

    舉例:

    {"internal_elb": true}

  • disable_security_groups字段,布爾類型,普通租戶可見。默認為false高性能通信場景下,允許指定為true普通租戶可見。僅支持創(chuàng)建port和讀取時指定。當前僅支持指定為true,不支持指定為false

    舉例:

    {"disable_security_groups":true },

    當前僅支持指定為true,不支持指定為false,指定為true時,F(xiàn)WaaS功能不生效。

  • 僅對于“華北-北京二”:udp_srvports和tcp_srvports,字段,字符串類型,默認不設置udp_srvports和tcp_srvports字段。允許指定udp_srvports和tcp_srvports字段為端口號,表示這些端口的tcp報文和udp報文可支持高并發(fā)連接,但是此類報文不受ACL和安全組規(guī)則的限制。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報文可支持高并發(fā)連接。入方向目的端口為53的udp報文可支持高并發(fā)連接。但是此類報文不受ACL和安全組規(guī)則的限制。

binding:vnic_type

String

綁定的vNIC類型

normal: 軟交換

port_security_enabled

Boolean

端口安全使能標記,如果不使能則安全組和dhcp防欺騙不生效

dns_assignment

Array of dns_assignment objects

擴展屬性:主網(wǎng)卡默認內網(wǎng)域名信息

【使用說明】不支持設置和更新,由系統(tǒng)自動維護

  • hostname:與端口dns_name一致
  • ip_address:端口ipv4私有地址
  • fqdn:為端口創(chuàng)建默認內網(wǎng)fqdn

dns_name

String

擴展屬性:主網(wǎng)卡默認內網(wǎng)DNS名稱

【使用說明】不支持設置和更新,由系統(tǒng)自動維護,訪問該默認內網(wǎng)域名前,請確保子網(wǎng)使用當前系統(tǒng)提供的DNS

project_id

String

項目ID,請參見獲取項目ID。

created_at

String

資源創(chuàng)建時間,UTC時間

格式y(tǒng)yyy-MM-ddTHH:mm:ss

updated_at

String

資源更新時間,UTC時間

格式y(tǒng)yyy-MM-ddTHH:mm:ss

表4 fixed_ip對象

屬性

類型

說明

subnet_id

String

所屬子網(wǎng)ID

【使用說明】不支持更新

ip_address

String

端口IP地址

【使用說明】不支持更新

表5 allowed_address_pairs對象

名稱

是否必選

參數(shù)類型

說明

ip_address

String

  • 功能說明:IP地址
  • 約束:不支持0.0.0.0/0
  • 如果allowed_address_pairs配置地址池較大的CIDR(掩碼小于24位),建議為該port配置一個單獨的安全組。
  • 如果allowed_address_pairs的IP地址為“1.1.1.1/0”,表示關閉源目地址檢查開關。
  • 被綁定的云服務器網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
  • 如果填寫allowed_address_pairs參數(shù),則ip_address是必選參數(shù)。

mac_address

String

MAC地址

表6 extra_dhcp_opt對象

屬性

類型

說明

opt_name

String

Option名稱

opt_value

String

Option值

表7 dns_assignment對象

名稱

參數(shù)類型

說明

hostname

String

端口hostname

ip_address

String

端口IP地址

fqdn

String

端口內網(wǎng)fqdn

表8 binding:vif_details對象

名稱

參數(shù)類型

說明

primary_interface

Boolean

取值為true,表示是虛擬機的主網(wǎng)卡。

port_filter

Boolean

表示該網(wǎng)絡服務提供端口過濾特性,如安全組和反MAC/IP欺騙。

ovs_hybrid_plug

Boolean

用于通知像nova這樣的API消費者,應該使用OVS的混合插入策略。

響應示例

{
    "port": {
        "id": "791870bd-36a7-4d9b-b015-a78e9b06af08",
        "name": "port-test",
        "status": "DOWN",
        "admin_state_up": true,
        "fixed_ips": [],
        "mac_address": "fa:16:3e:01:e0:b2",
        "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-13T01:43:41",
        "updated_at": "2018-09-13T01:43:41"
    }
}

狀態(tài)碼

請參見狀態(tài)碼

錯誤碼

請參見錯誤碼。