Querying Ports

Function

This API is used to query ports.

URI

GET /v1/{project_id}/ports

Example:

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}

Table 1 describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
id	No	String	Specifies the port ID that is used as the filter.
name	No	String	Specifies the port name that is used as the filter. The value can contain up to 255 characters.
admin_state_up	No	Boolean	Specifies the administrative state that is used as the filter. The value can be true or false.
network_id	No	String	Specifies the network ID that is used as the filter.
mac_address	No	String	Specifies the MAC address that is used as the filter.
device_id	No	String	Specifies the device ID that is used as the filter.
device_owner	No	String	Specifies the device owner that is used as the filter. For details about value range, see parameter device_owner in Table 3.
status	No	String	Specifies the status that is used as the filter. The value can be ACTIVE, BUILD, or DOWN.
security_groups	No	Array of strings	Specifies the UUID of the security group that is used as the filter.
marker	No	String	Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit. If parameters marker and limit are not passed, resource records on the first page will be returned. If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned. If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
limit	No	Integer	Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker.
fixed_ips	No	Array of strings	Specifies the port IP address or the ID of the subnet that the port belongs to that is used as the filter. The value can be fixed_ips=ip_address={ip_address} or fixed_ips=subnet_id={subnet_id}. Set {ip_address} to an IP address, for example, 192.168.21.22. Set {subnet_id} to an IPv4 or IPv6 subnet ID, for example, 011fc878-5521-4654-a1ad-f5b0b5820302.
enable_efi	No	Boolean	Whether efi is enabled is used as the filter. The value can be true or false.

Request Parameters

None

Example Request

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

Response Parameters

**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
Parameter	Type	Description
id	String	Specifies the port ID that uniquely identifies the port.
name	String	Specifies the port name. The value can contain up to 255 characters. This parameter is left blank by default.
network_id	String	Specifies the ID of the network that the port belongs to. The network ID must exist.
admin_state_up	Boolean	Specifies the administrative state of the port. The default value is true.
mac_address	String	Specifies the port MAC address. The MAC address is assigned by the system not specified by users.
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 4. In IPv4 scenarios, a port supports only one fixed IP address that cannot be changed. In IPv6 scenarios, a port supports a maximum of two fixed IP addresses that cannot be changed.
device_id	String	Specifies the ID of the device that the port belongs to. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
device_owner	String	Specifies the owner of the device to which the port belongs, which can be a DHCP server, router, load balancer, or Nova. The value can be network:dhcp, network:router_interface_distributed, compute:xxx, neutron:VIP_PORT, neutron:LOADBALANCERV2, neutron:LOADBALANCERV3, network:endpoint_interface, network:nat_gateway, or network:ucmp. (In value compute:xxx, xxx specifies the AZ name, for example, compute:aa-bb-cc indicates that the private IP address is used by an ECS in the aa-bb-cc AZ). This parameter value cannot be updated. You can only set device_owner to neutron:VIP_PORT for a virtual IP address port during port creation. If this parameter is not left blank, the port can only be deleted when this parameter value is neutron:VIP_PORT.
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 allowed_address_pairs objects	Specifies the IP address and MAC address pair. An address pair consists of an IP address and a MAC address. For details, see Table 5. The IP address cannot be 0.0.0.0/0. Configure a dedicated security group for the port if the parameter allowed_address_pairs has a large CIDR block (subnet mask less than 24). If the value of allowed_address_pairs is 1.1.1.1/0, the source/destination check is disabled. Set allowed_address_pairs of the cloud server to 1.1.1.1/0.
extra_dhcp_opts	Array of extra_dhcp_opt objects	Specifies the extended option (extended attribute) of DHCP. For details, see Table 6.
binding:vif_details	binding:vif_details object	For details, see Table 7.
binding:profile	Object	Specifies the user-defined settings. This is an extended attribute. Note: The internal_elb field is in boolean type and is available to common tenants. Set the value of this parameter to true only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. Example: {"internal_elb": true} The disable_security_groups field is in boolean type and is available to common tenants. The default value is false. In high-performance communication scenarios, you can set the parameter value to true, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to true. Example: {"disable_security_groups": true } Currently, the value can only be set to true. When the value is set to true, the FWaaS function does not take effect.
binding:vnic_type	String	Specifies the type of the bound vNIC. The value can be normal or direct. normal indicates software switching. direct indicates SR-IOV PCIe passthrough, which is not supported.
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.
ipv6_bandwidth_id	String	Specifies the ID of the shared bandwidth associated with the IPv6 NIC. This parameter is displayed only when the IPv6 NIC is associated with a shared bandwidth.

**Table 4** **fixed_ip** object
Name	Type	Description
subnet_id	String	Specifies the subnet ID. If you use the management console, the value of this parameter is the IPv4 Subnet ID or IPv6 Subnet ID value. You cannot change the parameter value.
ip_address	String	Specifies the port IP address.

**Table 5** **allowed_address_pairs** objects
Name	Type	Description
ip_address	String	Specifies the IP address. You cannot set it to 0.0.0.0/0. Configure a dedicated security group for the port if the parameter allowed_address_pairs has a large CIDR block (subnet mask less than 24). If the value of allowed_address_pairs is 1.1.1.1/0, the source/destination check is disabled. Set allowed_address_pairs of the cloud server to 1.1.1.1/0.
mac_address	String	Specifies the MAC address.

**Table 6** **extra_dhcp_opt** object
Name	Type	Description
opt_name	String	Specifies the name of the DHCP option. The value of this parameter can only be 51, indicating the DHCP lease time.
opt_value	String	Specifies the value of the DHCP option. If the value of opt_name is 51, the value format of opt_value is Xh, indicating that the DHCP lease time is X hours. The value of X is -1 or from 1 to 30000. If the value is -1, the DHCP lease time is infinite.

**Table 7** **binding:vif_details** object
Name	Type	Description
primary_interface	Boolean	If the value is true, this is the primary NIC.
port_filter	Boolean	Specifies the port used for filtering in security groups to protect against MAC or IP spoofing.
ovs_hybrid_plug	Boolean	Specifies that OVS hybrid plug should be used by Nova APIs.

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