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/ Elastic Load Balance/ Referencia de la API/ API del balanceador de carga dedicado/ Política de reenvío/ Consulta de políticas de reenvío

Actualización más reciente 2023-12-18 GMT+08:00

Ver PDF

Consulta de políticas de reenvío

Función

Esta API se utiliza para consultar todas las políticas de reenvío.

Restricciones

Esta API tiene las siguientes 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 /v3/{project_id}/elb/l7policies

**Tabla 1** Parámetros de ruta
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
marker	No	String	Especifica el identificador del último registro de la página anterior. Nota: Este parámetro debe usarse junto con limit. Si no se especifica este parámetro, se consultará la primera página. Este parámetro no se puede dejar en blanco ni establecer un ID no válido.
limit	No	Integer	Especifica el número de registros de cada página. Mínimo: 0 Máximo: 2000 Predeterminado: 2000
page_reverse	No	Boolean	Especifica si se va a utilizar la consulta inversa. Valores: true: consulta la página anterior. false (predeterminado): consulta la página siguiente. Nota: Este parámetro debe usarse junto con limit. Si page_reverse se establece en true y desea consultar la página anterior, establezca el valor de marker en el valor de previous_marker.
enterprise_project_id	No	Array	Especifica el ID del proyecto de empresa. Si no se pasa este parámetro, se consultan los recursos del proyecto de empresa predeterminado y se realiza la autenticación en función del proyecto de empresa predeterminado. Si se pasa este parámetro, su valor puede ser el ID de un proyecto de empresa existente (se requieren recursos en el proyecto de empresa específico) o all_granted_eps (se consultan recursos en todos los proyectos de empresa). Se pueden consultar varios identificadores en el formato enterprise_project_id=xxx&enterprise_project_id=xxx. Este parámetro no es compatible. Por favor, no lo use.
id	No	Array	Especifica el ID de política de reenvío. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx.
name	No	Array	Especifica el nombre de la política de reenvío. Se pueden consultar varios nombres con el formato name=xxx&name=xxx.
description	No	Array	Proporciona información adicional sobre la política de reenvío. Se pueden consultar varias descripciones en el formato de description=xxx&description=xxx.
admin_state_up	No	Boolean	Especifica el estado administrativo de la política de reenvío. El valor predeterminado es true. Este parámetro no es compatible. Por favor, no lo use.
listener_id	No	Array	Especifica el ID del oyente al que se agrega la política de reenvío. Se pueden consultar varios ID en el formato listener_id=xxx&listener_id=xxx.
position	No	Array	Especifica la prioridad de la política de reenvío. Se pueden consultar varias prioridades en el formato de position=xxx&position=xxx. Este parámetro no es compatible. Por favor, no lo use.
action	No	Array	Especifica dónde se reenvían las solicitudes. El valor puede ser uno de los siguientes: REDIRECT_TO_POOL: las solicitudes se reenvían a otro grupo de servidores backend. REDIRECT_TO_LISTENER: Las solicitudes se redirigen a un oyente HTTPS. REDIRECT_TO_URL: Las solicitudes se redirigen a otra URL. FIXED_RESPONSE: Se devuelve un cuerpo de respuesta fijo. Se pueden consultar varios valores en el formato de action=xxx&action=xxx.
redirect_url	No	Array	Especifica la dirección URL a la que se reenviarán las solicitudes. La URL debe tener el formato de protocol://host:port/path?query. Se pueden consultar varias URL en el formato de redirect_url=xxx&redirect_url=xxx. Este parámetro no es compatible. Por favor, no lo use.
redirect_pool_id	No	Array	Especifica el ID del grupo de servidores backend al que se reenviarán las solicitudes. Se pueden consultar varios ID en el formato de redirect_pool_id=xxx&redirect_pool_id=xxx.
redirect_listener_id	No	Array	Especifica el ID del oyente al que se redirigen las solicitudes. Se pueden consultar varios ID en el formato de redirect_listener_id=xxx&redirect_listener_id=xxx.
provisioning_status	No	Array	Especifica el estado de aprovisionamiento de la política de reenvío. ACTIVE: La política de reenvío se aprovisiona correctamente. ERROR: La política de reenvío tiene la misma regla que otra política de reenvío añadida al mismo oyente. Se pueden consultar varios estados de aprovisionamiento en el formato de provisioning_status=xxx&provisioning_status=xxx.
display_all_rules	No	Boolean	Especifica si se mostrarán detalles sobre la regla de reenvío en la política de reenvío. true: se muestran los detalles sobre la regla de reenvío. false: solo se muestra el ID de regla.
priority	No	Array	Especifica la prioridad de la política de reenvío. Un valor menor indica una mayor prioridad. Se pueden consultar varias prioridades en el formato de position=xxx&position=xxx.

