查询端口列表

功能介绍

查询端口列表

URI

GET /v1/{project_id}/ports

GET https://{Endpoint}/v1/{project_id}/ports?id={port_id}&name={port_name}&admin_state_up={is_admin_status_up}&network_id={network_id}&mac_address={port_mac}&device_id={port_device_id}&device_owner={device_owner}&status={port_status}&fixed_ips=ip_address={ip_address}&fixed_ips=subnet_id={subnet_id}

请求消息

• 请求参数

  无

• 请求样例

  GET https://{Endpoint}/v1/{project_id}/ports

响应消息

• 响应参数

  表2 响应参数

  名称	参数类型	说明
  ports	Array of port objects	端口列表对象，请参见表3。

  表3 port字段说明

  名称	参数类型	说明
  id	String	端口唯一标识
  name	String	功能说明：端口名称 取值：默认为空，最大长度不超过255
  network_id	String	功能说明：端口所属网络的ID 约束：必须是存在的网络ID
  admin_state_up	Boolean	功能说明：管理状态 约束：只支持true，默认为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"}]，请参见表9 约束：一个端口只支持一个fixed_ip，且不支持更新。
  device_id	String	功能说明：端口所属设备ID 约束：不支持设置和更新，由系统自动维护
  device_owner	String	功能说明：设备所属（DHCP/Router/ lb/Nova） 约束：不支持设置和更新，由系统自动维护
  tenant_id	String	项目ID。
  status	String	功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN
  security_groups	Array of strings	安全组的UUID(扩展属性)
  allowed_address_pairs	Array of allow_address_pair objects	功能说明：IP/Mac对列表。请参见表10 约束：IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  extra_dhcp_opts	Array of extra_dhcp_opt objects	DHCP的扩展Option(扩展属性)，请参见表11
  binding:vif_details	Object	功能说明：vif的详细信息， "ovs_hybrid_plug": 是否为ovs/bridge混合模式
  binding:profile	Object	功能说明：提供用户设置自定义信息(扩展属性)
  binding:vnic_type	String	功能说明：绑定的vNIC类型 取值范围：normal或者direct normal: 软交换direct: SRIOV硬直通（不支持）
  instance_id	String	功能说明：端口所属实例ID，例如RDS实例ID 约束：不支持设置和更新，由系统自动维护
  instance_type	String	功能说明：端口所属实例类型，例如“RDS” 约束：不支持设置和更新，由系统自动维护
  port_security_enabled	Boolean	功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效

  表4 fixed_ip对象

  名称	参数类型	说明
  subnet_id	String	功能说明：所属子网ID 约束：不支持更新
  ip_address	String	端口IP地址

  表5 allow_address_pair对象

  名称	参数类型	说明
  ip_address	String	功能说明：IP地址 约束：不支持0.0.0.0/0 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  mac_address	String	MAC地址

  表6 extra_dhcp_opt对象

  名称	参数类型	说明
  opt_name	String	Option名称
  opt_value	String	Option值

• 响应样例

{
    "ports": [
        {
            "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"
                }
            ],
            "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"
        },
        {
            "id": "28ba8f45-7636-45e4-8c0a-675d7663717c",
            "name": "test1",
            "status": "DOWN",
            "admin_state_up": "true",
            "fixed_ips": [
                {
                    "subnet_id": "061d3ca2-bd1f-4bd1-a01d-7a5155328c0e",
                    "ip_address": "192.168.10.10"
                }
            ],
            "mac_address": "fa:16:3e:3d:91:cd",
            "network_id": "be2fe79a-3ee2-4d87-bd71-5afa78a5670d",
            "tenant_id": "43f2d1cca56a40729dcb17212482f34d",
            "device_id": "",
            "device_owner": "",
            "security_groups": [
                "0bfc8687-ca18-4c37-ac84-d2198baba585"
            ],
            "extra_dhcp_opts": [],
            "allowed_address_pairs": [],
            "binding:vnic_type": "normal"
        }
    ]
}

状态码

请参见状态码。

错误码

请参考错误码。