Referencia de variables de flujo

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

En esta sección se proporciona información de referencia sobre las variables de flujo.

Apigee define las siguientes variables de flujo:

apigee                 is                       request
apiproduct             loadbalancing            response
apiproxy               message                  route
client                 messageid                servicecallout
current                mint                     system
environment            organization             target
error                  proxy                    variable
fault                  publishmessage           
graphql                ratelimit

Cada una de estas variables se describe en las secciones que aparecen a continuación.

apigee

Una variable auxiliar que proporciona información sobre el tiempo de ejecución de la política.

En la siguiente tabla se describen las propiedades de la variable apigee:

Propiedad Tipo Lectura y escritura Descripción El ámbito empieza
apigee.metrics.policy.policy_name.timeTaken Entero Solo lectura Tiempo, en nanosegundos, que ha tardado en ejecutarse la política. Política

apiproduct

Variable auxiliar que proporciona información sobre los productos de API.

En la siguiente tabla se describen las propiedades de la variable apiproduct:

Propiedad Tipo Lectura y escritura Descripción El ámbito empieza
apiproduct.operation Cadena Solo lectura

Nombre de la operación del producto de API. Esta variable te ayuda a diferenciar entre los ajustes de la política de cuota y los ajustes de cuota de la operación de un producto de API.

Por ejemplo, my-operation.

 Solicitud de proxy
apiproduct.operation.resource Cadena Solo lectura

Nombre del recurso de la operación que coincide con una solicitud.

 Solicitud de proxy
apiproduct.operation.methods Matriz Solo lectura

Una matriz de métodos HTTP que permite la operación que se está comparando.

 Solicitud de proxy
apiproduct.operation.attributes.key_name Matriz Solo lectura

Obtiene el valor del atributo personalizado que coincide con key_name.

 Solicitud de proxy

Para obtener más información, consulta las siguientes secciones:

apiproxy

Describe el proxy de APIs.

En la siguiente tabla se describen las propiedades de la variable apiproxy:

Propiedad Tipo Lectura y escritura Descripción Scope begins
apiproxy.name Cadena Solo lectura Nombre del proxy de API. Por ejemplo, My Proxy. Solicitud de proxy
apiproxy.revision Cadena Solo lectura Número de revisión de un proxy de API. Por ejemplo, 6. Solicitud de proxy
apiproxy.basepath Cadena Solo lectura La ruta base de la implementación (especificada durante la implementación de la API). Solicitud de proxy

Para obtener más información sobre cómo trabajar con proxies de APIs, consulta el artículo Comprender las APIs y los proxies de APIs.

client

La aplicación o el sistema que ha enviado una solicitud al balanceador de carga.

En la siguiente tabla se describen las propiedades de la variable client:

Propiedad Tipo Lectura y escritura Descripción Scope begins
client.cn Cadena Solo lectura

El nombre común especificado en el certificado TLS/SSL presentado por la aplicación cliente.

 Solicitud de proxy
client.country Cadena Solo lectura

El país del certificado TLS/SSL presentado por la aplicación cliente.

 Solicitud de proxy
client.email.address Cadena Solo lectura

La dirección de correo del certificado TLS/SSL presentado por la aplicación cliente.

 Solicitud de proxy
client.host Cadena Solo lectura

La IP del host HTTP asociada a la solicitud recibida por ProxyEndpoint.

 Solicitud de proxy
client.ip Cadena Solo lectura

Dirección IP del cliente o del sistema que envía el mensaje al balanceador de carga. Por ejemplo, podría ser la IP del cliente original o la IP de un balanceador de carga.

 Solicitud de proxy
client.locality Cadena Solo lectura

La localidad (ciudad) del certificado TLS/SSL presentado por el cliente.

 Solicitud de proxy
client.organization Cadena Solo lectura La organización del certificado TLS/SSL presentado por el cliente. (No tiene por qué ser equivalente a la organización de Apigee). Solicitud de proxy
client.organization.unit Cadena Solo lectura

La unidad organizativa del certificado TLS/SSL presentado por el cliente.

 Solicitud de proxy
client.port Entero Solo lectura

Puerto HTTP asociado a la solicitud del cliente de origen a ProxyEndpoint.

 Solicitud de proxy
client.received.end.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que el proxy terminó de recibir la solicitud del cliente de origen en ProxyEndpoint. Por ejemplo: Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Solicitud de proxy
client.received.end.timestamp Long Solo lectura

Valor de marca de tiempo que especifica cuándo terminó el proxy de recibir la solicitud del cliente de origen en ProxyEndpoint. Este valor es un número entero de 64 bits (largo) que contiene el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Solicitud de proxy
client.received.start.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que el proxy empezó a recibir la solicitud del cliente de origen en ProxyEndpoint. Por ejemplo: Wed, 21 Aug 2013 19:16:47 UTC

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Solicitud de proxy
client.received.start.timestamp Long Solo lectura

Valor de marca de tiempo que especifica cuándo empezó el proxy a recibir la solicitud del cliente de origen en ProxyEndpoint. Este valor es un número entero de 64 bits (largo) que contiene el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Solicitud de proxy
client.resolved.ip Cadena Solo lectura

La dirección IP del cliente resuelta. Es el valor determinado a partir de un ajuste de resolución de IP de cliente configurado o del algoritmo predeterminado, si no se especifica ningún ajuste de resolución de IP de cliente. Para obtener más información, consulta el artículo sobre la resolución de la IP del cliente.

 Solicitud de proxy
client.scheme Cadena Solo lectura

Devuelve HTTP o HTTPS en función del transporte que utilice la aplicación cliente para enviar el mensaje de solicitud.

 Solicitud de proxy
client.sent.end.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que el proxy terminó de enviar la respuesta desde ProxyEndpoint al cliente. Por ejemplo: Wed, 21 Aug 2013 19:16:47 UTC.

Este valor es una representación de cadena del client.sent.end.timestamp de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 PostClientFlow
client.sent.end.timestamp Long Solo lectura Valor de marca de tiempo que especifica cuándo ha terminado ProxyEndpoint de devolver la respuesta a la aplicación cliente de origen. Este valor es un entero de 64 bits (largo) que contiene el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC). PostClientFlow
client.sent.start.time Cadena Solo lectura La hora, expresada en formato de cadena, en la que ProxyEndpoint empezó a devolver la respuesta a la aplicación cliente de origen. Por ejemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor es una representación de cadena del client.sent.start.timestamp de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 PostClientFlow
client.sent.start.timestamp Long Solo lectura Cuándo ha empezado el proxy a enviar la respuesta al cliente desde ProxyEndpoint. Este valor se expresa como un número entero de 64 bits (largo) que contiene el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC). PostClientFlow
client.ssl.enabled Cadena Solo lectura

true si ProxyEndpoint está configurado para TLS/SSL; de lo contrario, false.

 Solicitud de proxy
client.state Cadena Solo lectura

El estado del certificado TLS/SSL presentado por el cliente.

 Solicitud de proxy

current

Contiene información sobre el flujo del proxy de API actual.

En la siguiente tabla se describen las propiedades de la variable current:

Propiedad Tipo Lectura y escritura Descripción Scope begins
current.flow.name Cadena Solo lectura Nombre del flujo que se está ejecutando (por ejemplo, PreFlow, PostFlow o el nombre de un flujo condicional). Solicitud de proxy
current.flow.description Cadena Solo lectura Descripción del flujo que se está ejecutando. Es el mismo valor que el del elemento <Description> en la configuración XML del flujo. Solicitud de proxy

