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
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. |
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:
|
page_reverse |
No |
Boolean |
Especifica si se va a utilizar la consulta inversa. Valores:
Nota:
|
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:
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.
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
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
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. |
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. |
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.
|
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:
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.
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. |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
Especifica la clave del elemento de coincidencia.
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.
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" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.