Parámetros de solicitud

**Tabla 3** Parámetros de cabecera de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Especifica el token utilizado para la autenticación IAM.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Response body parameters
Parámetro	Tipo	Descripción
request_id	String	Especifica el ID de la solicitud. El valor se genera automáticamente.
page_info	PageInfo object	Muestra información de paginación.
l7policies	Array of L7Policy objects	Muestra las políticas de reenvío.

**Tabla 5** PageInfo
Parámetro	Tipo	Descripción
previous_marker	String	Especifica el ID del primer registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página anterior.
next_marker	String	Especifica el ID del último registro del resultado de la consulta de paginación. Establezca este parámetro para consultar la página siguiente.
current_count	Integer	Especifica el número de registros.

**Tabla 6** L7Policy
Parámetro	Tipo	Descripción
action	String	Especifica dónde se reenviarán las solicitudes. El valor puede ser uno de los siguientes: REDIRECT_TO_POOL: Las solicitudes se reenviarán a otro grupo de servidores backend. REDIRECT_TO_LISTENER: Las solicitudes serán redirigidas a un oyente HTTPS. REDIRECT_TO_URL: Las solicitudes serán redirigidas a otra URL. FIXED_RESPONSE: Se devolverá un cuerpo de respuesta fijo. REDIRECT_TO_LISTENER tiene la prioridad más alta. Si las solicitudes van a ser redirigidas a un oyente HTTPS, otras políticas de reenvío del oyente serán inválidas. Nota: Si action se establece en REDIRECT_TO_POOL, el protocolo del oyente debe ser HTTP, HTTPS o TERMINATED_HTTPS. Si action se establece en REDIRECT_TO_LISTENER, el protocolo del oyente debe ser HTTP.
admin_state_up	Boolean	Especifica el estado administrativo de la política de reenvío. El valor predeterminado es true. Este parámetro no es compatible. Por favor, no lo use.
description	String	Proporciona información adicional sobre la política de reenvío.
id	String	Especifica el ID de política de reenvío.
listener_id	String	Especifica el ID del oyente al que se agrega la política de reenvío.
name	String	Especifica el nombre de la política de reenvío. Mínimo: 1 Máximo: 255
position	Integer	Especifica la prioridad de la política de reenvío. Este parámetro no se puede actualizar. Este parámetro no es compatible. Por favor, no lo use. Mínimo: 1 Máximo: 100
priority	Integer	Especifica la prioridad de la política de reenvío. Un valor menor indica una mayor prioridad. El valor debe ser único para las políticas de reenvío del mismo oyente. Este parámetro solo tendrá efecto si se establece enhance_l7policy_enable en true. Si se pasa este parámetro y enhance_l7policy_enable se establece en false, se devolverá un error. Este parámetro no es compatible con balanceadores de carga compartidos. Si action se establece en REDIRECT_TO_LISTENER, el valor solo puede ser 0, lo que indica que REDIRECT_TO_LISTENER tiene la prioridad más alta. Si enhance_l7policy_enable no está habilitado, las políticas de reenvío se priorizan automáticamente según la lógica de clasificación de políticas original. Las prioridades de los nombres de dominio son independientes entre sí. Para el mismo nombre de dominio, las prioridades se ordenan en el orden de coincidencia exacta (EQUAL_TO), coincidencia de prefijo (STARTS_WITH) y coincidencia de expresión regular (REGEX). Si los tipos coincidentes son los mismos, cuanto más larga sea la URL, mayor será la prioridad. Si una política de reenvío contiene sólo un nombre de dominio sin una ruta especificada, la ruta es de /, y la coincidencia de prefijo se utiliza de forma predeterminada. Si enhance_l7policy_enable se establece en true y este parámetro no se pasa, la prioridad será una suma de 1 y la prioridad más alta de la política de reenvío existente en el mismo oyente por defecto. Si la prioridad más alta de las políticas de reenvío existentes es el máximo (10,000), no se creará la política de reenvío porque la prioridad final para crear la política de reenvío es la suma de 1 y 10,000 que excede el máximo. En este caso, especifique un valor o ajuste las prioridades de las políticas de reenvío existentes. Si no existen políticas de reenvío, la prioridad más alta de las políticas de reenvío existentes se establecerá en 1 de forma predeterminada. Este parámetro no es válido para balanceadores de carga compartidos. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
project_id	String	Especifica el ID de proyecto de la política de reenvío.
provisioning_status	String	Especifica el estado de aprovisionamiento de la política de reenvío. El valor puede ser ACTIVE o ERROR. ACTIVE (predeterminado): La política de reenvío se aprovisiona correctamente.
redirect_pool_id	String	Especifica el ID del grupo de servidores backend al que se reenviarán las solicitudes. Este parámetro es válido y obligatorio solo cuando action se establece en REDIRECT_TO_POOL. Si se especifican redirect_pools_config y redirect_pool_id, redirect_pools_config tendrá efecto.
redirect_pools_config	Array of CreateRedirectPoolsConfig objects	Especifica la configuración del grupo de servidores backend al que se reenvían las solicitudes. Este parámetro sólo es válido cuando action se establece en REDIRECT_TO_POOL.
redirect_listener_id	String	Especifica el ID del oyente al que se redirigen las solicitudes. Este parámetro es obligatorio cuando action se establece en REDIRECT_TO_LISTENER. Nota: El protocolo del oyente debe ser HTTPS o TERMINATED_HTTPS. No se permite un oyente agregado a otro balanceador de carga. Este parámetro no se puede pasar en la API para agregar o actualizar una política de reenvío si action está establecida en REDIRECT_TO_POOL.
redirect_url	String	Especifica la dirección URL a la que se reenvían las solicitudes. Formato: protocol://host:port/path?query Este parámetro no es compatible. Por favor, no lo use.
rules	Array of RuleRef objects	Muestra las reglas de reenvío de la política de reenvío.
redirect_url_config	RedirectUrlConfig object	Especifica la dirección URL a la que se reenvían las solicitudes. Para balanceadores de carga dedicados, este parámetro solo tendrá efecto cuando se habilita el reenvío avanzado (enhance_l7policy_enable se establece en true). Si se pasa cuando enhance_l7policy_enable se establece en false, se devolverá un error. Este parámetro es obligatorio cuando action se establece en REDIRECT_TO_URL. No se puede especificar si el valor de action no es REDIRECT_TO_URL. Formato: protocol://host:port/path?query Al menos uno de los cuatro parámetros (protocol, host, port, y path) debe pasarse, o sus valores no se pueden establecer en ${xxx} al mismo tiempo. (${xxx} indica que el valor de la solicitud se heredará. Por ejemplo, ${host} indica el host en la URL que se va a redirigir.) Los valores de protocol y port no pueden ser los mismos que los del oyente asociado, y se deben pasar host o path o sus valores no pueden ser ${xxx} al mismo tiempo. Para los balanceadores de carga compartidos, este parámetro no es compatible. Si se pasa, se devolverá un error. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
fixed_response_config	FixtedResponseConfig object	Especifica la configuración de la página que se devolverá. Este parámetro tendrá efecto cuando se establezca enhance_l7policy_enable en true. Si se pasa este parámetro y enhance_l7policy_enable se establece en false, se devolverá un error. Este parámetro es obligatorio cuando action se establece en FIXED_RESPONSE. No se puede especificar si el valor de action no es FIXED_RESPONSE. Para los balanceadores de carga compartidos, este parámetro no es compatible. Si se pasa, se devolverá un error. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
created_at	String	Especifica la hora en que se agregó la política de reenvío. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.
updated_at	String	Especifica la hora a la que se actualizó la política de reenvío. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos.

