華為云計算 云知識 查詢端口ShowPort
查詢端口ShowPort
時間: 2023-09-21 10:50:42
猜你想看：
實時語音識別 云服務(wù)器配置 CDN是什么意思 視頻點播加速 什么是云桌面

 

功能介紹

查詢單個端口

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

GET /v1/{project_id}/ports/{port_id}

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

名稱

是否必選

說明

project_id

是

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

port_id

是

端口唯一標(biāo)識

請求參數(shù)

無

請求示例

GET https://{Endpoint}/v1/{project_id}/ports/d00f9c13-412f-4855-8af3-de5d8c24cd60

響應(yīng)參數(shù)

表2 響應(yīng)參數(shù)

名稱

參數(shù)類型

說明

port

port object

端口對象，請參見表3。
表3 port字段說明

名稱

參數(shù)類型

說明

id

String

端口唯一標(biāo)識

name

String
  • 功能說明：端口名稱
  • 取值：默認為空，最大長度不超過255

network_id

String
  • 功能說明：端口所屬網(wǎng)絡(luò)的ID
  • 約束：必須是存在的網(wǎng)絡(luò)ID
說明：

網(wǎng)絡(luò)ID的獲取方式：

  • 方法1：登錄 虛擬私有云 服務(wù)的控制臺界面，單擊VPC下的子網(wǎng)，進入子網(wǎng)詳情頁面，查找網(wǎng)絡(luò)ID。
  • 方法2：通過虛擬 私有云 服務(wù)的API接口查詢，具體操作可參考查詢子網(wǎng)列表

admin_state_up

Boolean
  • 功能說明：管理狀態(tài)
  • 約束：默認為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"}]，請參見表4 fixed_ip對象
  • 約束：ipv4場景下，一個端口只支持一個fixed_ip，且不支持更新。ipv6場景下，一個端口最多可以支持兩個fixed_ip，且不支持更新。

device_id

String
  • 功能說明：端口所屬設(shè)備ID
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

device_owner

String
  • 功能說明：設(shè)備所屬（DHCP/Router/ lb/Nova）
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

tenant_id

String

項目ID。

status

String
  • 功能說明：端口狀態(tài)，Hana硬直通虛擬機端口狀態(tài)總為DOWN
  • 取值范圍：ACTIVE、BUILD、DOWN

如果allowed_address_pairs回顯值為 云服務(wù)器 網(wǎng)卡IP地址，表示虛擬IP的端口處于綁定狀態(tài)。

security_groups

Array of strings

安全組的UUID(擴展屬性)

allowed_address_pairs

Array of allowed_address_pairs objects
  • 功能說明：IP/Mac對列表。請參見表5 allow_address_pair對象
  • 約束：IP地址不允許為 “0.0.0.0/0”
  • 如果allowed_address_pairs配置地址池較大的CIDR（掩碼小于24位），建議為該port配置一個單獨的安全組。
  • 如果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的擴展Option(擴展屬性)，請參見表6 extra_dhcp_opt對象

binding:vif_details

binding:vif_details object

vif的詳細信息，參見表7

binding:profile

Object
  • 功能說明：提供用戶設(shè)置自定義信息(擴展屬性)

binding:vnic_type

String
  • 功能說明：綁定的vNIC類型
  • 取值范圍：normal或者direct
  • normal: 軟交換direct: SRIOV硬直通（不支持）

dns_assignment

Array of dns_assignment objects
  • 功能說明：主網(wǎng)卡默認內(nèi)網(wǎng)域名信息
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

dns_name

String
  • 功能說明：主網(wǎng)卡默認內(nèi)網(wǎng)DNS名稱
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

instance_id

String
  • 功能說明：端口所屬實例ID，例如RDS實例ID
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

instance_type

String
  • 功能說明：端口所屬實例類型，例如“RDS”
  • 約束：不支持設(shè)置和更新，由系統(tǒng)自動維護

port_security_enabled

Boolean
  • 功能說明：端口安全使能標(biāo)記，如果不使能則安全組和dhcp防欺騙不生效

zone_id

String

端口所屬的可用分區(qū)

enable_efi

Boolean
  • 功能說明：是否使能efi，使能則表示端口支持vRoCE能力，默認為false
表4 fixed_ip對象

名稱

參數(shù)類型

說明

subnet_id

String

功能說明：所屬子網(wǎng)ID

如果您使用管理控制臺，此值即為子網(wǎng)詳情中的“IPv4子網(wǎng)ID”或“IPv6子網(wǎng)ID”參數(shù)值。

約束：不支持更新

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”，表示關(guān)閉源目地址檢查開關(guān)。
  • 被綁定的云服務(wù)器網(wǎng)卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

mac_address

String

MAC地址
表6 extra_dhcp_opt對象

名稱

參數(shù)類型

說明

opt_name

String

DHCP選項名稱，目前僅支持填寫“51”，表示DHCP租約時間。

opt_value

String

DHCP選項的值。

當(dāng)“opt_name”為“51”時，參數(shù)格式為“Xh”，表示DHCP租約時間為X小時。

“X”的取值范圍為1~30000或“-1”，“-1”表示DHCP租約時間無限長。
表7 binding:vif_details對象

名稱

參數(shù)類型

說明

primary_interface

Boolean

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

port_filter

Boolean

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

ovs_hybrid_plug

Boolean

用于通知像nova這樣的API消費者，應(yīng)該使用OVS的混合插入策略。
表8 dns_assignment對象

名稱

參數(shù)類型

說明

hostname

String

端口hostname

ip_address

String

端口IP地址

fqdn

String

端口內(nèi)網(wǎng)fqdn

響應(yīng)示例

{
    "port": {
        "id": "d00f9c13-412f-4855-8af3-de5d8c24cd60",
        "name": "test",
        "status": "DOWN",
        "admin_state_up": "true",
        "fixed_ips": [
            {
                "subnet_id": "70f2e74b-e660-410a-b754-0ca46744348a",
                "ip_address": "10.128.1.10"
            }
        ],
        "dns_name": "",
        "mac_address": "fa:16:3e:d7:f2:6c",
        "network_id": "5b808927-13c9-4e60-a4f4-ed6ffe225167",
        "tenant_id": "43f2d1cca56a40729dcb17212482f34d",
        "device_id": "",
        "device_owner": "",
        "security_groups": [
            "02b4e8ee-74fa-4a31-802e-5490df11245e"
        ],
        "extra_dhcp_opts": [],
        "allowed_address_pairs": [],
        "binding:vnic_type": "normal",
        "instance_type": "RDS",
        "instance_id": "03a4e9ee-64eb-4a31-802e-5490df22146c",
        "enable_efi": false
    }
}

狀態(tài)碼

請參見狀態(tài)碼。

錯誤碼

請參考錯誤碼。

 

查詢端口ShowPort

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會繼續(xù)努力做到更好 反饋提交失敗！請稍后重試！