Puede ver estas propiedades en la vista de seguimiento de la interfaz de usuario de Apigee.

environment

Contenedor de la propiedad environment.name.

En la siguiente tabla se describen las propiedades de la variable environment:

Propiedad Tipo Lectura y escritura Descripción Scope begins
environment.name Cadena Solo lectura Nombre del entorno en el que se ha ejecutado la transacción. Solicitud de proxy

error

Objeto contextual que representa un mensaje de error en el flujo de errores.

En la siguiente tabla se describen las propiedades de la variable error:

Propiedad Tipo Lectura y escritura Descripción Scope begins
error message Lectura y escritura Error de tipo message, que es un objeto contextual en el flujo de errores. Error
error.content Cadena Lectura y escritura Contenido del error. Error
error.message Cadena Solo lectura

Mensaje asociado a un error, cuyo valor solo está disponible antes de que se ejecute el flujo de errores.

 Error
error.status.code Entero Solo lectura

El código de estado HTTP asociado al error. Por ejemplo, 400.

 Error
error.transport.message TransportMessage Solo lectura

Cualquier error de tipo TransportMessage.

 Error
error.state Entero Solo lectura

Estado del flujo en el que se ha producido un error.

 Error
error.header.header_name Cadena Lectura y escritura

Obtiene o define el encabezado de la respuesta.

 Error

fault

Proporciona información sobre la fuente, el motivo y los detalles de un error de tiempo de ejecución. Apigee define estas variables cuando una política genera un error. Los valores son específicos de cada política. Para saber cuándo se definen las variables fault, consulta el artículo Acerca de los errores de políticas.

Propiedad Tipo Lectura y escritura Descripción Scope begins
fault.name Cadena Solo lectura El nombre del error, tal como se describe en la tabla Errores de tiempo de ejecución incluida en cada tema de referencia de la política. Esta variable puede ser útil en las condiciones aplicadas a FaultRules. Error
fault.reason Cadena Solo lectura El motivo del error. Por ejemplo, cuando la política OASValidation detecta que una solicitud entrante no se valida con la especificación OpenAPI, asignará a esta variable una cadena que describa el nombre de la política, el nombre de la especificación y el detalle que explica por qué la solicitud no se valida con la especificación. Otras políticas asignarán a esta variable mensajes adecuados para sus errores. Error
fault.category Cadena Solo lectura La categoría. Por ejemplo, si el error se produce en un paso de una política, esta variable puede contener el valor "Step". Esta variable puede ser útil en las condiciones aplicadas a FaultRules. Error
fault.subcategory Cadena Solo lectura La subcategoría. Por ejemplo, si la política OASValidation detecta que una solicitud no se valida con una especificación OpenAPI, asignará a esta variable el valor "OASValidationFailure". Esta variable puede ser útil en las condiciones aplicadas a FaultRules. Error

graphql

Te da acceso a los resultados de una consulta GraphQL en el tiempo de ejecución. Para obtener más información, consulta la política de GraphQL.

En la siguiente tabla se describen las propiedades de la variable graphql:

Propiedad Tipo Lectura y escritura Descripción
graphql Tipo complejo SOLO LECTURA/LECTURA Y ESCRITURA Consulta raíz de GraphQL. SCOPE
graphql.fragment Tipo complejo SOLO LECTURA/LECTURA Y ESCRITURA Referencia al fragmento predeterminado de esta consulta. SCOPE
graphql.fragment.count Entero Solo lectura Número de fragmentos generados por esta consulta de GraphQL. SCOPE
graphql.fragment.INDEX.selectionSet.INDEX TIPO SOLO LECTURA/LECTURA Y ESCRITURA Referencia al conjunto de selección en el índice especificado. SCOPE
graphql.fragment.INDEX.selectionSet.INDEX.name Cadena SOLO LECTURA/LECTURA Y ESCRITURA Nombre del conjunto de selección en el índice especificado. SCOPE
graphql.fragment.INDEX.selectionSet.count Entero Solo lectura Número de conjuntos de selección de este fragmento. SCOPE
graphql.fragment.INDEX.selectionSet.name Cadena SOLO LECTURA/LECTURA Y ESCRITURA Nombre del conjunto de selección predeterminado del fragmento. SCOPE
graphql.operation Tipo complejo SOLO LECTURA/LECTURA Y ESCRITURA Referencia a la operación predeterminada de la consulta.

No puedes definir cuotas a nivel de operación. En su lugar, defínelas en el nivel del entorno.

 SCOPE
graphql.operation.name Cadena Solo lectura Nombre de la operación predeterminada de la consulta. SCOPE
graphql.operation.operationType Enumeración Solo lectura El tipo de operación predeterminada de la consulta que se puede ejecutar en este proxy de API. Los valores posibles son: query, mutation o all. SCOPE
graphql.operation.selectionSet Tipo complejo La selección predeterminada establecida para la operación predeterminada de la consulta. SCOPE
graphql.operation.selectionSet.count Entero Solo lectura Número de conjuntos de selección en la operación predeterminada de la consulta. SCOPE
graphql.operation.selectionSet.name Cadena Solo lectura Nombre del conjunto de selección predeterminado de la operación predeterminada de la consulta. SCOPE
graphql.operation.selectionSet.INDEX Entero Solo lectura Referencia al conjunto de selección en el índice especificado de la lista de conjuntos de selección. SCOPE
graphql.operation.selectionSet.INDEX.name Cadena Solo lectura Nombre de la selección en el índice especificado de la lista de conjuntos de selección de esta operación. SCOPE
graphql.operation.selectionSet.INDEX.[selectionSet] Tipo complejo SOLO LECTURA/LECTURA Y ESCRITURA Uno o varios objetos de conjunto de selección adicionales.

Se puede acceder a los conjuntos de selección de forma recursiva. Por ejemplo, después de un selectionSet.index, puedes tener otro selectionSet.index en lugar de una propiedad name. Después, se repetirá el proceso hasta que se alcance el valor de <MaxCount> que hayas definido en la política de GraphQL.

SCOPE
graphql.operation.selectionSet.INDEX.directive Tipo complejo Una referencia a la directiva predeterminada del conjunto de selecciones especificado. SCOPE
graphql.operation.selectionSet.INDEX.directive.count Tipo complejo SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX Entero Solo lectura Referencia a la directiva en el índice especificado. SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX Entero Solo lectura Referencia al argumento en el índice especificado. SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name Cadena Nombre del argumento en el índice especificado. SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value Cadena El valor del argumento en el índice especificado. SCOPE
graphql.operation.selectionSet.INDEX.directive.name Cadena SCOPE
graphql.operation.variableDefinitions Tipo complejo Referencia a una lista de definiciones de variables de la operación predeterminada de la consulta. SCOPE
graphql.operation.variableDefinitions.count Entero Número de definiciones de variables de la operación predeterminada de la consulta. SCOPE
graphql.operation.variableDefinitions.INDEX Entero Referencia a la definición de la variable en el índice especificado. SCOPE
graphql.operation.variableDefinitions.INDEX.name Cadena Nombre de la definición de la variable en el índice especificado. SCOPE
graphql.operation.variableDefinitions.INDEX.type El tipo del valor de la definición de la variable en el índice especificado. SCOPE