**Tabla 7** CreateRedirectPoolsConfig
Parámetro	Tipo	Descripción
pool_id	String	Especifica el ID del grupo de servidores backend.
weight	Integer	Especifica el peso del grupo de servidores backend. El valor varía de 0 a 100.

**Tabla 8** RuleRef
Parámetro	Tipo	Descripción
id	String	Especifica el ID de regla de reenvío.

**Tabla 9** RedirectUrlConfig
Parámetro	Tipo	Descripción
protocol	String	Especifica el protocolo para la redirección. El valor puede ser HTTP, HTTPS o ${protocol}. El valor predeterminado es ${protocol}, que indica que se utilizará el protocolo de la solicitud. Mínimo: 1 Máximo: 36
host	String	Especifica el nombre de host al que se redirigen las solicitudes. El valor solo puede contener letras, dígitos, guiones (-) y puntos (.) y debe comenzar con una letra o un dígito. El valor predeterminado es ${host}, que indica que se utilizará el host de la solicitud. Valor predeterminado: ${host} Mínimo: 1 Máximo: 128
port	String	Especifica el puerto al que se redirigen las solicitudes. El valor predeterminado es ${port}, que indica que se utilizará el puerto de la solicitud. Valor predeterminado: ${port} Mínimo: 1 Máximo: 16
path	String	Especifica la ruta a la que se redirigen las solicitudes. El valor predeterminado es ${path}, que indica que se utilizará la ruta de acceso de la solicitud. El valor solo puede contener letras, dígitos y caracteres especiales __-';@^- %#&$.+?,=!:\|/()[]{} y debe comenzar con una barra diagonal (/). Valor predeterminado: ${path}* Mínimo: 1 Máximo: 128
query	String	Especifica la string de consulta establecida en la dirección URL para la redirección. El valor predeterminado es ${query}, que indica que se utilizará la string de consulta de la solicitud. Por ejemplo, en URL https://www.example.com:8080/elb?type=loadbalancer, ${query} indica type=loadbalancer. Si este parámetro se establece en ${query}&name=my_name, la URL será redirigida a https://www.example.com:8080/elb?type=loadbalancer&name=my_name. El valor distingue entre mayúsculas y minúsculas y solo puede contener letras, dígitos y characters !$&'()*+,-./:;=?@^_` Valor predeterminado: ${query} Mínimo: 0 Máximo: 128
status_code	String	Especifica el código de estado devuelto después de redirigir las solicitudes. El valor puede ser 301, 302, 303, 307 o 308. Mínimo: 1 Máximo: 16

