Consulta de directivas de reenvío
Función
Esta API se utiliza para consultar las políticas de reenvío. 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/l7policies
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|
---|---|---|---|---|
marker |
No |
String |
Especifica el ID de la política de reenvío desde la que se inicia la consulta de paginación, es decir, el ID de la última política de reenvío de la página anterior. Este parámetro debe usarse junto con limit. |
|
limit |
No |
Integer |
Especifica el número de políticas de reenvío de cada página. Si este parámetro no está definido, todas las políticas de reenvío 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 política de reenvío. |
|
tenant_id |
No |
String |
Especifica el ID del proyecto en el que se utiliza la política de reenvío. El valor contiene un máximo de 255 caracteres. |
|
project_id |
No |
String |
Especifica el ID del proyecto al que pertenece la política de reenvío. Este parámetro tiene el mismo significado que tenant_id. |
|
name |
No |
String |
Especifica el nombre de la política de reenvío. El valor contiene un máximo de 255 caracteres. |
|
admin_state_up |
No |
Boolean |
Especifica el estado administrativo de la política de reenvío. Este parámetro está reservado y el valor predeterminado es true. |
|
description |
No |
String |
Proporciona información adicional sobre la política de reenvío. El valor contiene un máximo de 255 caracteres. |
|
listener_id |
No |
String |
Especifica el ID del oyente al que se agrega la política de reenvío. |
|
action |
No |
String |
Especifica si las solicitudes se reenvían a otro grupo de servidores backend o se redirigen a un HTTPS oyente. El valor puede ser uno de los siguientes:
|
|
redirect_pool_id |
No |
String |
Especifica el ID del grupo de servidores backend al que se reenvía el tráfico. |
|
redirect_listener_id |
No |
String |
Especifica el ID del oyente al que se redirige el tráfico. |
|
redirect_url |
No |
String |
Especifica la dirección URL a la que se redirige el tráfico. Este parámetro está reservado. El valor contiene un máximo de 255 caracteres. |
|
position |
No |
Integer |
Especifica la prioridad de reenvío. El valor varía de 1 a 100. El valor predeterminado es 100. Este parámetro está reservado. |
|
provisioning_status |
No |
String |
Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento de la política de reenvío. |
|
display_all_rules |
No |
Boolean |
Especifica si se muestran todas las reglas de reenvío agregadas a la política de reenvío. Opciones de valor: false: no se mostrarán las reglas de reenvío y solo se mostrarán los ID. true: se mostrarán las reglas de reenvío. |
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
l7policies |
Array |
Muestra las políticas de reenvío. Para más detalles, consulte Tabla 3. |
l7policies_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 5. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID de política de reenvío. |
tenant_id |
String |
Especifica el ID del proyecto en el que se utiliza la política de reenvío. |
project_id |
String |
Especifica el ID del proyecto al que pertenece la política de reenvío. Este parámetro tiene el mismo significado que tenant_id. |
name |
String |
Especifica el nombre de la política de reenvío. |
admin_state_up |
Boolean |
Especifica el estado administrativo de la política de reenvío. Este parámetro está reservado. El valor puede ser true o false.
|
description |
String |
Proporciona información adicional sobre la política de reenvío. |
listener_id |
String |
Especifica el ID del oyente al que se agrega la política de reenvío. |
action |
String |
Especifica si las solicitudes se reenvían a otro grupo de servidores backend o se redirigen a un HTTPS oyente. El valor puede ser uno de los siguientes:
|
redirect_pool_id |
String |
Especifica el ID del grupo de servidores backend al que se reenvía el tráfico. |
redirect_listener_id |
String |
Especifica el ID del oyente al que se redirige el tráfico. |
redirect_url |
String |
Especifica la dirección URL a la que se redirige el tráfico. Este parámetro está reservado. |
rules |
Array |
Muestra las reglas de reenvío de la política de reenvío. Para más detalles, consulte Tabla 6. |
position |
Integer |
Especifica la prioridad de reenvío. El valor varía de 1 a 100. El valor predeterminado es 100. Este parámetro está reservado. |
provisioning_status |
String |
Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento de la política de reenvío. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Muestra los identificadores de las reglas de reenvío en la política de reenvío. |
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: consulta de todas las políticas de reenvío
GET https://{Endpoint}/v2.0/lbaas/l7policies
- Ejemplo de solicitud 2: Consulta de políticas de reenvío a través de las cuales las solicitudes se reenvían al grupo de servidores backend
GET https://{Endpoint}/v2.0/lbaas/l7policies?action=REDIRECT_TO_POOL
Ejemplo de la respuesta
- Ejemplo de respuesta 1
{ "l7policies": [ { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 2, "provisioning_status": "ACTIVE", "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ], "l7policies_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/l7policies/061f461c-c7cf-47ab-9583-09be5076cd09/rules?marker=167c1a31-bc12-4c3d-9ad1-c9bf450df4ce&page_reverse=True", "rel": "previous" } ] }
- Ejemplo de respuesta 2
{ "l7policies": [ { "redirect_pool_id": "431a03eb-81bb-408e-ae37-7ce19023692b", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "26058b64-6185-4e06-874e-4bd68b7633d0", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 2, "provisioning_status": "ACTIVE", "id": "5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586", "name": "" }, { "redirect_pool_id": "59eebd7b-c68f-4f8a-aa7f-e062e84c0690", "redirect_listener_id": null, "description": "", "admin_state_up": true, "rules": [ { "id": "f4499f48-de3d-4efe-926d-926aa4d6aaf5" } ], "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "listener_id": "e1310063-00de-4867-ab55-ccac4d9db364", "redirect_url": null, "action": "REDIRECT_TO_POOL", "position": 1, "provisioning_status": "ACTIVE", "id": "6cfd9d89-1d7e-4d84-ae1f-a8c5ff126f72", "name": "" } ], "l7policies_links": [ { "href": "https://{Endpoint}/v2.0/lbaas/l7policies/061f461c-c7cf-47ab-9583-09be5076cd09/rules?marker=167c1a31-bc12-4c3d-9ad1-c9bf450df4ce&page_reverse=True", "rel": "previous" } ] }
Código de estado
Para más detalles, consulte Códigos de estado.