is

Contenedor de la propiedad is.error.

En la siguiente tabla se describen las propiedades de la variable is:

Propiedad Tipo Lectura y escritura Descripción Scope begins
is.error Booleano Solo lectura

Marca de error.

 Solicitud de proxy

loadbalancing

Proporciona información sobre el estado del balanceo de carga de TargetEndpoint.

En la siguiente tabla se describen las propiedades de la variable loadbalancing:

Propiedad Tipo Lectura y escritura Descripción Scope begins
loadbalancing.failedservers Conjunto de cadenas Solo lectura

Lista de TargetServers que han fallado durante el balanceo de carga en TargetEndpoint.

 Respuesta objetivo
loadbalancing.isfallback Booleano Solo lectura

true si la alternativa está habilitada para el TargetServer invocado durante el balanceo de carga en TargetEndpoint.

 Respuesta objetivo
loadbalancing.targetserver Cadena Solo lectura

TargetServer invocado durante el balanceo de carga en TargetEndpoint. Solo se define si el elemento <Path> se define al definir el elemento del balanceador de carga.

 Respuesta objetivo

message

Un objeto contextual con el mismo valor que request en el flujo de la solicitud, response en el flujo de la respuesta o error en el flujo de errores.

En la siguiente tabla se describen las propiedades de la variable message:

Propiedad Tipo Lectura y escritura Descripción Scope begins
message message Lectura y escritura

Un objeto contextual con el mismo valor que request en el flujo de solicitud, response en el flujo de respuesta o error en el flujo de error.

 Solicitud de proxy
message.content Cadena Lectura y escritura

Contenido de la solicitud, la respuesta o el mensaje de error.

 Solicitud de proxy
message.content.as.base64 Cadena Solo lectura

Contenido de la carga útil codificado en Base64 de la solicitud, la respuesta o el mensaje de error.

 Solicitud de proxy
message.content.as.url.safe.base64 Cadena Solo lectura

Contenido de la carga útil codificado en base64 seguro para URLs de la solicitud, la respuesta o el mensaje de error.

 Solicitud de proxy
message.formparam.param_name Cadena Lectura y escritura

Valor del parámetro de formulario especificado.

 Solicitud de proxy
message.formparam.param_name.
 values		 Colección Solo lectura

Todos los valores del parámetro de formulario especificado en el mensaje.

 Solicitud de proxy
message.formparam.param_name.
 values.count		 Entero Solo lectura

Recuento de los valores de los parámetros de formulario especificados en el mensaje.

 Solicitud de proxy
message.formparams.count Entero Solo lectura

Recuento de todos los parámetros de formulario del mensaje.

 Solicitud de proxy
message.formparams.names Colección Solo lectura

Valor de todos los parámetros del formulario del mensaje.

 Solicitud de proxy
message.formparams.names.string Cadena Solo lectura

Lista separada por comas de los nombres de todos los parámetros del formulario del mensaje.

 Solicitud de proxy
message.formstring Cadena Solo lectura

Valor de la cadena de formulario del mensaje.

 Solicitud de proxy
message.header.header_name Cadena Lectura y escritura

Obtiene o define el valor de un encabezado concreto que se encuentra en la solicitud. Si el encabezado contiene una coma, al leerlo, solo recibirás el segmento de texto hasta la primera coma.

Por ejemplo, si el encabezado Cache-control es public, maxage=16544, el valor devuelto de message.header.cache-control es public.

Si quieres que todo el encabezado sea una cadena, usa una variable como message.header.header_name.values.string.

 Solicitud de proxy
message.header.header_name.N Cadena Lectura y escritura

El valor del encabezado Nth particular del mensaje, ya sea de solicitud o de respuesta, en función del estado del flujo. Apigee divide los valores de texto de los encabezados por comas. El índice empieza por 1 para el valor situado más a la izquierda.

Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor devuelto de message.header.cache-control.2 es maxage=16544.

 Solicitud de proxy
message.header.header_name.
 values		 Colección Solo lectura

Todos los valores del nombre del encabezado HTTP especificado en el mensaje.

 Solicitud de proxy
message.header.header_name.
 values.count		 Entero Solo lectura

Número de valores del nombre del encabezado HTTP especificado en el mensaje.

 Solicitud de proxy
message.header.header_name.
 values.string		 Cadena Solo lectura

Todos los valores de un encabezado concreto del mensaje, en forma de una sola cadena.

Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor devuelto de message.header.cache-control.values.string es public,maxage=16544.

 Solicitud de proxy
message.headers.count Entero Solo lectura

Recuento de todos los encabezados HTTP del mensaje.

 Solicitud de proxy
message.headers.names Colección Solo lectura

Valor de todos los encabezados HTTP del mensaje.

 Solicitud de proxy
message.headers.names.string Cadena Solo lectura

Lista separada por comas de los nombres de todos los encabezados del mensaje.

 Solicitud de proxy
message.path Cadena Lectura y escritura

Ruta completa del mensaje de solicitud en la URL, sin incluir los parámetros de consulta.

Solicitud de proxy
message.queryparam.param_name Cadena Solo lectura

Devuelve el parámetro de consulta de mensaje especificado.

 Solicitud de proxy
message.queryparam.param_name.N Cadena Lectura y escritura

El valor del parámetro de consulta Nth del mensaje. Por ejemplo, si request.querystring es a=hello&a=world, el valor devuelto de message.queryparam.a.1 es hello.

Para escribir varios valores para un solo nombre de parámetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, define lo siguiente:

  • De message.queryparam.type.1 a siteid:1
  • De message.queryparam.type.2 a language:en-us
  • De message.queryparam.type.3 a currency:USD
 Solicitud de proxy
message.queryparam.param_name.
 values		 Colección Solo lectura

Todos los valores de un parámetro de consulta concreto del mensaje, con el formato de una lista separada por comas.

Por ejemplo, si la cadena de consulta es a=hello&a=world, el valor de message.queryparam.a.values es ['hello', 'world']code>.

 Solicitud de proxy
message.queryparam.param_name.
 values.count		 Entero Solo lectura

El recuento total de un parámetro de consulta especificado asociado a la solicitud enviada al ProxyEndpoint desde la aplicación cliente.

 Solicitud de proxy
message.queryparams.count Entero Solo lectura

El recuento total de todos los parámetros de consulta asociados a la solicitud enviada al ProxyEndpoint desde la aplicación cliente.

 Solicitud de proxy
message.queryparams.names Colección Solo lectura

Lista de todos los nombres de parámetros de consulta asociados a la solicitud enviada al ProxyEndpoint desde la aplicación cliente.

 Solicitud de proxy
message.queryparams.names.string Cadena Solo lectura

Lista separada por comas de los nombres de todos los parámetros de consulta del mensaje.

 Solicitud de proxy
message.querystring Cadena Solo lectura

Cadena que contiene todos los nombres y valores de los parámetros de consulta asociados a la solicitud enviada a ProxyEndpoint desde la aplicación cliente.

Por ejemplo, en la solicitud http://api.apifactory.com/inventors?name=nick&surname=danger, el valor de message.querystring es name=nick&surname=danger.

 Solicitud de proxy
message.status.code Entero Solo lectura

Código de estado HTTP del mensaje de respuesta del destino.

 Respuesta objetivo
message.transport.message TransportMessage Solo lectura

