Consulta de listas blancas
Función
Esta API se utiliza para consultar las listas blancas. Se admite la consulta de filtro y la consulta de paginación. A menos que se especifique lo contrario, se aplica una coincidencia exacta.
Restricciones
Los parámetros marker, limit y page_reverse se utilizan para la consulta de paginación. Los parámetros marker y page_reverse solo tienen efecto cuando se usan junto con el parámetro limit.
URI
GET /v2.0/lbaas/whitelists
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
marker |
No |
String |
Especifica el ID de la lista blanca desde la que se inicia la consulta de paginación, es decir, el ID de la última lista blanca de la página anterior. Este parámetro debe usarse junto con limit. |
limit |
No |
Integer |
Especifica el número de listas blancas de cada página. Si este parámetro no está definido, todas las listas blancas se consultan de forma predeterminada. |
page_reverse |
No |
Boolean |
Especifica la dirección de la página. El valor puede ser true o false, y el valor predeterminado es false. La última página de la lista solicitada con page_reverse establecido en false no contendrá el enlace "next", y la última página de la lista solicitada con page_reverse establecido en true no contendrá el enlace "anterior". Este parámetro debe usarse junto con limit. |
id |
No |
String |
Especifica el ID de la lista blanca. |
tenant_id |
No |
String |
Especifica el ID del proyecto en el que se utiliza la lista blanca. El valor contiene un máximo de 255 caracteres. |
listener_id |
No |
String |
Especifica el ID del oyente al que se agrega la lista blanca. |
enable_whitelist |
No |
Boolean |
Especifica si se debe habilitar el control de acceso. true: El control de acceso está habilitado. false: el control de acceso está deshabilitado. |
whitelist |
No |
String |
Especifica las direcciones IP de la lista blanca. |
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
whitelists |
Array |
Muestra las listas blancas. Para más detalles, consulte Tabla 3. |
whitelists_links |
Array |
Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente. Este parámetro solo existe en el cuerpo de respuesta de la consulta de paginación. Para más detalles, consulte Tabla 4. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de la lista blanca. |
tenant_id |
String |
Especifica el ID del proyecto en el que se utiliza la lista blanca. El valor contiene un máximo de 255 caracteres. |
listener_id |
String |
Especifica el ID del oyente al que se agrega la lista blanca. |
enable_whitelist |
Bool |
Especifica si se debe habilitar el control de acceso. true: El control de acceso está habilitado. false: el control de acceso está deshabilitado. |
whitelist |
String |
Especifica las direcciones IP de la lista blanca. |
Parámetro |
Tipo |
Descripción |
---|---|---|
href |
String |
Proporciona enlaces a la página anterior o siguiente durante la consulta de paginación, respectivamente. |
rel |
String |
Especifica la solicitud de la página anterior o siguiente. El valor puede ser next o previous. El valor next indica el href que contiene la dirección URL de la página siguiente, y previous indica el href que contiene la dirección URL de la página anterior. |
Ejemplo de la solicitud
- Ejemplo de solicitud 1: Consultar todas las listas blancas
GET https://{Endpoint}/v2.0/lbaas/whitelists
- Ejemplo de solicitud 2: Consultar las listas blancas agregadas a oyente eabfefa3fd1740a88a47ad98e132d230
GET https://{Endpoint}/v2.0/lbaas/whitelists?listener_id=eabfefa3fd1740a88a47ad98e132d230
Ejemplo de la respuesta
- Ejemplo de respuesta 1
{ "whitelists": [ { "id": "eabfefa3fd1740a88a47ad98e132d238", "listener_id": "eabfefa3fd1740a88a47ad98e132d238", "tenant_id": "eabfefa3fd1740a88a47ad98e132d238", "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" }, { "id": "eabfefa3fd1740a88a47ad98e132d326", "listener_id": "eabfefa3fd1740a88a47ad98e132d327", "tenant_id": "eabfefa3fd1740a88a47ad98e132d436", "enable_whitelist": true, "whitelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" } ] }
- Ejemplo de respuesta 2
{ "whitelists": [ { "id": "eabfefa3fd1740a88a47ad98e132d238", "listener_id": "eabfefa3fd1740a88a47ad98e132d230", "tenant_id": "eabfefa3fd1740a88a47ad98e132d239", "enable_whitelist": true, "whitelist": "192.168.11.1,192.168.0.1/24,192.168.201.18/8,100.164.0.1/24" }, { "id": "eabfefa3fd1740a88a47ad98e132d326", "listener_id": "eabfefa3fd1740a88a47ad98e132d327", "tenant_id": "eabfefa3fd1740a88a47ad98e132d439", "enable_whitelist": true, "whitelist": "192.168.12.1,192.168.1.1/24,192.168.203.18/8,100.164.5.1/24" } ] }
Código de estado
Para más detalles, consulte Códigos de estado.