华为云计算 云知识 查询端口ShowPort
查询端口ShowPort

 

功能介绍

查询单个端口

调试

您可以在API Explorer中调试该接口。

URI

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

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

项目ID,请参见获取项目ID

port_id

端口唯一标识

请求参数

请求示例

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

响应参数

表2 响应参数

名称

参数类型

说明

port

port object

端口对象,请参见表3。

表3 port字段说明

名称

参数类型

说明

id

String

端口唯一标识

name

String

  • 功能说明:端口名称
  • 取值:默认为空,最大长度不超过255

network_id

String

  • 功能说明:端口所属网络的ID
  • 约束:必须是存在的网络ID
说明:

网络ID的获取方式:

  • 方法1:登录 虚拟私有云 服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
  • 方法2:通过虚拟 私有云 服务的API接口查询,具体操作可参考查询子网列表

admin_state_up

Boolean

  • 功能说明:管理状态
  • 约束:默认为true

mac_address

String

  • 功能说明:端口MAC地址
  • 约束:由系统分配,不支持指定

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

  • 功能说明:端口所属设备ID
  • 约束:不支持设置和更新,由系统自动维护

device_owner

String

  • 功能说明:设备所属(DHCP/Router/ lb/Nova)
  • 约束:不支持设置和更新,由系统自动维护

tenant_id

String

项目ID。

status

String

  • 功能说明:端口状态,Hana硬直通虚拟机端口状态总为DOWN
  • 取值范围:ACTIVE、BUILD、DOWN

如果allowed_address_pairs回显值为 云服务器 网卡IP地址,表示虚拟IP的端口处于绑定状态。

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”,表示关闭源目地址检查开关。
  • 被绑定的云服务器网卡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

  • 功能说明:提供用户设置自定义信息(扩展属性)

binding:vnic_type

String

  • 功能说明:绑定的vNIC类型
  • 取值范围:normal或者direct
  • normal: 软交换direct: SRIOV硬直通(不支持)

dns_assignment

Array of dns_assignment objects

  • 功能说明:主网卡默认内网 域名 信息
  • 约束:不支持设置和更新,由系统自动维护

dns_name

String

  • 功能说明:主网卡默认内网DNS名称
  • 约束:不支持设置和更新,由系统自动维护

instance_id

String

  • 功能说明:端口所属实例ID,例如RDS实例ID
  • 约束:不支持设置和更新,由系统自动维护

instance_type

String

  • 功能说明:端口所属实例类型,例如“RDS”
  • 约束:不支持设置和更新,由系统自动维护

port_security_enabled

Boolean

  • 功能说明:端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效

zone_id

String

端口所属的可用分区

enable_efi

Boolean

  • 功能说明:是否使能efi,使能则表示端口支持vRoCE能力,默认为false
表4 fixed_ip对象

名称

参数类型

说明

subnet_id

String

功能说明:所属子网ID

如果您使用管理控制台,此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。

约束:不支持更新

ip_address

String

端口IP地址

表5 allowed_address_pairs对象

名称

参数类型

说明

ip_address

String

  • 功能说明: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地址

表6 extra_dhcp_opt对象

名称

参数类型

说明

opt_name

String

DHCP选项名称,目前仅支持填写“51”,表示DHCP租约时间。

opt_value

String

DHCP选项的值。

当“opt_name”为“51”时,参数格式为“Xh”,表示DHCP租约时间为X小时。

“X”的取值范围为1~30000或“-1”,“-1”表示DHCP租约时间无限长。

表7 binding:vif_details对象

名称

参数类型

说明

primary_interface

Boolean

取值为true,表示是虚拟机的主网卡。

port_filter

Boolean

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

ovs_hybrid_plug

Boolean

用于通知像nova这样的API消费者,应该使用OVS的混合插入策略。

表8 dns_assignment对象

名称

参数类型

说明

hostname

String

端口hostname

ip_address

String

端口IP地址

fqdn

String

端口内网fqdn

响应示例

{
    "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
    }
}

状态码

请参见状态码

错误码

请参考错误码

 

上一篇:弹性公网IP共享流量包介绍与购买指导 下一篇:删除DeploymentdeleteAppsV1NamespacedDeployment