Mensaje de tipo TransportMessage, que es un objeto contextual.

 Solicitud de proxy
message.uri Cadena Solo lectura

La ruta URI completa (después de la URL del dominio), incluidos los parámetros de consulta.

Por ejemplo, en la solicitud http://api.apifactory.com/inventors?name=nikola&surname=tesla, esta variable devuelve inventors?name=nikola&surname=tesla.

 Solicitud de proxy
message.verb Cadena Solo lectura

Verbo HTTP (GET, PUT, POST, DELETE, etc.) asociado a la solicitud.

 Solicitud de proxy
message.version Cadena Lectura y escritura

Versión HTTP asociada a la solicitud enviada a ProxyEndpoint desde la aplicación cliente.

 Solicitud de proxy

Para obtener más información sobre los mensajes, consulta la referencia de las funciones de plantillas de mensajes.

messageid

Contenedor del ID único global de la solicitud.

En la siguiente tabla se describen las propiedades de la variable messageid:

Propiedad Tipo Lectura y escritura Descripción Scope begins
messageid Cadena Solo lectura

Contiene el ID único global de la solicitud, que incluye el nombre de host del balanceador de carga. Este ID permite hacer un seguimiento de las solicitudes recibidas en el balanceador de carga después de que se envíen al procesador de mensajes.

Este ID se registra en los registros de errores de Apigee para correlacionar el messageid con los errores.

 Solicitud de proxy

mint

Una variable auxiliar que proporciona información sobre la monetización.

En la siguiente tabla se describen las propiedades de la variable mint:

Propiedad Tipo Lectura y escritura Descripción Scope begins
mint.limitscheck.is_request_blocked Booleano Solo lectura

Marca que especifica si la solicitud de la API está bloqueada. Su valor debe ser true si is_subscription_found es false.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.limitscheck.is_subscription_found Booleano Solo lectura

Marca que especifica si el desarrollador tiene una suscripción activa al producto de la API. Se define como true si un desarrollador tiene una suscripción.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.limitscheck.prepaid_developer_balance Numérico Solo lectura

Saldo actual de la cartera de la cuenta de prepago del desarrollador asociada a la moneda del plan de tarifas.

 Solicitud de proxy
mint.limitscheck.prepaid_developer_currency Cadena Solo lectura

Moneda del saldo disponible en la variable mint.limitscheck.prepaid_developer_balance.

 Solicitud de proxy
mint.limitscheck.purchased_product_name Cadena Solo lectura

Nombre del producto de API asociado.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.limitscheck.status_message Cadena Solo lectura

Información adicional sobre la ejecución de la política MonetizationLimitsCheck con fines de depuración.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.mintng_consumption_pricing_rates Cadena Solo lectura

Comisiones basadas en el consumo.

Define las comisiones al crear un plan de tarifas.

 PostClientFlow
mint.mintng_consumption_pricing_type Cadena Solo lectura

Tipo de precio basado en el consumo. Por ejemplo: FIXED_PER_UNIT

Define las tarifas basadas en el consumo al crear un plan de tarifas.

 PostClientFlow
mint.mintng_currency Cadena Solo lectura

Moneda para calcular los ingresos.

Esta variable de flujo tiene el valor de la currency variable de monetización.

 Política de DataCapture
mint.mintng_dev_share Numérico Solo lectura

Ingresos que se compartirán con el desarrollador.

Define los ingresos que se compartirán con el desarrollador al crear un plan de precios.

 PostClientFlow
mint.mintng_is_apiproduct_monetized Booleano Solo lectura

Marca que especifica si el producto de API se está monetizando (es decir, si hay un plan de tarifas activo en vigor).

Esta variable de flujo se añade mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Añadir una política de autenticación.

 Solicitud de proxy
mint.mintng_price Numérico Solo lectura

Ingresos para calcular la parte del desarrollador.

La variable de flujo tiene el valor de la revShareGrossPrice variable de monetización.

 Política de DataCapture y PostClientFlow
mint.mintng_price_multiplier Numérico Solo lectura

Factor (multiplicador) por el que se multiplica el coste por transacción.

La variable de flujo tiene el valor de la perUnitPriceMultiplier variable de monetización.

 Política de DataCapture y PostClientFlow
mint.mintng_rate Numérico Solo lectura

Tarifa cobrada por la llamada a la API.

Esta variable de flujo muestra la tarifa basada en el consumo por llamada a la API. Define la tarifa basada en el consumo al crear un plan de tarifas. Si ha configurado la perUnitPriceMultiplier variable de monetización en su política DataCapture, Apigee calcula el coste de la transacción después de tener en cuenta el valor de la variable perUnitPriceMultiplier. Para obtener más información, consulta Api price multiplier en Métricas.

 PostClientFlow
mint.mintng_rate_before_multipliers Numérico Solo lectura

Tarifa cobrada por la llamada a la API sin el cálculo de perUnitPriceMultiplier.

Si la política DataCapture captura la perUnitPriceMultiplier variable de monetización, esta variable de flujo muestra el coste de la transacción antes de multiplicar el coste por perUnitPriceMultiplier.

 PostClientFlow
mint.mintng_rate_plan_id Cadena Solo lectura

ID del plan de tarifas.

Esta variable de flujo se añade mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Añadir una política de autenticación.

 Solicitud de proxy
mint.mintng_revenue_share_rates Cadena Solo lectura

Porcentajes del reparto de ingresos.

Define el porcentaje de reparto de ingresos al crear un plan de tarifas.

 PostClientFlow
mint.mintng_revenue_share_type Cadena Solo lectura

Tipo de reparto de ingresos. Por ejemplo: FIXED

Define el tipo de reparto de ingresos al crear un plan de tarifas.

 PostClientFlow
mint.mintng_tx_success Booleano Solo lectura

Especifica si la transacción se monetiza.

Esta variable de flujo tiene el valor de la transactionSuccess variable de monetización.

 Política de DataCapture
mint.prepaid_updated_developer_usage Numérico Solo lectura

Uso actual del desarrollador de prepago.

El uso se calcula en función de la configuración de tu plan de tarifas y del valor de la variable de monetización perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Numérico Solo lectura

Tiempo de vencimiento del plan de tarifas en milisegundos desde el inicio del registro de tiempo.

Esta variable de flujo se añade mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Añadir una política de autenticación.

 Solicitud de proxy
mint.rateplan_start_time_ms Numérico Solo lectura

Hora de activación del plan de tarifas en milisegundos desde el inicio del registro de tiempo.

Esta variable de flujo se añade mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Añadir una política de autenticación.

 Solicitud de proxy
mint.status Cadena Solo lectura

Estado de la llamada monetizada. Solo se rellena si se produce un error.

 PostClientFlow
mint.status_code Numérico Solo lectura

Código de estado HTTP de la llamada monetizada. Solo se rellena si se produce un error.

 PostClientFlow
mint.subscription_end_time_ms Numérico Solo lectura

Tiempo de vencimiento de la suscripción al producto de API en milisegundos desde el inicio del registro de tiempo.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.subscription_start_time_ms Numérico Solo lectura

Hora de activación de la suscripción al producto de la API en milisegundos desde el inicio del registro de tiempo.

Esta variable de flujo está disponible si la política MonetizationLimitsCheck está asociada al proxy de API. Consulta las variables de flujo de MonetizationLimitsChecks.

 Solicitud de proxy
mint.tx_success_result Booleano Solo lectura

