Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda> Virtual Private Cloud> Referencia de la API> API fuera de fecha> Puerto (descartado)> Consulta de puertos (descartados)

Actualización más reciente 2023-02-03 GMT+08:00

Ver PDF

Consulta de puertos (descartados)

Función

Esta API se utiliza para consultar puertos y para mostrarlos en una lista.

URI

GET /v1/ports

Por ejemplo:

GET https://{Endpoint}/v1/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}

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
id	No	String	Especifica que el ID de puerto se utiliza como filtro.
name	No	String	Especifica que el nombre del puerto se utiliza como filtro. El valor no puede contener más de 255 caracteres.
admin_state_up	No	Boolean	Especifica que el estado administrativo se utiliza como filtro.
network_id	No	String	Especifica que el ID de red se utiliza como filtro.
mac_address	No	String	Especifica que la dirección MAC se utiliza como filtro.
device_id	No	String	Especifica que el ID de dispositivo se utiliza como filtro.
device_owner	No	String	Especifica que el propietario del dispositivo se utiliza como filtro.
status	No	String	Especifica que el estado se utiliza como filtro. El valor puede ser ACTIVE, BUILD o DOWN.
marker	No	String	Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza en el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el parámetro limit. Si no se pasan los parámetros marker y limit, se devolverán los registros de recursos de la primera página. Si no se pasa el parámetro marker y el valor del parámetro limit se establece en 10 se devolverán los 10 primeros registros de recursos. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y el valor del parámetro limit se establece en 10, se devolverán los registros de recursos del 11º al 20º. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y no se pasa el parámetro limit, se devolverán los registros de recursos que comienzan desde el 11º registro (incluido el 11º).
limit	No	Integer	Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax (2^31-1). limit se puede utilizar junto con marker. Para obtener más información, consulte la descripción de parámetros de marker.
fixed_ips	No	String	Puede utilizar fixed_ips=ip_address o fixed_ips=subnet_id para filtrar.

Mensaje de solicitud

Parámetro de solicitud
```
None
```
Ejemplo de la solicitud
```
GET https://{Endpoint}/v1/ports
```

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 2** Parámetro de respuesta
Nombre	Tipo	Descripción
ports	Array of port objects	Especifica los objetos del puerto. Para obtener más información, véase Tabla 3.

**Tabla 3** Descripción del campo **port**
Nombre	Tipo	Descripción
id	String	Especifica el ID de puerto, que identifica el puerto de forma exclusiva.
name	String	Especifica el nombre del puerto. El valor no puede contener más de 255 caracteres. Este parámetro se deja en blanco por defecto.
network_id	String	Especifica el ID de la red a la que pertenece el puerto. El ID de red debe ser real en el entorno de red.
admin_state_up	Boolean	Especifica el estado administrativo del puerto. El valor solo puede ser true y el valor predeterminado es true.
mac_address	String	Especifica la dirección de MAC del puerto. El sistema establece automáticamente este parámetro y no se le permite configurar el valor del parámetro.
fixed_ips	Array of fixed_ip objects	Especifica la dirección IP del puerto. Por ejemplo, el valor es "fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]. Para obtener más información, véase Tabla 4. Un puerto solo admite una dirección IP fija que no se puede cambiar.
device_id	String	Especifica el ID del dispositivo al que pertenece el puerto. El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
device_owner	String	Especifica el dispositivo perteneciente, que puede ser el servidor DHCP, el router, el balanceador de carga o Nova. El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
tenant_id	String	Especifica el ID del proyecto.
status	String	Especifica el estado del puerto. El estado de un puerto HANA SR-IOV VM es siempre DOWN. El valor puede ser ACTIVE, BUILD o DOWN.
security_groups	Array of strings	Especifica el UUID del grupo de seguridad (atributo extendido).
allowed_address_pairs	Array of allow_address_pair objects	Especifica un conjunto de cero o más pares de direcciones permitidos. Un par de direcciones consiste en una dirección IP y una dirección de MAC. Este atributo se extiende. Para obtener más información, consulte el parámetro allow_address_pair en Tabla 5. La dirección IP no puede ser 0.0.0.0. Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24). Si el valor de allowed_address_pairs es de 1.1.1.1/0 la comprobación de origen/destino está deshabilitada.
extra_dhcp_opts	Array of extra_dhcp_opt objects	Especifica la opción extendida (atributo extendido) de DHCP. Para obtener más información, véase Tabla 6.
binding:vif_details	Object	Especifica los detalles de VIF. El parámetro ovs_hybrid_plug especifica si se utiliza el modo híbrido OVS/puente.
binding:profile	Object	Especifica la configuración definida por el usuario. Este es un atributo extendido. Instrucciones: El campo internal_elb es de tipo boolean y está disponible para tenants comunes. Establezca el valor de este parámetro en true solo cuando asigne una dirección IP virtual a un balanceador de carga de red interno. Los tenants comunes no tienen permiso para cambiar el valor de este campo, que es mantenido por el sistema. Por ejemplo: {"internal_elb": true} El campo disable_security_groups es de tipo boolean y está disponible para tenants comunes. El valor predeterminado es false. En escenarios de comunicación de alto rendimiento, puede establecer el valor del parámetro en true, lo que hace que este parámetro esté disponible para los tenants comunes. Puede especificar este parámetro al crear un puerto. Actualmente, el valor de este parámetro solo se puede establecer en true. Por ejemplo: {"disable_security_groups": true }, Actualmente, el valor solo se puede establecer en true. Cuando el valor se establece en true, la función FWaaS no tiene efecto.
binding:vnic_type	String	Especifica el tipo de vNIC enlazado. El valor puede ser normal o direct. El parámetro normal indica la conmutación de software. El parámetro direct indica el paso a través de SR-IOV PCIe, que no es compatible.
port_security_enabled	Boolean	Especifica si la opción de seguridad está habilitada para el puerto. Si la opción no está habilitada, el grupo de seguridad y la indagación DHCP no tienen efecto. El valor predeterminado es true.

**Tabla 4** Objeto de **fixed_ip**
Nombre	Tipo	Descripción
subnet_id	String	Especifica el ID de subred. No se puede cambiar el valor del parámetro.
ip_address	String	Especifica la dirección IP del puerto.

**Tabla 5** Objeto de **allow_address_pair**
Nombre	Tipo	Descripción
ip_address	String	Especifica la dirección IP. No se puede establecer en 0.0.0.0. Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24).
mac_address	String	Especifica la dirección de MAC.

**Tabla 6** Objeto de **extra_dhcp_opt**
Nombre	Tipo	Descripción
opt_name	String	Especifica el nombre de la opción.
opt_value	String	Especifica el valor de la opción.

Ejemplo de la respuesta

{
    "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",
            "binding:vif_details": {},
            "binding:profile": {},
            "port_security_enabled":true
        },
        {
            "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",
            "binding:vif_details": {},
            "binding:profile": {},
            "port_security_enabled":true
        }
    ]
}