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 nativa de OpenStack Neutron (V2.0)> Red> Consulta de redes

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

Ver PDF

Consulta de redes

Función

Esta API se utiliza para consultar todas las redes accesibles para el tenant que envía la solicitud. Se puede devolver un máximo de 2000 registros para cada operación de consulta. Si el número de registros es superior a 2000, se devolverá el marcador de paginación. Para obtener más información, consulte la sección Paginación.

URI

GET /v2.0/networks

Por ejemplo:

GET https://{Endpoint}/v2.0/networks?id={network_id}&status={network_status}&name={network_name}&admin_state_up=${admin_state_up}&tenant_id={tenant_id}&shared={is_shared}&provider:network_type={geneve}

Ejemplo de consulta de puertos por página

GET https://{Endpoint}/v2.0/networks?limit=2&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=False

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 red se utiliza como la condición de filtrado.
name	No	String	Especifica que el nombre de red se utiliza como condición de filtrado.
admin_state_up	No	Boolean	Especifica que el estado de admin se utiliza como condición de filtrado. El valor puede ser true o false.
provider:network_type	No	String	Especifica que el tipo de red se utiliza como condición de filtrado.
shared	No	Boolean	Especifica que se utiliza como condición de filtrado si la red puede ser compartida por varios tenants. El valor puede ser true o false.
status	No	String	Especifica que el estado de la red se utiliza como condición de filtrado. El valor puede ser ACTIVE, BUILD o DOWN.
router:external	No	Boolean	Especifica si la red es una red externa que se utiliza como condición de filtrado. El valor puede ser true o false.
tenant_id	No	String	Especifica que el ID del proyecto se utiliza como la condición de filtrado.
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.

Mensaje de solicitud

No hay

Ejemplo de la solicitud

GET https://{Endpoint}/v2.0/networks?limit=1

Mensaje de la respuesta

**Tabla 2** Parámetro de respuesta
Parámetro	Tipo	Descripción
networks	Array of network objects	Especifica la lista de red. Para obtener más información, véase Tabla 3.
networks_links	Array of networks_link objects	Especifica la información de paginación. Para obtener más información, véase Tabla 4. Solo cuando se utiliza limit para filtrar y el número de recursos excede el valor de limit o 2000 (valor predeterminado de limit), se devolverá el valor next para rel y un enlace para href.

**Tabla 3** Objeto **network**
Atributo	Tipo	Descripción
status	String	Especifica el estado de la red. El valor puede ser ACTIVE, BUILD, DOWN o ERROR.
subnets	Array of strings	Especifica los identificadores de las subredes asociadas a esta red. Los ID están en una lista. Solo se puede asociar una subred a cada red.
name	String	Especifica el nombre de red. El nombre no puede ser el mismo que el valor admin_external_net.
router:external	Boolean	Especifica si la red es una red externa. Este es un atributo extendido.
admin_state_up	Boolean	Especifica el estado administrativo. El valor solo puede ser true.
tenant_id	String	Especifica el ID del proyecto.
shared	Boolean	Especifica si la regla del firewall puede ser compartida por diferentes tenants.
id	String	Especifica el ID de red. Este parámetro no es obligatorio cuando consulta redes.
provider:network_type	String	Especifica el tipo de red. Solo se admiten las redes VXLAN y GENEVE. Este es un atributo extendido. Los tenants solo pueden crear redes cuyo tipo sea geneve.
availability_zone_hints	Array of strings	Especifica las zonas de disponibilidad disponibles para esta red. La versión actual no admite la programación de red entre zonas de disponibilidad.
availability_zones	Array of strings	Especifica la zona de disponibilidad de esta red.
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 configuración de indagación DHCP de todas las máquinas virtuales de la red no tienen efecto.
dns_domain	String	Especifica la dirección de dominio DNS de red privada predeterminada. El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
project_id	String	Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto.
created_at	String	Especifica la hora (UTC) en la que se crea la red. Formato: aaaa-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) cuando se actualiza la red. Formato: aaaa-MM-ddTHH:mm:ss

**Tabla 4** Objeto **networks_link**
Parámetro	Tipo	Descripción
href	String	Especifica el enlace de API.
rel	String	Especifica la relación entre el enlace de API y la versión de API.

Ejemplo de la respuesta

{
    "networks": [
        {
            "id": "0133cd73-34d4-4d4c-bf1f-e65b24603206",
            "name": "3804f26c-7862-43b6-ad3c-48445f42de89",
            "status": "ACTIVE",
            "shared": false,
            "subnets": [
                "423796f5-e02f-476f-bf02-2b88c8ddac8b"
            ],
            "availability_zone_hints": [],
            "availability_zones": [
                "az2.dc2",
                "az5.dc5"
            ],
            "admin_state_up": true,
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "provider:network_type": "vxlan",
            "router:external": false,
            "port_security_enabled": true,
            "created_at": "2018-03-23T03:51:58",
            "updated_at": "2018-03-23T03:51:58"
        }
    ],
    "networks_links": [
       {
            "rel": "next", 
            "href": "https://{Endpoint}/v2.0/networks?limit=1&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206"
        }, 
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/subnets?limit=1&marker=0133cd73-34d4-4d4c-bf1f-e65b24603206&page_reverse=True"
        }
    ]
}