Function

This API is used to query ports.

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}

Request Message

• Request parameter

  None

• Example request

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

Response Message

• Response parameter

  Table 2 Response parameter

  Name	Type	Description
  ports	Array of port objects	Specifies the port objects. For details, see Table 3.

  Table 3 Description of the port field

  Name	Type	Description
  id	String	Specifies the port ID, which uniquely identifies the port.
  name	String	Specifies the port name. The value can contain no more than 255 characters. This parameter is left blank by default.
  network_id	String	Specifies the ID of the network to which the port belongs. The network ID must be a real one in the network environment. NOTE: To obtain the network ID: Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page. Method 2: Call the API for querying subnets. For details, see Querying Subnets.
  admin_state_up	Boolean	Specifies the administrative state of the port. The value can only be true, and the default value is true.
  mac_address	String	Specifies the port MAC address. The system automatically sets this parameter, and you are not allowed to configure the parameter value.
  fixed_ips	Array of fixed_ip objects	Specifies the port IP address. For example, the value is "fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]. For details, see Table 9. A port supports only one fixed IP address that cannot be changed.
  device_id	String	Specifies the ID of the device to which the port belongs. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  device_owner	String	Specifies the belonged device, which can be the DHCP server, router, load balancer, or Nova. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  tenant_id	String	Specifies the project ID.
  status	String	Specifies the port status. The status of a HANA SR-IOV VM port is always DOWN. The value can be ACTIVE, BUILD, or DOWN.
  security_groups	Array of strings	Specifies the security group UUID (extended attribute).
  allowed_address_pairs	Array of allow_address_pair objects	Specifies a set of zero or more allowed address pairs. An address pair consists of an IP address and MAC address. For details, see Table 10. The IP address cannot be 0.0.0.0/0. Configure an independent security group for the port if a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.
  extra_dhcp_opts	Array of extra_dhcp_opt objects	Specifies the extended option (extended attribute) of DHCP. For details, see Table 11.
  binding:vif_details	Object	Specifies the VIF details. Parameter ovs_hybrid_plug specifies whether the OVS/bridge hybrid mode is used.
  binding:profile	Object	Specifies the custom information configured by users. This is an extended attribute.
  binding:vnic_type	String	Specifies the type of the bound vNIC. The value can be normal or direct. Parameter normal indicates software switching. Parameter direct indicates SR-IOV PCIe passthrough, which is not supported.
  dns_assignment	Array of dns_assignment objects	Specifies the default private network domain name information of the primary NIC. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  dns_name	String	Specifies the default private network DNS name of the primary NIC. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  instance_id	String	Specifies the ID of the instance to which the port belongs, for example, RDS instance ID. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  instance_type	String	Specifies the type of the instance to which the port belongs, for example, RDS. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
  port_security_enabled	Boolean	Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect.

  Table 4 fixed_ip object

  Name	Type	Description
  subnet_id	String	Specifies the subnet ID. You cannot change the parameter value.
  ip_address	String	Specifies the port IP address.

  Table 5 allow_address_pair object

  Name	Type	Description
  ip_address	String	Specifies the IP address. You cannot set it to 0.0.0.0/0. Configure an independent security group for the port if a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs.
  mac_address	String	Specifies the MAC address.

  Table 6 extra_dhcp_opt object

  Name	Type	Description
  opt_name	String	Specifies the option name.
  opt_value	String	Specifies the option value.

  Table 7 dns_assignment object

  Name	Type	Description
  hostname	String	Specifies the host name of the port.
  ip_address	String	Specifies the port IP address.
  fqdn	String	Specifies the private network fully qualified domain name (FQDN) of the port.

• Example response

{
    "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"
                }
            ],
            "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"
        },
        {
            "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"
                }
            ],
            "dns_name": "",
            "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"
        }
    ]
}

Status Code

See Status Codes.

Error Code

See Error Codes.