**Tabla 10** FixtedResponseConfig
Parámetro	Tipo	Descripción
status_code	String	Especifica el código de estado HTTP configurado en la política de reenvío. El valor puede ser cualquier número entero en el intervalo de 200–299, 400–499, o 500–599. Mínimo: 1 Máximo: 16
content_type	String	Especifica el formato del cuerpo de la respuesta. El valor puede ser text/plain, text/css, text/html, application/javascript, o application/json. Mínimo: 0 Máximo: 32
message_body	String	Especifica el contenido del cuerpo del mensaje de respuesta. Mínimo: 0 Máximo: 1024

Ejemplo de las solicitudes

GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies?display_all_rules=true

Ejemplo de las respuestas

Código de estado: 200

Solicitud exitosa.

{
  "request_id" : "d3c67339-be91-4813-bb24-85728a5d326a",
  "l7policies" : [ {
    "redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240",
    "description" : "",
    "admin_state_up" : true,
    "rules" : [ {
      "id" : "c5c2d625-676b-431e-a4c7-c59cc2664881"
    } ],
    "project_id" : "7a9941d34fc1497d8d0797429ecfd354",
    "listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56",
    "redirect_url" : null,
    "redirect_url_config" : null,
    "fixed_response_config" : null,
    "redirect_listener_id" : null,
    "action" : "REDIRECT_TO_POOL",
    "position" : 100,
    "priority" : null,
    "provisioning_status" : "ACTIVE",
    "id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
    "name" : "l7policy-67"
  }, {
    "redirect_pool_id" : null,
    "description" : "",
    "admin_state_up" : true,
    "rules" : [ {
      "id" : "390f3a9f-670d-4ca6-b72c-6be8a48a8a00"
    } ],
    "project_id" : "7a9941d34fc1497d8d0797429ecfd354",
    "listener_id" : "bd782cbf-fb5e-411a-9295-530bdec05058",
    "redirect_url" : null,
    "redirect_url_config" : null,
    "fixed_response_config" : {
      "content_type" : "text/plain",
      "message_body" : "",
      "status_code" : "207"
    },
    "redirect_listener_id" : null,
    "action" : "FIXED_RESPONSE",
    "position" : 6,
    "priority" : 2,
    "provisioning_status" : "ACTIVE",
    "id" : "049a8635-9754-444e-94aa-678993b39cd6",
    "name" : "l7policy-67"
  } ],
  "page_info" : {
    "next_marker" : "2587d8b1-9e8d-459c-9081-7bccaa075d2b",
    "previous_marker" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
    "current_count" : 2
  }
}