更新时间:2024-01-02 GMT+08:00
分享

查询端口详情

功能介绍

根据端口的ID,获取端口的详细信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/ports/{port_id}

表1 路径参数

参数

是否必选

参数类型

描述

port_id

String

端口ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

port

Port object

端口的字典对象。

表4 Port

参数

参数类型

描述

id

String

端口唯一标识

name

String

端口名称

取值:默认为空,最大长度不超过255

status

String

端口状态,Hana硬直通虚拟机端口状态总为DOWN

取值范围:ACTIVE、BUILD、DOWN

admin_state_up

Boolean

管理状态

约束:只支持true,默认为true

fixed_ips

Array of FixedIp objects

端口IP。

约束:一个端口只支持一个fixed_ip,且不支持更新。

mac_address

String

端口MAC地址

约束:由系统分配,不支持指定

network_id

String

端口所属网络的ID

约束:必须是存在的网络ID

device_id

String

端口所属设备ID

约束:不支持设置和更新,由系统自动维护

device_owner

String

设备所属(DHCP/Router/ lb/Nova)

约束:不支持设置和更新,由系统自动维护

security_groups

Array of strings

安全组的UUID(扩展属性)

extra_dhcp_opts

Array of ExtraDhcpOption objects

DHCP的扩展属性。

allowed_address_pairs

Array of AllowedAddressPair objects

  • 功能说明:IP/Mac对列表。

  • 约束: IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”,表示关闭源目地址检查开关。

site_id

String

站点ID

dns_assignment

Array of DnsAssignment objects

主网卡默认内网域名信息

约束:不支持设置和更新,由系统自动维护

dns_name

String

主网卡默认内网DNS名称

约束:不支持设置和更新,由系统自动维护

ipv6_bandwidth_id

String

IPv6带宽ID

binding:profile

Object

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

表5 FixedIp

参数

参数类型

描述

subnet_id

String

所属子网ID

ip_address

String

端口IP地址

表6 ExtraDhcpOption

参数

参数类型

描述

opt_name

String

Option名称

opt_value

String

Option值

表7 AllowedAddressPair

参数

参数类型

描述

ip_address

String

  • 功能说明:IP地址

  • 约束: 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地址

表8 DnsAssignment

参数

参数类型

描述

fqdn

String

端口内网fqdn

hostname

String

端口hostname

ip_address

String

端口IP地址

请求示例

GET https://{endpoint}/v1/ports/e7715037-0352-430c-9ad5-c0d58fa7cb2c

响应示例

状态码: 200

OK

{
  "port" : {
    "id" : "e7715037-0352-430c-9ad5-c0d58fa7cb2c",
    "name" : "",
    "status" : "DOWN",
    "admin_state_up" : true,
    "fixed_ips" : [ {
      "subnet_id" : "bf4a4f26-346c-444e-be42-c5a2722a43c1",
      "ip_address" : "192.168.1.125"
    } ],
    "mac_address" : "fa:16:3e:f8:00:3e",
    "network_id" : "cec75dbe-8a78-4e38-9b11-1b7dc5b59e18",
    "device_id" : "",
    "device_owner" : "neutron:VIP_PORT",
    "security_groups" : [ ],
    "extra_dhcp_opts" : [ ],
    "allowed_address_pairs" : [ ],
    "site_id" : "6813be76-7322-11ea-9ce0-286ed488d287",
    "dns_assignment" : [ ],
    "dns_name" : ""
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

分享:

    相关文档

    相关产品