Indica si la monetización de la transacción se ha realizado correctamente.

La variable mint.tx_success_result puede tener los siguientes valores:

  • tx_success tiene el valor true: la variable transactionSuccess es true y la transacción se monetiza. Como la transacción se monetiza, se calculan los valores de las variables mint.mintng_rate y mint.mintng_dev_share.
  • tx_success se ha definido como false: la variable transactionSuccess es false y la transacción no se monetiza. Como la transacción no está monetizada, no se calculan los valores de las variables mint.mintng_rate y mint.mintng_dev_share.
  • No se ha encontrado tx_success. El código de estado del mensaje no era 2xx: la variable transactionSuccess no se ha registrado y el código de estado HTTP (message.status.code) de la transacción no es 2xx. La transacción no se monetiza.
  • No se ha encontrado tx_success. El código de estado del mensaje era 2xx: la variable transactionSuccess no se captura y el código de estado HTTP (message.status.code) de la transacción es 2xx. La transacción está monetizada.
 PostClientFlow

Para obtener más información, consulta las siguientes secciones:

organization

Contenedor de la propiedad organization.name.

En la siguiente tabla se describen las propiedades de la variable organization:

Propiedad Tipo Lectura y escritura Descripción Scope begins
organization.name Cadena Solo lectura

Nombre de la organización.

 Solicitud de proxy

Para obtener más información sobre las organizaciones, consulta el artículo Información sobre las organizaciones.

proxy

La configuración del proxy de API.

En la siguiente tabla se describen las propiedades de la variable proxy:

Propiedad Tipo Lectura y escritura Descripción Scope begins
proxy.basepath Cadena Solo lectura

El valor de la ruta base en la configuración del endpoint de tu proxy de API. La ruta base es el fragmento de URI situado más a la izquierda que sigue al host en la URL. Los URIs de flujo condicional siguen la ruta base.

Supongamos que tiene un endpoint de proxy de API configurado con una ruta base /v2/weatherapi. Para obtener más información, consulta Configuración del endpoint de proxy. En ese caso, si la solicitud entrante usa la URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, ocurrirá lo siguiente:

  • El nombre de host es myhost.example.net. Para obtenerlo, lee la variable request.header.host.
  • La ruta base es /v2/weatherapi. Para obtenerlo, lea la variable proxy.basepath.
  • El sufijo de la ruta es /forecastrss. Para obtenerlo, lea la variable proxy.pathsuffix.

