文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 端口/ 查询端口详情 - ShowPort
更新时间:2025-12-08 GMT+08:00
分享

查询端口详情 - ShowPort

功能介绍

当您的端口创建成功后,您可以通过调用该接口查询单个端口的详细信息,包括端口ID、IP地址、所属云服务实例等。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    vpc:ports:get

    Read

    port *

    • vpc:SubnetId

    • vpc:PortId

    • vpc:VpcId

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

GET /v3/{project_id}/ports/{port_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方式请参见获取项目ID

取值范围

不涉及。

port_id

String

参数解释

端口的资源ID,可以是弹性网卡的资源ID。

取值范围

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

port

Port object

参数解释

查询端口详情的响应体。

取值范围

不涉及。

request_id

String

参数解释

请求ID。

取值范围

不涉及。

表3 Port

参数

参数类型

描述

admin_state_up

Boolean

参数解释

端口的管理状态。

取值范围

true,false,默认值true。

binding:host_id

String

参数解释

端口所在的主机ID。

取值范围

不涉及。

binding:profile

Object

参数解释

端口的用户自定义信息。

取值范围

不涉及。

binding:vif_details

binding:vif_details object

参数解释

VIF的详细信息。

取值范围

不涉及。

binding:vif_type

String

参数解释

端口绑定的虚拟接口类型 (ovs/hw_veb等),扩展属性。

取值范围

  • ovs:表示使用 Open vSwitch(OVS)作为虚拟交换机

  • bridge:表示使用 Linux 内核桥接(bridge)实现虚拟网络

  • hw_veb:表示硬件虚拟以太网桥(Hardware Virtual Ethernet Bridge),通常用于支持 SR-IOV 的硬件网卡

  • vhostuser:表示使用 vhost-user 协议(基于 Unix 域套接字)与外部虚拟交换机通信

  • distributed:表示用于分布式虚拟交换机

  • binding_failed:表示端口绑定失败

  • unbound:表示该端口未绑定到任何网络后端

binding:vnic_type

String

参数解释

绑定的vNIC类型。

取值范围

  • normal: 软交换。

  • direct: SRIOV硬直通(不支持)。

  • baremetal:用于裸金属服务器。

created_at

String

参数解释

端口的创建时间。

取值范围

UTC时间,格式: yyyy-MM-ddTHH:mm:ss。

updated_at

String

参数解释

端口的最近一次更新的时间。

取值范围

UTC时间,格式: yyyy-MM-ddTHH:mm:ss。

description

String

参数解释

端口的描述信息。

取值范围

0-255个字符,不能包含“<”和“>”。

device_id

String

参数解释

端口所属的设备ID。

取值范围

带“-”的标准UUID格式。

device_owner

String

参数解释

端口所属的设备名称。

取值范围

  • network:dhcp, 表示DHCP服务

  • network:router_interface_distributed, 表示子网网关地址

  • compute:xxx, 表示云服务器网卡私有IP地址,其中XXX对应具体的可用区名称,例如compute:aa-bb-cc表示私有IP地址被可用区aa-bb-cc内的云服务器使用

  • neutron:VIP_PORT, 表示虚拟IP地址

  • neutron:LOADBALANCERV2, 表示共享型ELB

  • neutron:LOADBALANCERV3, 表示独享型ELB

  • network:endpoint_interface, 表示VPC终端节点

  • network:nat_gateway, 表示NAT网关

  • network:ucmp, 表示UCMP端口,为企业路由器服务所用

ecs_flavor

String

参数解释

标识此端口所属云服务器的flavor。

取值范围

不涉及。

id

String

参数解释

端口的资源ID。

取值范围

带“-”的标准UUID格式。

instance_id

String

参数解释

端口所属的云服务实例ID,例如RDS实例ID。

取值范围

不涉及。

instance_type

String

参数解释

端口所属的云服务实例类型,例如“RDS”。

取值范围

不涉及。

mac_address

String

参数解释

端口的MAC地址。

取值范围

不涉及

name

String

参数解释

端口的名称。

取值范围

默认为空,最大长度不超过255。

port_security_enabled

Boolean

参数解释

端口的安全使能标记,如果不使能,则安全组和DHCP防欺骗不生效。

取值范围

  • true:使能端口安全。

  • false:未使能端口安全。

private_ips

Array of PrivateIpInfo objects

参数解释

端口的私有IP地址。

取值范围

不涉及。

project_id

String

参数解释

端口所属的项目ID。

取值范围

不涉及。

security_groups

Array of strings

参数解释

端口绑定的安全组列表。

取值范围

不涉及。

status

String

参数解释

端口的状态。

取值范围

  • ACTIVE:端口处于活动状态,可以正常进行网络通信。

  • BUILD:端口正在创建或配置中。

  • DOWN:端口处于非活动状态,不能进行网络通信。Hana 硬直通虚拟机端口状态总为DOWN。

tenant_id

String

参数解释

端口所属的租户ID。

取值范围

不涉及。

virsubnet_id

String

参数解释

端口所在的虚拟子网ID。

取值范围

带“-”的标准UUID格式。

vpc_id

String

参数解释

端口所在的VPC的ID。

取值范围

带“-”的标准UUID格式。

vpc_tenant_id

String

参数解释

端口所在的VPC的租户ID。

取值范围

不涉及。

vtep_ip

String

参数解释

端口的VTEP IP地址,即虚拟隧道端点的 IP 地址。

取值范围

不涉及。

enable_efi

Boolean

参数解释

是否使能efi,使能则表示端口支持vRoCE能力。

取值范围

  • true:使能efi。

  • false:未使能efi。

scope

String

参数解释

端口所在子网的作用域(边缘云场景)。

取值范围

  • center:表示作用域为中心。

  • {publicBorderGroup}:表示作用域为具体的公网边界组。公网边界组限制子网的可用区范围,可关联多个边缘可用区。

zone_id

String

参数解释

端口所属的可用分区的ID。

取值范围

不涉及。

binding:migration_info

Object

参数解释

端口迁移的目的节点信息,包括目的节点的binding:vif_details和binding:vif_type。

取值范围

不涉及。

extra_dhcp_opts

Array of PortExtraDhcpOpt objects

参数解释

DHCP的扩展属性。

取值范围

不涉及。

position_type

String

参数解释

边缘场景端口的位置类型。

取值范围

默认值center。

instance_info

Object

参数解释

端口绑定的实例信息。

取值范围

不涉及。

tags

Array of ResponseTag objects

参数解释

端口的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

取值范围

不涉及。

allowed_address_pairs

Array of AllowedAddressPair objects

参数解释

端口的IP/Mac对列表。

取值范围

  • IP地址不允许为 “0.0.0.0/0”。

  • 如果allowed_address_pairs配置地址池较大的IP网段(掩码小于24位),建议为该端口配置一个单独的安全组。

  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”,表示关闭源目地址检查开关。

  • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

表4 binding:vif_details

参数

参数类型

描述

primary_interface

Boolean

参数解释

表示该网卡是否为云服务器的主网卡。

取值范围

  • true:该网卡是云服务器的主网卡。

  • false:该网卡不是云服务器的主网卡。

port_filter

Boolean

参数解释

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

取值范围

  • true:提供端口过滤特性。

  • false:未提供端口过滤特性。

ovs_hybrid_plug

Boolean

参数解释

是否为ovs/bridge混合模式。

取值范围

  • true:ovs/bridge混合模式。

  • false:非ovs/bridge混合模式。

表5 PrivateIpInfo

参数

参数类型

描述

subnet_cidr_id

String

参数解释

端口所属的子网ID。

取值范围

不涉及。

ip_address

String

参数解释

端口的私有IP地址。

取值范围

不涉及。

表6 PortExtraDhcpOpt

参数

参数类型

描述

opt_name

String

参数解释

DHCP属性名称。在DHCP服务器为客户端分配IP地址时,传递的额外的控制信息或网络配置参数的名称。

取值范围

不涉及。

opt_value

String

参数解释

DHCP属性值。在DHCP服务器为客户端分配IP地址时,传递的额外的控制信息或网络配置参数的值。

取值范围

不涉及。

表7 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、点(.)、冒号(:)、加号(+)、中划线(-)、等号(=)

    • 中文字符

表8 AllowedAddressPair

参数

参数类型

描述

ip_address

String

参数解释

IP地址。

约束限制

如果allowed_address_pairs配置地址池较大的IP网段(掩码小于24位),建议为该网卡配置一个单独的安全组。

取值范围

单个IP地址:例如192.168.21.25。

IP网段:例如192.168.21.0/24。

默认取值

不涉及。

mac_address

String

参数解释

MAC地址。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

查询端口详情,端口ID是99fd0c77-56b4-4bf6-8365-df352e45d5fc。

GET https://{Endpoint}/v3/f5dab68cd75740e68c599e9af5fe0aed/ports/99fd0c77-56b4-4bf6-8365-df352e45d5fc

响应示例

状态码:200

GET操作正常返回,更多状态码请参见状态码

{
  "request_id" : "45c58a32dd0619b9ba6ee29fd1d09fa2",
  "port" : {
    "name" : "port-1",
    "id" : "b48145e3-3d89-4dbc-a2f3-98dfac3fbce5",
    "admin_state_up" : true,
    "status" : "DOWN",
    "project_id" : "11e8dd119c77479db890e266e68c1ecf",
    "device_id" : "",
    "mac_address" : "fa:16:3e:66:d5:93",
    "device_owner" : "",
    "description" : "",
    "vpc_id" : "1e8a8ea6-c641-4461-810c-5851868f98be",
    "zone_id" : "",
    "scope" : "center",
    "position_type" : "center",
    "vtep_ip" : null,
    "created_at" : "2025-11-27T02:19:40",
    "updated_at" : "2025-11-27T02:19:40",
    "port_security_enabled" : true,
    "security_groups" : [ "dc0c44a8-4336-4f6d-a31a-b299ff2f394b" ],
    "allowed_address_pairs" : [ ],
    "extra_dhcp_opts" : [ ],
    "instance_info" : null,
    "instance_id" : "",
    "instance_type" : "",
    "ecs_flavor" : "",
    "enable_efi" : false,
    "efi_protocol" : null,
    "virsubnet_id" : "26c31230-6c2e-4dc3-b423-97ea75abac7c",
    "private_ips" : [ {
      "subnet_cidr_id" : "0ab40e38-edd2-46ff-bfec-d092d417275b",
      "ip_address" : "192.168.23.213"
    } ],
    "vpc_tenant_id" : "11e8dd119c77479db890e266e68c1ecf",
    "tags" : [ ],
    "binding:host_id" : "",
    "binding:vif_type" : "unbound",
    "binding:vnic_type" : "normal",
    "binding:vif_details" : { },
    "binding:profile" : { },
    "binding:migration_info" : { }
  }
}

状态码

状态码

描述

200

GET操作正常返回,更多状态码请参见状态码

错误码

请参见错误码

相关文档