Consulta de reglas de reenvío
Función
Esta API se utiliza para consultar reglas 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/{l7policy_id}/rules
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
l7policy_id |
Sí |
String |
Especifica el ID de política de reenvío. |
Solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
marker |
No |
String |
Especifica el ID de la regla de reenvío desde la que se inicia la consulta de paginación, es decir, el ID de la última regla de reenvío de la página anterior. Este parámetro debe usarse junto con limit. |
limit |
No |
Integer |
Especifica el número de reglas de reenvío de cada página. Si este parámetro no está definido, todas las reglas 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 regla de reenvío. |
tenant_id |
No |
String |
Especifica el ID del proyecto en el que se utiliza la regla 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 regla de reenvío. Este parámetro tiene el mismo significado que tenant_id. |
admin_state_up |
No |
Boolean |
Especifica el estado administrativo de la regla de reenvío. Este parámetro está reservado y el valor predeterminado es true. |
type |
No |
String |
Especifica el tipo de coincidencia de una regla de reenvío. El valor puede ser uno de los siguientes:
El tipo de coincidencia de reglas de reenvío en una política de reenvío debe ser único. |
compare_type |
No |
String |
Specifies the match mode. Las opciones son las siguientes: Cuando type se establece en HOST_NAME, el valor de este parámetro solo puede ser el siguiente:
Cuando type se establece en PATH, el valor de este parámetro puede ser uno de los siguientes:
|
invert |
No |
Boolean |
Especifica si se admite la coincidencia inversa. El valor puede ser true o false. El valor predeterminado es false. Este parámetro está reservado. |
key |
No |
String |
Especifica la clave del contenido de coincidencia. El valor predeterminado es null. Este parámetro está reservado. El valor contiene un máximo de 255 caracteres. |
value |
No |
String |
Especifica el valor del contenido de coincidencia. El valor contiene un máximo de 128 caracteres.
|
provisioning_status |
No |
String |
Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento de la regla de reenvío. |
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
rules |
Array |
Muestra las reglas de reenvío. Para más detalles, consulte Tabla 4. |
rules_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 regla de reenvío. |
tenant_id |
String |
Especifica el ID del proyecto en el que se utiliza la regla de reenvío. El valor contiene un máximo de 255 caracteres. |
project_id |
String |
Especifica el ID del proyecto al que pertenece la regla de reenvío. Este parámetro tiene el mismo significado que tenant_id. |
admin_state_up |
Boolean |
Especifica el estado administrativo de la regla de reenvío. Este parámetro está reservado. El valor puede ser true o false.
|
type |
String |
Especifica el tipo de coincidencia de una regla de reenvío. El valor puede ser uno de los siguientes:
|
compare_type |
String |
Especifica el modo de coincidencia. Las opciones son las siguientes: Cuando type se establece en HOST_NAME, el valor de este parámetro solo puede ser el siguiente:
Cuando type se establece en PATH, el valor de este parámetro puede ser uno de los siguientes:
|
invert |
Boolean |
Especifica si se admite la coincidencia inversa. El valor puede ser true o false. El valor predeterminado es false. Este parámetro está reservado. |
key |
String |
Especifica la clave del contenido de coincidencia. El valor predeterminado es null. Este parámetro está reservado. El valor contiene un máximo de 255 caracteres. |
value |
String |
Especifica el valor del contenido de coincidencia. El valor contiene un máximo de 128 caracteres.
|
provisioning_status |
String |
Este parámetro está reservado y su valor sólo puede ser ACTIVE. Especifica el estado de aprovisionamiento de la regla 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: consulta de todas las reglas de reenvío de una política de reenvío específica
GET https://{Endpoint}/v2.0/lbaas/l7policies/5ae0e1e7-5f0f-47a1-b39f-5d4c428a1586/rules
Ejemplo de la respuesta
- Ejemplo de la respuesta
{ "rules": [ { "compare_type": "EQUAL_TO", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "www.test.com", "key": null, "type": "HOST_NAME", "id": "67d8a8fa-b0dd-4bd4-a85b-671db19b2ef3" }, { "compare_type": "EQUAL_TO", "provisioning_status": "ACTIVE", "admin_state_up": true, "tenant_id": "a31d2bdcf7604c0faaddb058e1e08819", "project_id": "a31d2bdcf7604c0faaddb058e1e08819", "invert": false, "value": "/aaa.html", "key": null, "type": "PATH", "id": "f02b3bca-69d2-4335-a3fa-a8054e996213" } ] "rules_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.