Si define una ruta base dinámica en la configuración de su proxy de API, como /v2/*/weatherapicode>, la variable proxy.basepath se define como la ruta dinámica. Para obtener la URL real de la solicitud, lee y analiza la variable proxy.url.

 Solicitud de proxy
proxy.client.ip Cadena Solo lectura

La dirección X-Forwarded-For de la llamada entrante, que es la dirección IP que Apigee ha recibido del último handshake TCP externo. Puede ser el cliente que llama o un balanceador de carga.

 Solicitud de proxy
proxy.name Cadena Solo lectura

El atributo name configurado para ProxyEndpoint.

 Solicitud de proxy
proxy.pathsuffix Cadena Solo lectura

Valor del sufijo de la ruta de la URL que se envía desde el cliente y se recibe en el ProxyEndpoint.

La ruta base es el componente de ruta situado más a la izquierda que identifica de forma única un proxy de API en un grupo de entornos. Supongamos que tienes un endpoint de proxy de API configurado con una ruta base /v2/weatherapi. En ese caso, si se envía una solicitud a https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, la variable proxy.pathsuffix contendrá la cadena /forecastrss.

 Solicitud de proxy
proxy.url Cadena Solo lectura

Obtiene la URL completa asociada a la solicitud de proxy recibida por ProxyEndpoint, incluidos los parámetros de consulta presentes.

 Solicitud de proxy

Para obtener más información sobre cómo trabajar con proxies de APIs, consulta el artículo Comprender las APIs y los proxies de APIs.

publishmessage

Se rellena cuando se ejecuta la política PublishMessage.

Propiedad Tipo Lectura y escritura Descripción Scope begins
publishmessage.message.id Cadena Solo lectura Devuelve el messageId (ID del mensaje publicado) del servidor Pub/Sub.

Apigee define esta variable de flujo solo si la solicitud de publicación se realiza correctamente.

 Solicitud de proxy

ratelimit

Se rellena cuando se ejecuta una política de cuota o de SpikeArrest.

En la siguiente tabla se describen las propiedades de la variable ratelimit:

Propiedad Tipo Lectura y escritura Descripción Scope begins
ratelimit.policy_name.allowed.count Long Solo lectura Devuelve el recuento de cuota permitido. PostClientFlow
ratelimit.policy_name.used.count Long Solo lectura Devuelve la cuota actual usada en un intervalo de cuota. PostClientFlow
ratelimit.policy_name.available.count Long Solo lectura Devuelve el número de cuotas disponibles en el intervalo de cuota. PostClientFlow
ratelimit.policy_name.exceed.count Long Solo lectura Devuelve 1 cuando se supera la cuota. PostClientFlow
ratelimit.policy_name.total.exceed.count Long Solo lectura Devuelve 1 cuando se supera la cuota. PostClientFlow
ratelimit.policy_name.expiry.time Long Solo lectura

Devuelve la hora UTC (en milisegundos), que determina cuándo vence la cuota y cuándo empieza el nuevo intervalo de cuota.

Cuando el tipo de la política de cuota es rollingwindow, este valor no es válido porque el intervalo de cuota nunca caduca.

 PostClientFlow
ratelimit.policy_name.identifier Cadena Solo lectura Devuelve la referencia del identificador (de cliente) adjunta a la política. PostClientFlow
ratelimit.policy_name.class Cadena Solo lectura Devuelve la clase asociada al identificador de cliente. PostClientFlow
ratelimit.policy_name.class.allowed.count Long Solo lectura Devuelve el recuento de cuota permitido definido en la clase. PostClientFlow
ratelimit.policy_name.class.used.count Long Solo lectura Devuelve la cuota utilizada en una clase. PostClientFlow
ratelimit.policy_name.class.available.count Long Solo lectura Devuelve el número de cuotas disponibles en la clase. PostClientFlow
ratelimit.policy_name.class.exceed.count Long Solo lectura Devuelve el número de solicitudes que supera el límite de la clase en el intervalo de cuota actual. PostClientFlow
ratelimit.policy_name.class.total.exceed.count Long Solo lectura Devuelve el número total de solicitudes que superan el límite de la clase en todos los intervalos de cuota, por lo que es la suma de class.exceed.count de todos los intervalos de cuota. PostClientFlow
ratelimit.policy_name.failed Booleano Solo lectura

Indica si la política ha fallado (true o false).

 PostClientFlow

Para obtener más información, consulta las siguientes secciones:

request

La solicitud completa, incluida la carga útil.

Para obtener más información sobre los datos de solicitud, consulta ¿Cómo se transfieren los datos de solicitud al servidor backend?

En la siguiente tabla se describen las propiedades de la variable request:

Propiedad Tipo Lectura y escritura Descripción Scope begins
request message Solo lectura

La solicitud completa, incluida la carga útil.

 Solicitud de proxy
request.content Cadena Lectura y escritura

Obtiene o establece la carga útil del mensaje de solicitud.

 Solicitud de proxy
request.content.as.base64 Cadena Solo lectura

Contenido de la carga útil codificado en Base64 del mensaje de solicitud.

 Solicitud de proxy
request.content.as.url.safe.base64 Cadena Solo lectura

Contenido de la carga útil codificado en base64 seguro para URLs del mensaje de solicitud.

 Solicitud de proxy
request.formparam.param_name Cadena Lectura y escritura

Obtiene o establece el valor del parámetro de formulario especificado en la solicitud enviada desde la aplicación cliente.

 Solicitud de proxy
request.formparam.param_name.
 values		 Colección Solo lectura

Todos los valores de un parámetro de formulario concreto de la solicitud, con el formato de una lista separada por comas.

Por ejemplo, si la carga útil es a=hello&x=greeting&a=world, el valor de request.formparam.a.values es ['hello', 'world'].

 Solicitud de proxy
request.formparam.param_name.
 values.count		 Entero Solo lectura

Número de todos los valores del parámetro de formulario especificado asociado a la solicitud.

 Solicitud de proxy
request.formparam.param_name.N Cadena Lectura y escritura

El valor del parámetro de formulario Nth concreto del mensaje. Por ejemplo, si la cadena del formulario es a=hello&a=world, el valor devuelto de request.formparam.a.1 es hello.

 Solicitud de proxy
request.formparams.count Entero Solo lectura

Recuento de todos los parámetros asociados a la solicitud enviada desde la aplicación cliente.

 Solicitud de proxy
request.formparams.names Colección Solo lectura

Lista de todos los nombres de parámetros asociados a la solicitud.

 Solicitud de proxy
request.formparams.names.string Cadena Solo lectura

Lista separada por comas de todos los nombres de parámetros de formulario asociados a la solicitud.

 Solicitud de proxy
request.formstring Cadena Solo lectura

El formparam completo de la solicitud enviada desde la aplicación cliente.

Por ejemplo, name=test&type=first&group=A.

 Solicitud de proxy
request.grpc.rpc.name Cadena Solo lectura

Solo aplicable cuando se usa un servidor de destino gRPC. El nombre de la RPC. Para obtener información sobre los proxies gRPC, consulta Crear proxies de API gRPC.

Solicitud de proxy
request.grpc.service.name Cadena Solo lectura

Solo aplicable cuando se usa un servidor de destino gRPC. Nombre del servicio de estado de gRPC. Para obtener información sobre los proxies gRPC, consulta Crear proxies de API gRPC.

Solicitud de proxy
request.header.header_name Cadena Lectura y escritura

Obtiene o define el valor de un encabezado concreto que se encuentra en la solicitud. Si el encabezado contiene una coma, al leerlo, solo recibirás el segmento de texto hasta la primera coma.

Por ejemplo, si el encabezado Cache-control es public, maxage=16544, el valor devuelto de request.header.cache-control es public.

Si quieres que todo el encabezado sea una cadena, usa una variable como request.header.header_name.values.string.

 Solicitud de proxy
request.header.header_name.N Cadena Lectura y escritura

El valor del Nth encabezado concreto de la solicitud. Apigee divide los valores de texto de los encabezados por comas. El índice empieza por 1 para el valor situado más a la izquierda.

Por ejemplo, si el encabezado Cache-control es public, maxage=16544, el valor devuelto de request.header.cache-control.2 es maxage=16544.

 Solicitud de proxy
request.header.header_name.
 values		 Colección Solo lectura

Todos los valores de un encabezado concreto de la solicitud.

 Solicitud de proxy
request.header.header_name.
 values.count		 Entero Solo lectura

Recuento de todos los valores de un encabezado concreto de la solicitud.

 Solicitud de proxy
request.header.header_name.
 values.string		 Cadena Solo lectura

Todos los valores de un encabezado concreto de la solicitud, en forma de una sola cadena.

Por ejemplo, si el encabezado Cache-control es public, maxage=16544, el valor devuelto de request.header.cache-control.values.string es public, maxage=16544.

 Solicitud de proxy
request.headers.count Entero Solo lectura

Recuento de todos los encabezados de la solicitud.

 Solicitud de proxy
request.headers.names Colección Solo lectura

Nombres de todos los encabezados de la solicitud.

 Solicitud de proxy
request.headers.names.string Cadena Solo lectura

Lista separada por comas con los nombres de todos los encabezados de la solicitud.

 Solicitud de proxy
request.path Cadena Solo lectura

La ruta del recurso sin proxy (sin incluir el host) al servicio de backend, sin incluir los parámetros de consulta.

Por ejemplo, si el URI del servicio de backend es https://example.com/rest/api/latest, el valor de request.path es /rest/api/latest.

 Solicitud de proxy
request.queryparam.param_name Cadena Lectura y escritura

El valor de un parámetro de consulta concreto que se encuentra en la solicitud.

 Solicitud de proxy
request.queryparam.param_name.N Cadena Lectura y escritura

Valor del parámetro de consulta Nth de la solicitud.

Por ejemplo, si request.querystring es a=hello&a=world, el valor devuelto de request.queryparam.a.1 es hello.

Para ver un ejemplo de cómo escribir varios valores para un solo nombre de parámetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, define lo siguiente:

  • De request.queryparam.type.1 a siteid:1
  • De request.queryparam.type.2 a language:en-us
  • De request.queryparam.type.3 a currency:USD
 Solicitud de proxy
request.queryparam.param_name.
 values		 Colección Solo lectura

Todos los valores de un parámetro de consulta concreto de la solicitud, con el formato de una lista separada por comas.

Por ejemplo, si request.querystring es a=hello&b=lovely&a=world, el valor de request.queryparam.a.values es ['hello', 'world'].

 Solicitud de proxy
request.queryparam.param_name.
 values.count		 Entero Solo lectura

Número de todos los valores de un parámetro de consulta concreto en la solicitud.

 Solicitud de proxy
request.queryparams.count Entero Solo lectura

Número de todos los parámetros de consulta de la solicitud.

 Solicitud de proxy
request.queryparams.names Colección Solo lectura

Los nombres de todos los parámetros de consulta de la solicitud.

 Solicitud de proxy
request.queryparams.names.string Cadena Solo lectura

Lista separada por comas de los nombres de todos los parámetros de consulta de la solicitud.

 Solicitud de proxy
request.querystring Cadena Solo lectura

Lista completa de los parámetros de consulta de la solicitud enviada desde la aplicación cliente.

Por ejemplo, si la solicitud es http://host.com/123?name=first&surname=second&place=address, esta variable devuelve name=first&surname=second&place=address.

 Solicitud de proxy
request.transportid Cadena Solo lectura

ID de la solicitud como tipo TransportMessage, que es contextual.

 Solicitud de proxy
request.transport.message Transport-Message Solo lectura

Solicitud de tipo TransportMessage que es contextual.

 Solicitud de proxy
request.uri Cadena Solo lectura

En un proxy de API, el <BasePath> del proxy en ProxyEndpoint (además de la URL base del proxy) se asigna a la URL del servicio de destino en TargetEndpoint. Por ejemplo:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

Points to (Apunta a)

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

En la solicitud, request.uri es la ruta base del proxy más el resto de la dirección, incluidos los parámetros de consulta.

En la respuesta, request.uri es el resto de la dirección, incluidos los parámetros de consulta, después de HTTPTargetConnection.

La diferencia se debe a que la solicitud original llegó al proxy, pero el proxy hace otra solicitud al servicio de destino.

Supongamos que se hace la siguiente llamada a nuestro proxy de ejemplo, que tiene una ruta base /my-mock-proxy:

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

Y las llamadas proxy:

http://mocktarget.apigee.net

Se añade /user?user=Dude a esa URL.

  • Solicitud: request.uri = /my-mock-proxy/user?user=Dude
  • Respuesta: request.uri = /user?user=Dude
 Solicitud de proxy (difiere en la respuesta)
request.url Cadena Solo lectura

La URL completa de la solicitud enviada al endpoint de destino, incluidos los parámetros de cadena de consulta, pero no el número de puerto (si se ha especificado).

Por ejemplo, si haces una llamada a un proxy de muestra http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude y el endpoint de destino es http://example.com:8080, el valor es el siguiente:

  • Solicitud: n/a
  • Respuesta: http://example.com/user?user=Dude
 Respuesta objetivo
request.verb Cadena Solo lectura

Verbo HTTP usado en la solicitud. Por ejemplo, GET, PUT y DELETE.

 Solicitud de proxy
request.version Cadena Solo lectura

Versión HTTP de la solicitud. Por ejemplo, 1.1.

 Solicitud de proxy

response

La respuesta completa, incluida cualquier carga útil presente.

En la siguiente tabla se describen las propiedades de la variable response:

Propiedad Tipo Lectura y escritura Descripción Scope begins
response message Lectura y escritura

Mensaje de respuesta completo devuelto por el destino.

 Respuesta objetivo
response.content Cadena Lectura y escritura

Contenido de la carga útil del mensaje de respuesta devuelto por el destino.

 Respuesta objetivo
response.content.as.base64 Cadena Solo lectura

Contenido de la carga útil codificado en Base64 del mensaje de respuesta.

 Respuesta objetivo
response.content.as.url.safe.base64 Cadena Solo lectura

Contenido de la carga útil codificado en base64 seguro para URLs del mensaje de respuesta.

 Respuesta objetivo
response.event.current.content Cadena Lectura y escritura

El contenido devuelto en una respuesta de streaming de EventFlow. Para obtener más información, consulta Transmitir eventos enviados por el servidor.

 Respuesta de EventFlow
response.event.current.count Entero Leer

Cuenta de forma incremental el número de eventos de respuesta enviados. Este valor se actualiza con cada evento recibido. Para obtener más información, consulta Transmitir eventos enviados por el servidor.

. 		Respuesta de EventFlow
response.header.header_name Cadena Lectura y escritura

Obtiene o define el valor de un encabezado HTTP especificado en la respuesta.

Si el texto del encabezado incluye una coma, Apigee deduce que hay varios valores. En este caso, response.header.header_name devuelve solo el primer valor.

Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor devuelto de response.header.cache-control es public.

Si quieres que todo el encabezado sea una cadena, usa una variable como response.header.header_name.values.string.

 Respuesta objetivo
response.header.header_name.
 values		 Colección Solo lectura

Todos los valores de un encabezado HTTP especificado en la respuesta.

 Respuesta objetivo
response.header.header_name.
 values.count		 Entero Solo lectura

Número de todos los valores del encabezado HTTP especificado en la respuesta.

 Respuesta objetivo
response.header.header_name.
 values.string		 Cadena Solo lectura

Todos los valores de un encabezado concreto de la respuesta, en forma de una sola cadena.

Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor devuelto de response.header.cache-control.values.string es public,maxage=16544.

 Respuesta objetivo
response.header.header_name.N Cadena Lectura y escritura

El valor del encabezado Nth concreto de la respuesta. Apigee divide los valores de texto de los encabezados por comas. El índice empieza por 1 para el valor situado más a la izquierda.

Por ejemplo, si la cabecera Cache-control es public,maxage=16544, response.header.cache-control.2 devuelve maxage=16544.

 Respuesta objetivo
response.headers.count Entero Solo lectura

Recuento de todos los encabezados de la respuesta.

 Respuesta objetivo
response.headers.names Colección Solo lectura

Los nombres de todos los encabezados de la respuesta.

 Respuesta objetivo
response.headers.names.string Cadena Solo lectura

Lista separada por comas con los nombres de todos los encabezados de la respuesta.

 Respuesta objetivo
response.status.code Entero Lectura y escritura

El código de respuesta devuelto para una solicitud. Puedes usar esta variable para anular el código de estado de la respuesta, que se almacena en message.status.code. Para obtener más información, consulta message.

 Respuesta objetivo
response.transport.message Cadena Solo lectura

Respuesta de tipo TransportMessage, que es un objeto contextual.

 Respuesta objetivo

route

Especifica los nombres de <RouteRule> y TargetEndpoint.

En la siguiente tabla se describen las propiedades de la variable route:

Propiedad Tipo Lectura y escritura Descripción Scope begins
route.name Cadena Solo lectura

Nombre del <RouteRule> que se ha ejecutado en ProxyEndpoint. Por ejemplo, default. Una RouteRule hace referencia a un TargetEndpoint de un proxy de API para ejecutarlo.

 Solicitud de destino
route.target Cadena Solo lectura

Nombre del TargetEndpoint que se ha ejecutado. Por ejemplo, default.

 Solicitud de destino

servicecallout

Describe el elemento TargetEndpoint de una política ServiceCallout.

En la siguiente tabla se describen las propiedades de la variable servicecallout:

Propiedad Tipo Lectura y escritura Descripción Scope begins
servicecallout.policy_name.expectedcn Cadena Lectura y escritura

Nombre común esperado del TargetEndpoint al que se hace referencia en una política ServiceCallout. Solo tiene sentido cuando TargetEndpoint hace referencia a un endpoint TLS/SSL.

 Solicitud de proxy
servicecallout.policy_name.target.url Cadena Lectura y escritura

La URL de TargetEndpoint de una política ServiceCallout concreta.

 Solicitud de proxy
servicecallout.requesturi Cadena Lectura y escritura

El URI de TargetEndpoint de una política ServiceCallout. El URI es la URL de TargetEndpoint sin el protocolo ni la especificación del dominio.

 Solicitud de proxy

system

Especifica la dirección IP del sistema, así como detalles sobre el proxy.

En la siguiente tabla se describen las propiedades de la variable system:

Propiedad Tipo Lectura y escritura Descripción Scope begins
system.interface.interface_name Cadena Solo lectura

Dirección IP del sistema.

 Solicitud de proxy
system.pod.name Cadena Solo lectura

Nombre del pod en el que se ejecuta el proxy.

 Solicitud de proxy
system.region.name Cadena Solo lectura

El nombre del centro de datos de la región en la que se ejecuta el proxy.

 Solicitud de proxy
system.time Cadena Solo lectura

La hora en la que se leyó esta variable. Por ejemplo, Wed, 21 Aug 2013 19:16:47 GMT.

Este valor es la representación de cadena del valor correspondiente de system.timestamp. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 GMT corresponde al valor de marca de tiempo 1377112607413.

 Solicitud de proxy
system.time.year Entero Solo lectura

La parte del año de system.time.

 Solicitud de proxy
system.time.month Entero Solo lectura

La parte del mes de system.time.

 Solicitud de proxy
system.time.day Entero Solo lectura

La parte del día del mes de system.time.

 Solicitud de proxy
system.time.dayofweek Entero Solo lectura

La parte del día de la semana de system.time.

 Solicitud de proxy
system.time.hour Entero Solo lectura

La parte de la hora de system.time.

 Solicitud de proxy
system.time.minute Entero Solo lectura

La parte de minutos de system.time.

 Solicitud de proxy
system.time.second Entero Solo lectura

La segunda parte de system.time.

 Solicitud de proxy
system.time.millisecond Entero Solo lectura

La parte de milisegundos de system.time.

 Solicitud de proxy
system.time.zone Cadena Solo lectura

Zona horaria del sistema.

 Solicitud de proxy
system.timestamp Long Solo lectura

Número entero (largo) de 64 bits que representa la hora en la que se leyó esta variable. El valor es el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC). Por ejemplo, 1534783015000.

 Solicitud de proxy
system.uuid Cadena Solo lectura

El UUID del procesador de mensajes que gestiona el proxy.

 Solicitud de proxy

target

Describe el destino de la solicitud.

En la siguiente tabla se describen las propiedades de la variable target:

Propiedad Tipo Lectura y escritura Descripción Scope begins
target.basepath Cadena Solo lectura

Ruta de recursos (sin incluir el dominio) al servicio de destino, excluidos los parámetros de consulta, que se define en TargetEndpoint del proxy.

Por ejemplo, supongamos que un proxy de API llama al siguiente destino:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

En este ejemplo, el target.basepath es /user.

Si el objetivo fuera este:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

El target.basepath sería nulo.

 Solicitud de destino
target.copy.pathsuffix Booleano Lectura y escritura

Cuando true, la solicitud reenviada de ProxyEndpoint a TargetEndpoint conserva el sufijo de la ruta (el fragmento de la ruta del URI que sigue al URI definido en la ruta base de ProxyEndpoint).

 Solicitud de destino
target.copy.queryparams Booleano Lectura y escritura

Cuando true, la solicitud reenviada de ProxyEndpoint a TargetEndpoint conserva los parámetros de consulta.

 Solicitud de destino
target.country Cadena Solo lectura

País del certificado TLS/SSL presentado por el servidor de destino.

 Respuesta objetivo
target.cn Cadena Solo lectura

Nombre común del TargetEndpoint. Solo tiene sentido cuando TargetEndpoint hace referencia a un endpoint TLS/SSL.

 Solicitud de destino
target.email.address Cadena Solo lectura

Dirección de correo del certificado TLS/SSL presentado por el servidor de destino.

 Respuesta objetivo
target.expectedcn Cadena Lectura y escritura

Nombre común esperado del TargetEndpoint. Solo tiene sentido cuando TargetEndpoint hace referencia a un endpoint TLS/SSL.

 Solicitud de proxy
target.header.host Cadena Lectura y escritura

Variable de flujo que usa Apigee para definir el valor del encabezado Host de la solicitud saliente al destino. Se usa para definir el valor en un nombre de host en situaciones en las que se usa una dirección IP en la URL de destino o en el servidor de destino, como sería el caso de un destino basado en un endpoint de PSC.

 Solicitud de destino
target.host Cadena Solo lectura

Nombre de dominio del servicio de destino que devuelve la respuesta al proxy de la API.

 Respuesta objetivo
target.ip Cadena Solo lectura

Dirección IP del servicio de destino que devuelve la respuesta al proxy de la API.

 Respuesta objetivo
target.locality Cadena Solo lectura

Localidad (ciudad) del certificado TLS/SSL presentado por el servidor de destino

 Respuesta objetivo
target.name Cadena Solo lectura

Destino al que llega el mensaje desde targetendpoint.

 Solicitud de destino
target.organization Cadena Solo lectura

Organización del certificado TLS/SSL presentado por el servidor de destino.

 Respuesta objetivo
target.organization.unit Cadena Solo lectura

Unidad organizativa del certificado TLS/SSL presentado por el servidor de destino.

 Respuesta objetivo
target.port Entero Solo lectura

El número de puerto del servicio de destino que devuelve la respuesta al proxy de API.

 Respuesta objetivo
target.received.end.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que TargetEndpoint terminó de recibir la respuesta del destino. Por ejemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Respuesta objetivo
target.received.end.
  timestamp		 Long Solo lectura

Valor de marca de tiempo que especifica cuándo ha terminado TargetEndpoint de recibir la respuesta del destino. Por ejemplo, 1534783015000. Este valor es un entero de 64 bits (largo) que especifica el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Respuesta objetivo
target.received.start.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que TargetEndpoint empezó a recibir la respuesta del destino. Por ejemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Respuesta objetivo
target.received.start.
  timestamp		 Long Solo lectura

Valor de marca de tiempo que especifica cuándo empezó TargetEndpoint a recibir la respuesta del destino. Por ejemplo, 1534783015000. Este valor es un entero de 64 bits (largo) que especifica el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Respuesta objetivo
target.scheme Cadena Solo lectura

Inicio del ámbito: respuesta de destino
Tipo: cadena
Permiso: lectura/escritura

Devuelve http o https en función del mensaje de solicitud.

 Solicitud de destino
target.sent.end.time Cadena Solo lectura

La hora, expresada en formato de cadena, en la que el proxy dejó de enviar la solicitud a la URL especificada en TargetEndpoint. Por ejemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Solicitud de destino
target.sent.end.timestamp Long Solo lectura

Valor de marca de tiempo que especifica cuándo ha terminado el proxy de enviar la solicitud a la URL especificada en TargetEndpoint. Por ejemplo, 1377112607413. Este valor es un entero de 64 bits (largo) que contiene el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Solicitud de destino
target.sent.start.time Cadena Solo lectura

La hora, expresada en forma de cadena, en la que el proxy empezó a enviar la solicitud a la URL especificada en TargetEndpoint. Por ejemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal es la representación de cadena de la cantidad de marca de tiempo de 32 bits correspondiente. Por ejemplo, el miércoles 21 de agosto del 2013 a las 19:16:47 UTC corresponde al valor de marca de tiempo 1377112607413.

 Solicitud de destino
target.sent.start.timestamp Long Solo lectura

Valor de marca de tiempo que especifica cuándo empezó el proxy a enviar la solicitud a la URL especificada en TargetEndpoint. Por ejemplo, 1534783015000. Este valor es un entero de 64 bits (largo) que especifica el número de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 (UTC).

 Solicitud de destino
target.ssl.enabled Booleano Solo lectura

Indica si TargetEndpoint se ejecuta en TLS/SSL.

 Solicitud de proxy
target.state Cadena Solo lectura

Estado del certificado TLS/SSL presentado por el servidor de destino.

 Respuesta objetivo
target.url Cadena Lectura y escritura

La URL configurada en el archivo XML TargetEndpoint o la URL de destino dinámica (si se define target.url durante el flujo de mensajes). La variable no incluye ningún elemento de ruta ni parámetro de consulta adicional. Devuelve un valor nulo si se llama fuera del ámbito o si no se ha definido.

 Solicitud de destino

variable

Contenedor de la propiedad variable.expectedcn.

En la siguiente tabla se describen las propiedades de la variable variable:

Propiedad Tipo Lectura y escritura Descripción Scope begins
variable.expectedcn Cadena Lectura y escritura

Variable expuesta para el nombre común si se ejecuta en TLS/SSL.

 Solicitud de proxy

Para obtener más información sobre cómo trabajar con TLS, consulta Opciones para configurar TLS.