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)> Router> Consulta de routers

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

Ver PDF

Consulta de routers

Función

Esta API se utiliza para consultar todos los routers accesibles para el inquilino que envía la solicitud.

URI

GET /v2.0/routers

Ejemplo:

GET https://{Endpoint}/v2.0/routers?id={id}&name={name}&admin_state_up={admin_state_up}&tenant_id={tenant_id}&status={status}

Ejemplo de la consulta de routers por página

GET https://{Endpoint}/v2.0/routers?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=False

Tabla 1 describe los parámetros.

**Tabla 1** Descripción de parámetros
Nombre	Obligatorio	Tipo	Descripción
id	No	String	Especifica que el ID del router se utiliza como condición de filtrado.
admin_state_up	No	Boolean	Especifica que el estado de administrador se utiliza como condición de filtrado. El valor puede ser true o false.
status	No	String	Especifica que el estado del router se utiliza como condición de filtrado. El valor puede ser ACTIVE, DOWN o ERROE.
tenant_id	No	String	Especifica que el ID del proyecto se utiliza como 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

Ninguno

Ejemplo de solicitud

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

Mensaje de respuesta

**Tabla 2** Parámetro de respuesta
Parámetro	Tipo	Descripción
routers	Array of router objects	Especifica la lista de routers. Para más detalles, consulte Tabla 3.
routers_links	Array of routers_link objects	Especifica la información de paginación. Para más detalles, consulte Tabla 6. 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** Objetos de **router**
Atributo	Tipo	Descripción
id	String	Especifica el ID del router. Este parámetro no es obligatorio cuando consulta los routers.
name	String	Especifica el nombre del router. El nombre solo puede contener letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
admin_state_up	Boolean	Especifica el estado administrativo. El valor solo puede ser true.
status	String	Especifica el estado del enrutador. El valor puede ser ACTIVE, DOWN o ERROR.
tenant_id	String	Especifica el ID del proyecto.
external_gateway_info	Objeto de external_gateway_info	Especifica el gateway externo. Este es un atributo extendido. Para obtener más información, consulte los objetos de external_gateway_info.
routes	Matriz de objetos de route	Especifica una lista de rutas. Este es un atributo extendido. Para más detalles, consulte Tabla 5.
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) cuando se crea el enrutador. Formato: aaaa-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) cuando se actualiza el router. Formato: aaaa-MM-ddTHH:mm:ss

**Tabla 4** Objetos de **external_gateway_info**
Atributo	Tipo	Descripción
network_id	String	Especifica el UUID de la red externa. Puede usar GET /v2.0/networks?router:external=True o ejecutar el comando neutron net-external-list para consultar información sobre la red externa.
enable_snat	Boolean	Especifica si la función SNAT está habilitada. El valor predeterminado es false.

**Tabla 5** Objetos de **route**
Atributo	Tipo	Descripción
destination	String	Especifica el intervalo de direcciones IP.
nexthop	String	Especifica la dirección IP del salto siguiente. La dirección IP solo puede ser una en la subred asociada con el enrutador.

**Tabla 6** Objeto de **routers_link**
Nombre	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 respuesta

{
    "routers": [
        {
            "id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe",
            "name": "xiaoleizi-tag",
            "status": "ACTIVE",
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "admin_state_up": true,
            "external_gateway_info": {
                "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
                "enable_snat": false
            },
            "routes": [
                {
                    "destination": "0.0.0.0/0",
                    "nexthop": "172.16.0.124"
                }
            ],
            "created_at": "2018-03-23T09:26:08",
            "updated_at": "2018-08-24T08:49:53"
        }
    ],
    "routers_links": [
       {
            "rel": "next", 
            "href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe"
        }, 
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=True"
        }
    ]
}