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> Regla de reenvío> Consulta de reglas de reenvío

Actualización más reciente 2022-11-17 GMT+08:00

Ver PDF

Consulta de reglas de reenvío

Función

Esta API se utiliza para consultar todas las reglas 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/{l7policy_id}/rules

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

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
limit	No	Integer	Especifica el número de registros de cada página. Mínimo: 0 Máximo: 2000 Predeterminado: 2000
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.
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.
id	No	Array	Especifica el ID de regla de reenvío. Se pueden consultar múltiples ID en el formato id=xxx&id=xxx.
compare_type	No	Array	Especifica cómo se comparan las solicitudes con los nombres de dominio o la dirección URL. Valores: EQUAL_TO: coincidencia exacta. REGEX: coincidencia de expresiones regulares STARTS_WITH: coincidencia de prefijos Se pueden consultar varios valores con el formato de compare_type=xxx&compare_type=xxx.
provisioning_status	No	Array	Especifica el estado de aprovisionamiento de la regla de reenvío. El valor sólo puede ser ACTIVE, lo que indica que la regla de reenvío se ha aprovisionado correctamente. Se pueden consultar varios estados de aprovisionamiento en el formato de provisioning_status=xxx&provisioning_status=xxx.
invert	No	Boolean	Especifica si se admite la coincidencia inversa. El valor se fija en false. Este parámetro se puede actualizar, pero no es válido.
admin_state_up	No	Boolean	Especifica el estado administrativo de la regla de reenvío. El valor predeterminado es true. Este parámetro no es compatible. Por favor, no lo use.
value	No	Array	Especifica el valor del contenido de coincidencia. Se pueden consultar varios valores en el formato value=xxx&value=xxx.
key	No	Array	Especifica la clave del contenido de coincidencia que se utiliza para identificar la regla de reenvío. Se pueden consultar varias claves en el formato key=xxx&key=xxx. Este parámetro no es compatible. Por favor, no lo use.
type	No	Array	Especifica el tipo de coincidencia. El valor puede ser HOST_NAME o PATH. El tipo de reglas de reenvío para la misma política de reenvío no puede ser el mismo. Se pueden consultar varios tipos con el formato type=xxx&type=xxx.
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.

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** Parámetros del cuerpo de respuesta
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.
rules	Array of L7Rule objects	Muestra las reglas 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** L7Rule
Parámetro	Tipo	Descripción
admin_state_up	Boolean	Especifica el estado administrativo de la regla de reenvío. El valor predeterminado es true. Este parámetro no es compatible. Por favor, no lo use.
compare_type	String	Especifica cómo se hacen coincidir las solicitudes con el nombre de dominio o la dirección URL. Si type se establece en HOST_NAME, este parámetro solo se puede establecer en EQUAL_TO. Si type se establece en PATH, el valor puede ser REGEX, STARTS_WITH o EQUAL_TO.
key	String	Especifica la clave del contenido de coincidencia. Este parámetro no tendrá efecto si type se establece en HOST_NAME o PATH. Mínimo: 1 Máximo: 255
project_id	String	Especifica el ID del proyecto.
type	String	Especifica el tipo de regla de reenvío. El valor puede ser uno de los siguientes: HOST_NAME: Se usará un nombre de dominio para la coincidencia. PATH: Se usará una URL para hacer coincidir. METHOD: Se usará un método de petición HTTP para la coincidencia. HEADER: El encabezado de solicitud se usará para la coincidencia. QUERY_STRING: Se utilizará una string de consulta para la coincidencia. SOURCE_IP: La dirección IP de origen se usará para la coincidencia. Nota: Si type se establece en HOST_NAME, PATH, METHOD, y SOURCE_IP, sólo se puede crear una regla de reenvío para cada tipo. Si type se establece en HEADER y QUERY_STRING, se pueden crear varias reglas de reenvío para cada tipo.
value	String	Especifica el valor del elemento de coincidencia. Por ejemplo, si se utiliza un nombre de dominio para hacer coincidir, value es el nombre de dominio. Este parámetro solo tendrá efecto cuando conditions se dejan en blanco. Si type se establece en HOST_NAME, el valor puede contener letras, dígitos, guiones (-) y puntos (.) y debe comenzar con una letra o un dígito. Si desea utilizar un nombre de dominio comodín, introduzca un asterisco () como la etiqueta más a la izquierda del nombre de dominio. Si type* se establece en PATH y compare_type en STARTS_WITH o EQUAL_TO, el valor debe comenzar con una barra diagonal (/) y puede contener solo letras, dígitos y caracteres especiales _~';@^-%#&$.+?,=!:\|/()[]{} Si type* se establece en METHOD, SOURCE_IP, HEADER, o QUERY_STRING, este parámetro no tendrá efecto, y condicional_pair se utilizará para especificar la clave y el valor. Mínimo: 1 Máximo: 128
provisioning_status	String	Especifica el estado de aprovisionamiento de la regla de reenvío. El valor solo puede ser ACTIVE (predeterminado), PENDING_CREATE o ERROR. Este parámetro no es compatible. Por favor, no lo use.
invert	Boolean	Especifica si se admite la coincidencia inversa. El valor se fija en false. Este parámetro se puede actualizar pero no tendrá efecto.
id	String	Especifica el ID de política de reenvío.
conditions	Array of RuleCondition objects	Especifica las condiciones coincidentes de la regla de reenvío. Este parámetro tendrá efecto cuando enhance_l7policy_enable se establezca en .true. Si se especifican conditions, key y value no tendrán efecto, y el valor de este parámetro contendrá todas las condiciones configuradas para la regla de reenvío. Las claves de la lista deben ser las mismas, mientras que cada valor debe ser único. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.
created_at	String	Especifica la hora a la que se añadió la regla 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 regla 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** RuleCondition
Parámetro	Tipo	Descripción
key	String	Especifica la clave del elemento de coincidencia. Si type se establece en HOST_NAME, PATH, METHOD, o SOURCE_IP, este parámetro se deja en blanco. Si type se establece en HEADER, key indica el nombre del parámetro de encabezado HTTP. El valor puede contener de 1 a 40 caracteres, incluyendo letras, dígitos, guiones (-) y guiones bajos (_). Si type se establece en QUERY_STRING, key indica el nombre del parámetro de consulta. El valor distingue entre mayúsculas y minúsculas y puede contener de 1 a 128 caracteres. Espacios, corchetes ([ ]), corchetes rizados ({ }), corchetes angulares (< >), barras diagonales invertidas (), comillas dobles (" "), libra (#), ampersands (&), las barras verticales (\|), los signos de porcentaje (%) y tilde de la eñe (~) no son compatibles. Todas las claves de la lista de condiciones de la misma regla deben ser las mismas. Mínimo: 1 Máximo: 128
value	String	Especifica el valor del elemento de coincidencia. Si type se establece en HOST_NAME, key se deja en blanco y value indica el nombre de dominio, que puede contener de 1 a 128 caracteres, incluyendo letras, dígitos, guiones (-) puntos (.) y asteriscos (), y debe comenzar con una letra, dígito, o asterisco (). Si desea utilizar un nombre de dominio comodín, introduzca un asterisco () como la etiqueta más a la izquierda del nombre de dominio. Si type* se establece en PATH, key se deja en blanco y value indica la ruta de la solicitud, que puede contener de 1 a 128 caracteres. Si compare_type se establece en STARTS_WITH o EQUAL_TO para la regla de reenvío, el valor debe comenzar con una barra diagonal (/) y puede contener solo letras, dígitos y caracteres especiales _~';@^-%#&$.+?,=!:\|/()[]{} Si type* se establece en HEADER, key indica el nombre del parámetro de encabezado HTTP y value indica el valor del parámetro de encabezado HTTP. El valor puede contener de 1 a 128 caracteres. Se permiten asteriscos () y signos de interrogación (?) pero no se permiten espacios ni comillas dobles. Un asterisco puede coincidir con cero o más caracteres, y un signo de interrogación puede coincidir con 1 carácter. Si type* se establece en QUERY_STRING, key indica el nombre del parámetro de consulta y value indica el valor del parámetro de consulta. El valor distingue entre mayúsculas y minúsculas y puede contener de 1 a 128 caracteres. Espacios, corchetes ([ ]), corchetes rizados ({ }), corchetes angulares (< >), barras diagonales invertidas (), comillas dobles (" "), libra (#), ampersands (&), las barras verticales (\|), los signos de porcentaje (%) y tilde de la eñe (~) no son compatibles. Se permiten asteriscos () y signos de interrogación (?). Un asterisco puede coincidir con cero o más caracteres, y un signo de interrogación puede coincidir con 1 carácter. Si type se establece en METHOD, key* se deja en blanco y value indica el método HTTP. El valor puede ser GET, PUT, POST, DELETE, PATCH, HEAD u OPTIONS. Si type se establece en SOURCE_IP, key se deja en blanco y value indica la dirección IP de origen de la solicitud. El valor es un bloque CIDR IPv4 o IPv6, por ejemplo, 192.168.0.2/32 o 2049::49/64. Todas las claves de la lista de condiciones de la misma regla deben ser las mismas. Mínimo: 1 Máximo: 128

Ejemplo de las solicitudes

GET https://{ELB_Endpoint}/v3/{99a3fff0d03c428eac3678da6a7d0f24}/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be/rules

Ejemplo de las respuestas

Código de estado: 200

Solicitud exitosa.

{
  "rules" : [ {
    "compare_type" : "STARTS_WITH",
    "provisioning_status" : "ACTIVE",
    "project_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "invert" : false,
    "admin_state_up" : true,
    "value" : "/ccc.html",
    "key" : null,
    "type" : "PATH",
    "id" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7"
  } ],
  "page_info" : {
    "previous_marker" : "84f4fcae-9c15-4e19-a99f-72c0b08fd3d7",
    "current_count" : 1
  },
  "request_id" : "ae4dbd7d-9271-4040-98b6-3bfe45bb15ee"
}