Referencia de las 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 uno de estos pasos se describe en las siguientes secciones.

Terminología de variables de flujo

Una variable de flujo hace referencia a un valor dentro de un contexto. El valor de una variable de flujo puede ser un tipo primitivo (como una string, un booleano o un número entero) o una referencia a un objeto específico, como un objeto cuyas instancias creó Apigee durante la solicitud/procesamiento de respuestas.

El hecho de que una variable de flujo haga referencia a un tipo primitivo o un objeto depende del contexto, es decir, el momento en que te refieres a él. El contexto para una variable de flujo es el segmento de flujo en el que un proxy de API procesa una solicitud o respuesta. Por ejemplo, en cualquier segmento del contexto de flujo de respuesta, la variable de flujo response se refiere al objeto response.

En la mayoría de los casos, puedes pensar en las variables de flujo como hacer referencia a un objeto. Para hacer referencia a las propiedades de ese objeto, debes usar la notación de puntos. Por ejemplo, para acceder a la propiedad content de response, usa response.content.

Trabaja con variables de flujo

Para obtener información sobre el uso de variables de flujo, consulta la descripción general de las variables de flujo.

Ten en cuenta lo siguiente cuando trabajes con variables de flujo:

• Cada variable de flujo, como request, tiene propiedades a las que accedes mediante la sintaxis de notación de puntos. Por ejemplo:

  request.headers.count

• No todas las variables de flujo son accesibles desde todas las políticas o herramientas. Por ejemplo, en la solicitud FlowFlow, no podrás acceder a response.
• La mayoría de las propiedades son de solo lectura. Cuando algunas son de lectura y escritura, también pueden ser de solo lectura, según la ubicación en la que accedas a ellas.
• Algunas políticas definen variables de flujo específicas de la política. Por ejemplo, la política de ResponseCache define una variable responsecache. Para obtener más información, consulta la referencia de políticas.
• No dependas de variables sin documentar en tus proxies de API y apps. Por ejemplo, no confíes en los valores de los encabezados X-Apigee sin documentar* en tus proxies de API, ya que estos encabezados no están destinados para el uso del cliente y Apigee los puede quitar o cambiar en cualquier momento.

Para obtener más información, consulte:

• Comienza ahora:
  • ¿Qué son las variables de flujo?
  • Comprende el alcance de las variables de flujo
  • Configura flujos
• Herramientas y políticas:
  • La herramienta de depuración te permite ver los valores de las variables de flujo a medida que avanzas a través del flujo del proxy de API.
  • La política de AssignMessage te permite modificar las variables en el flujo del proxy de API.

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 del objeto apigee:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
apigee.metrics.policy.policy_name.timeTaken	Número entero	Solo lectura	El tiempo, en nanosegundos, que la política tardó en ejecutarse.	Política

apiproduct

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

En la siguiente tabla, se describen las propiedades del objeto apiproduct:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
apiproduct.operation	String	Solo lectura	Nombre de la operación del producto de API Esta variable te ayuda a diferenciar entre la configuración de la Política de cuotas y la configuración de cuotas en la operación de un producto de API. Por ejemplo, my-operation.	Solicitud de proxy
apiproduct.operation.resource	String	Solo lectura	El nombre de recurso de la operación que coincide con una solicitud.	Solicitud de proxy
apiproduct.operation.methods	Array	Solo lectura	Un array de métodos HTTP que permite la operación con coincidencias.	Solicitud de proxy
apiproduct.operation.attributes.key_name	Array	Solo lectura	Obtiene el valor del atributo personalizado que coincide con key_name.	Solicitud de proxy

Para obtener más información, consulta lo siguiente:

• <UseQuotaConfigInAPIProduct>
• ¿Qué es un producto de API?
• Administra productos de API

apiproxy

Describe el proxy de API.

En la siguiente tabla, se describen las propiedades del objeto apiproxy:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
apiproxy.name	String	Solo lectura	Nombre del proxy de API. Por ejemplo, My Proxy	Solicitud de proxy
apiproxy.revision	String	Solo lectura	El número de revisión de un proxy de API. Por ejemplo, 6.	Solicitud de proxy
apiproxy.basepath	String	Solo lectura	La ruta base de la implementación (especificada durante la implementación de la API).	Solicitud de proxy

Si deseas obtener más información para trabajar con proxies de API, consulta Información sobre las API y los proxies de API.

client

La aplicación o el sistema que envió una solicitud al balanceador de cargas.

En la siguiente tabla, se describen las propiedades del objeto client:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
client.cn	String	Solo lectura	El nombre común especificado en el certificado TLS/SSL que presentó la app cliente.	Solicitud de proxy
client.country	String	Solo lectura	El país del certificado TLS/SSL que presentó la app cliente	Solicitud de proxy
client.email.address	String	Solo lectura	La dirección de correo electrónico en el certificado TLS/SSL que presentó la app cliente.	Solicitud de proxy
client.host	String	Solo lectura	La IP del host HTTP asociada con la solicitud que recibió ProxyEndpoint.	Solicitud de proxy
client.ip	String	Solo lectura	La dirección IP del cliente o sistema que envía el mensaje al balanceador de cargas. Por ejemplo, puede ser la IP de cliente original o una IP del balanceador de cargas.	Solicitud de proxy
client.locality	String	Solo lectura	La localidad (ciudad) en el certificado TLS/SSL que presentó el cliente.	Solicitud de proxy
client.organization	String	Solo lectura	La organización en el certificado TLS/SSL que presenta el cliente. (No necesariamente equivale a la organización en Apigee).	Solicitud de proxy
client.organization.unit	String	Solo lectura	La unidad organizativa en el certificado TLS/SSL que presentó el cliente.	Solicitud de proxy
client.port	Número entero	Solo lectura	El puerto HTTP asociado a la solicitud del cliente de origen al ProxyEndpoint.	Solicitud de proxy
client.received.end.time	String	Solo lectura	La hora, expresada en forma de string, en la que el proxy terminó de recibir la solicitud del cliente de origen en el ProxyEndpoint. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, "Miércoles, 21 de agosto de 2013, 19:16:47 UTC" corresponde al valor de la marca de tiempo de 1377112607413.	Solicitud de proxy
client.received.end.timestamp	Largo	Solo lectura	El valor de marca de tiempo que especifica cuándo el proxy terminó de recibir la solicitud del cliente de origen en ProxyEndpoint. Este valor es un número entero de 64 bits (largo) que contiene la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC.	Solicitud de proxy
client.received.start.time	String	Solo lectura	La hora, expresada en forma de string, en la que el proxy comenzó a recibir la solicitud del cliente de origen en el ProxyEndpoint. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, "Miércoles, 21 de agosto de 2013, 19:16:47 UTC" corresponde al valor de la marca de tiempo de 1377112607413.	Solicitud de proxy
client.received.start.timestamp	Largo	Solo lectura	El valor de marca de tiempo que especifica cuándo el proxy comenzó a recibir la solicitud del cliente de origen en ProxyEndpoint. Este valor es un número entero de 64 bits (largo) que contiene la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC. Nota: Este valor de tiempo se usa para calcular las métricas de tráfico de los proxies de API en los paneles de estadísticas.	Solicitud de proxy
client.scheme	String	Solo lectura	Muestra HTTP o HTTPS según el transporte que use la app cliente para enviar el mensaje de solicitud.	Solicitud de proxy
client.sent.end.time	String	Solo lectura	El tiempo, expresado en forma de string, en el que el proxy terminó de enviar la respuesta del ProxyEndpoint al cliente. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor es una representación de string del client.sent.end.timestamp de 32 bits correspondiente. Por ejemplo, mié, 21 de agosto de 2013, 19:16:47 UTC corresponde al valor de la marca de tiempo de 1377112607413. Nota: Esta propiedad solo está disponible en el PostClientFlow de la respuesta de ProxyEndpoint. En todos los demás flujos, el valor de esta propiedad es la string vacía. Si deseas obtener información sobre el acceso a esta propiedad, consulta la política de MessageLogging.	PostClientFlow
client.sent.end.timestamp	Largo	Solo lectura	El valor de marca de tiempo que especifica cuándo ProxyEndpoint terminó de mostrar la respuesta a la app cliente de origen. Este valor es un número entero de 64 bits (largo) que contiene la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC. Nota: Esta propiedad solo está disponible en el PostClientFlow de la respuesta de ProxyEndpoint. En todos los demás flujos, el valor de esta propiedad es -1. Si deseas obtener información sobre el acceso a esta propiedad, consulta la política de MessageLogging.	PostClientFlow
client.sent.start.time	String	Solo lectura	El tiempo, expresado en forma de string, cuando el ProxyEndpoint comenzó a mostrar la respuesta a la aplicación cliente de origen. Por ejemplo, mié., 21 de agosto de 2013, 19:16:47 UTC Este valor es una representación de string del client.sent.start.timestamp de 32 bits correspondiente. Por ejemplo, mié, 21 de agosto de 2013, 19:16:47 UTC corresponde al valor de la marca de tiempo de 1377112607413. Nota: Esta propiedad solo está disponible en el PostClientFlow de la respuesta de ProxyEndpoint. En todos los demás flujos, el valor de esta propiedad es la string vacía. Si deseas obtener información sobre el acceso a esta propiedad, consulta la política de MessageLogging.	PostClientFlow
client.sent.start.timestamp	Largo	Solo lectura	Cuando el proxy comienza a enviar la respuesta al cliente desde el ProxyEndpoint. Este valor se expresa como un número entero de 64 bits (largo) que contiene la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC. Nota: Esta propiedad solo está disponible en el PostClientFlow de la respuesta de ProxyEndpoint. En todos los demás flujos, el valor de esta propiedad es -1. Si deseas obtener información sobre el acceso a esta propiedad, consulta la política de MessageLogging.	PostClientFlow
client.ssl.enabled	String	Solo lectura	true si el ProxyEndpoint configura para TLS/SSL de lo contrario, es false.	Solicitud de proxy
client.state	String	Solo lectura	El estado del certificado TLS/SSL que presentó el cliente.	Solicitud de proxy

current

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

En la siguiente tabla, se describen las propiedades del objeto current:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
current.flow.name	String	Solo lectura	El nombre del flujo que se ejecuta en la actualidad (como PreFlow, PostFlow o el nombre de un flujo condicional).	Solicitud de proxy
current.flow.description	String	Solo lectura	Es la descripción del flujo que se encuentra en ejecución. Es igual al valor del elemento <Description> en la configuración de XML del flujo.	Solicitud de proxy

Puedes ver estas propiedades en la vista de seguimiento de la IU de Apigee.

environment

Un contenedor para la propiedad environment.name.

En la siguiente tabla, se describen las propiedades del objeto environment:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
environment.name	String	Solo lectura	Nombre del entorno en el que se ejecutó la transacción.	Solicitud de proxy

error

Un objeto contextual que representa un mensaje de error en el flujo de error.

Nota: Las variables de error solo están disponibles en el flujo de error.

En la siguiente tabla, se describen las propiedades del objeto error:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
error	message	Lectura/escritura	Error de tipo message, que es un objeto contextual en el flujo de error.	Error
error.content	String	Lectura/escritura	Contenido del error.	Error
error.message	String	Solo lectura	Mensaje asociado con un error, cuyo valor está disponible solo antes de que se ejecute el flujo de error.	Error
error.status.code	Número entero	Solo lectura	El código de estado HTTP asociado con el error. Por ejemplo, 400.	Error
error.reason.phrase	String	Solo lectura	La frase del motivo asociada con el error. Por ejemplo: Bad Request.	Error
error.transport.message	TransportMessage	Solo lectura	Cualquier error de tipo TransportMessage.	Error
error.state	Número entero	Solo lectura	Estado en el flujo en el que se produjo un error.	Error
error.header.header_name	String	Lectura/escritura	Obtén o establece el encabezado de respuesta.	Error

fault

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

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
fault.name	String	Solo lectura	El nombre del error, como se describe en la tabla Errores del entorno de ejecuciónincluida en cada tema de referencia de la política. Esta variable puede ser útil en condiciones que se aplican a FaultRules.	Error
fault.reason	String	Solo lectura	El motivo de la falla. Por ejemplo, cuando la política OASValidation detecta que una solicitud entrante no se valida en la Especificación de OpenAPI, establecerá esta variable en una string que describe el nombre de la política, el nombre de la especificación, y el detalle que describe por qué no se valida la solicitud con la especificación. Otras políticas establecerán esta variable en los mensajes adecuados para sus fallas.	Error
fault.category	String	Solo lectura	La categoría. Por ejemplo, si la falla ocurre en un paso de la política, esta variable podría contener el valor "Paso". Esta variable puede ser útil en condiciones que se aplican a FaultRules.	Error
fault.subcategory	String	Solo lectura	La subcategoría. Por ejemplo, si la política OASValidation detecta que una solicitud no se valida con una especificación de OpenAPI, establecerá esta variable en “OASValidationFailure”. Esta variable puede ser útil en condiciones que se aplican a FaultRules.	Error

graphql

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

En la siguiente tabla, se describen las propiedades del objeto graphql:

Propiedad	Tipo	Lectura/escritura	Descripción
graphql	Tipo complejo	SOLO LECTURA/LECTURA Y ESCRITURA	La consulta raíz del GraphQL.	SCOPE
graphql.fragment	Tipo complejo	SOLO LECTURA/LECTURA Y ESCRITURA	Una referencia al fragmento predeterminado para esta consulta.	SCOPE
graphql.fragment.count	Número entero	Solo lectura	La cantidad de framentos generados por esta consulta de GraqhQL.	SCOPE
graphql.fragment.INDEX.selectionSet.INDEX	TYPE	SOLO LECTURA/LECTURA Y ESCRITURA	Una referencia a la selección establecida en el índice especificado.	SCOPE
graphql.fragment.INDEX.selectionSet.INDEX.name	String	SOLO LECTURA/LECTURA Y ESCRITURA	El nombre de la selección establecida en el índice especificado.	SCOPE
graphql.fragment.INDEX.selectionSet.count	Número entero	Solo lectura	La cantidad de conjuntos de selección en el fragmento.	SCOPE
graphql.fragment.INDEX.selectionSet.name	String	SOLO LECTURA/LECTURA Y ESCRITURA	El nombre de la selección predeterminada que se estableció en el fragmento.	SCOPE
graphql.operation	Tipo complejo	SOLO LECTURA/LECTURA Y ESCRITURA	Una referencia a la operación predeterminada de la consulta. No puedes establecer cuotas a nivel de la operación. En su lugar, debes configurarlos a nivel del entorno.	SCOPE
graphql.operation.name	String	Solo lectura	El nombre de la operación predeterminada de la consulta.	SCOPE
graphql.operation.operationType	Enumeration	Solo lectura	El tipo de operación predeterminada de consulta que se puede ejecutar en este proxy de API. Los valores posibles son query, mutation o all.	SCOPE
graphql.operation.selectionSet	Tipo complejo		El conjunto de selecciones predeterminado para la operación predeterminada de la consulta.	SCOPE
graphql.operation.selectionSet.count	Número entero	Solo lectura	La cantidad de conjuntos de selecciones en la operación predeterminada de la consulta.	SCOPE
graphql.operation.selectionSet.name	String	Solo lectura	El nombre del conjunto de selecciones predeterminadas de la operación predeterminada de la consulta.	SCOPE
graphql.operation.selectionSet.INDEX	Número entero	Solo lectura	Una referencia al conjunto de selecciones en el índice especificado en la lista de conjuntos de selecciones.	SCOPE
graphql.operation.selectionSet.INDEX.name	String	Solo lectura	El nombre de la selección en el índice especificado de la lista de conjuntos de selecciones para esta operación.	SCOPE
graphql.operation.selectionSet.INDEX.[selectionSet]	Tipo complejo	SOLO LECTURA/LECTURA Y ESCRITURA	Uno o más objetos adicionales del conjunto de selecciones. Se puede acceder a los conjuntos de selecciones de forma recursiva. Por ejemplo, después de un selectionSet.index, puedes tener otro selectionSet.index en lugar de una propiedad name. Y después de eso, otro y así sucesivamente hasta llegar al valor de <MaxCount> que estableciste en la política de GraphQL.	SCOPE
graphql.operation.selectionSet.INDEX.directive	Tipo complejo		Una referencia a la directiva predeterminada en el conjunto de selección especificado.	SCOPE
graphql.operation.selectionSet.INDEX.directive.count	Tipo complejo			SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX	Número entero	Solo lectura	Una referencia a la directiva en el índice especificado.	SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX	Número entero	Solo lectura	Una referencia al argumento en el índice especificado.	SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name	String		El nombre del argumento en el índice especificado.	SCOPE
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value	String		El valor del argumento en el índice especificado.	SCOPE
graphql.operation.selectionSet.INDEX.directive.name	String			SCOPE
graphql.operation.variableDefinitions	Tipo complejo		Una referencia a una lista de definiciones de variables para la operación predeterminada de la consulta.	SCOPE
graphql.operation.variableDefinitions.count	Número entero		La cantidad de definiciones de variables para la operación predeterminada de la consulta.	SCOPE
graphql.operation.variableDefinitions.INDEX	Número entero		Una referencia a la definición de variable en el índice especificado.	SCOPE
graphql.operation.variableDefinitions.INDEX.name	String		El nombre de la definición de variable en el índice especificado.	SCOPE
graphql.operation.variableDefinitions.INDEX.type			El tipo de valor de la definición de variable en el índice especificado.	SCOPE

is

Un contenedor para la propiedad is.error.

En la siguiente tabla, se describen las propiedades del objeto is:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
is.error	Booleano	Solo lectura	Marca de error.	Solicitud de proxy

loadbalancing

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

En la siguiente tabla, se describen las propiedades del objeto loadbalancing:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
loadbalancing.failedservers	Arreglo de strings	Solo lectura	Lista de TargetServers fallidos durante el balanceo de cargas en TargetEndpoint.	Respuesta de destino
loadbalancing.isfallback	Booleano	Solo lectura	true si el resguardo está habilitado para el TargetServer invocado durante el balanceo de cargas en TargetEndpoint.	Respuesta de destino
loadbalancing.targetserver	String	Solo lectura	Se invoca TargetServer durante el balanceo de cargas en TargetEndpoint. Solo se establece si el elemento <Path> se establece mientras se define el elemento del balanceador de cargas.	Respuesta de destino

message

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

En la siguiente tabla, se describen las propiedades del objeto message:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
message	message	Lectura/escritura	Un objeto contextual, con el mismo valor que request en el flujo de solicitudes o como response en el flujo de respuesta, o como error en el flujo de error.	Solicitud de proxy
message.content	String	Lectura/escritura	Contenido de la solicitud, respuesta o mensaje de error.	Solicitud de proxy
message.formparam.param_name	String	Lectura/escritura	Valor del parámetro del 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	Número entero	Solo lectura	Es el recuento de los valores de los parámetros del formulario especificados en el mensaje.	Solicitud de proxy
message.formparams.count	Número entero	Solo lectura	Recuento de todos los parámetros del formulario en el mensaje.	Solicitud de proxy
message.formparams.names	Colección	Solo lectura	Valor de todos los parámetros del formulario en el mensaje.	Solicitud de proxy
message.formparams.names.string	String	Solo lectura	Una lista separada por comas de los nombres de todos los parámetros del formulario en el mensaje.	Solicitud de proxy
message.formstring	String	Solo lectura	Valor de la string del formulario en el mensaje.	Solicitud de proxy
message.header.header_name	String	Lectura/escritura	Obtiene o establece el valor de un encabezado en particular que se encuentra en la solicitud. Si el encabezado contiene una coma, luego de la lectura, solo recibirás el segmento del texto hasta la primera coma. Por ejemplo, si el encabezado Cache-control es public, maxage=16544, entonces el valor de retorno de message.header.cache-control es public. Si quieres el encabezado completo como una string, usa una variable como message.header.header_name.values.string.	Solicitud de proxy
message.header.header_name.N	String	Lectura/escritura	El valor del valor de encabezado Nth particular en el mensaje, ya sea una solicitud o una respuesta, según el estado del flujo. Apigee divide los valores de texto del encabezado por comas. El índice comienza en 1 para el valor más a la izquierda. Por ejemplo, si el encabezado Cache-control es public,maxage=16544, entonces el valor de retorno 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 de encabezado HTTP especificado en el mensaje	Solicitud de proxy
message.header.header_name.  values.count	Número entero	Solo lectura	Recuento de los valores del nombre de encabezado HTTP especificado en el mensaje	Solicitud de proxy
message.header.header_name.  values.string	String	Solo lectura	Todos los valores de un encabezado en particular del mensaje, en forma de una sola string. Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor de retorno de message.header.cache-control.values.string es public,maxage=16544.	Solicitud de proxy
message.headers.count	Número entero	Solo lectura	Recuento de todos los encabezados HTTP en el 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	String	Solo lectura	Una lista separada por comas de los nombres de todos los encabezados del mensaje.	Solicitud de proxy
message.path	String	Lectura/escritura	La ruta completa del mensaje de solicitud en la URL, sin incluir los parámetros de consulta	Solicitud de proxy
message.queryparam.param_name	String	Solo lectura	Muestra el parámetro de búsqueda de mensaje especificado	Solicitud de proxy
message.queryparam.param_name.N	String	Lectura/escritura	El valor del parámetro de búsqueda Nth en el mensaje Por ejemplo, si request.querystring es a=hello&a=world, entonces el valor de retorno de message.queryparam.a.1 es hello. Como ejemplo de escritura de varios valores para un solo nombre de parámetro de búsqueda, como type=siteid:1&type=language:us-en&type=currency:USD, configura 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 formulario en particular en el mensaje, con formato como una lista separada por comas. Por ejemplo, si la string 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	Número entero	Solo lectura	El recuento total de un parámetro de búsqueda especificado asociado con la solicitud enviada al ProxyEndpoint desde la app cliente.	Solicitud de proxy
message.queryparams.count	Número entero	Solo lectura	El recuento total de todos los parámetros de consulta asociados con la solicitud enviada al ProxyEndpoint desde la app cliente.	Solicitud de proxy
message.queryparams.names	Colección	Solo lectura	Una lista de todos los nombres de los parámetros de consulta asociados con la solicitud enviada al proxyEndpoint desde la app cliente.	Solicitud de proxy
message.queryparams.names.string	String	Solo lectura	Una lista separada por comas de los nombres de todos los parámetros de búsqueda en el mensaje.	Solicitud de proxy
message.querystring	String	Solo lectura	Una string que contiene todos los nombres y valores de los parámetros de consulta asociados con la solicitud enviada al ProxyEndpoint desde la app cliente. Por ejemplo, para 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	Número entero	Solo lectura	Código de estado HTTP del mensaje de respuesta del destino	Respuesta de destino
message.transport.message	TransportMessage	Solo lectura	Mensaje de tipo TransportMessage, que es un objeto contextual	Solicitud de proxy
message.uri	String	Solo lectura	La ruta de URI completa (después de la URL del dominio), incluidos los parámetros de consulta. Por ejemplo, para la solicitud http://api.apifactory.com/inventors?name=nikola&surname=tesla, esta variable muestra inventors?name=nikola&surname=tesla.	Solicitud de proxy
message.verb	String	Solo lectura	El verbo HTTP (GET, PUT, POST, DELETE, etc.) asociado con la solicitud.	Solicitud de proxy
message.version	String	Lectura/escritura	La versión HTTP asociada con la solicitud enviada al ProxyEndpoint desde la aplicación cliente.	Solicitud de proxy

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

messageid

Un contenedor para el ID único global de la solicitud

En la siguiente tabla, se describen las propiedades del objeto messageid:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
messageid	String	Solo lectura	Contiene el ID único global de la solicitud, incluido el nombre del host del balanceador de cargas. Este ID permite hacer un seguimiento de las solicitudes recibidas en el balanceador de cargas después de que se envían al procesador de mensajes. Este ID está registrado en los registros de errores de Apigee para correlacionar los 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 del objeto mint:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
mint.limitscheck.is_request_blocked	Booleano	Solo lectura	Marca que especifica si la solicitud a la API está bloqueada. Se establece en true, si is_subscription_found es false. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	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 API. Se establece en true si un desarrollador tiene una suscripción. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	Solicitud de proxy
mint.limitscheck.prepaid_developer_balance	Numérico	Solo lectura	Saldo actual en la cartera de cuentas prepagadas del desarrollador asociada con la moneda del plan de tarifas.	Solicitud de proxy
mint.limitscheck.prepaid_developer_currency	String	Solo lectura	Moneda del saldo disponible en la variable mint.limitscheck.prepaid_developer_balance.	Solicitud de proxy
mint.limitscheck.purchased_product_name	String	Solo lectura	Nombre del producto de API asociado. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	Solicitud de proxy
mint.limitscheck.status_message	String	Solo lectura	Información adicional sobre la ejecución de la política MonetizationLimitsCheck para la depuración. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	Solicitud de proxy
mint.mintng_consumption_pricing_rates	String	Solo lectura	Tarifas basadas en el consumo. Establece las tarifas al crear un plan de tarifas.	PostClientFlow
mint.mintng_consumption_pricing_type	String	Solo lectura	Tipo de precio basado en el consumo. Por ejemplo: FIXED_PER_UNIT. Establece las tarifas basadas en consumo cuando crees un plan de tarifas.	PostClientFlow
mint.mintng_currency	String	Solo lectura	Moneda para calcular los ingresos. Esta variable de flujo tiene el valor de la variable de monetización currency.	Política de DataCapture
mint.mintng_dev_share	Numérico	Solo lectura	Ingresos que se compartirán con el desarrollador. Configura los ingresos que se compartirán con el desarrollador cuando crees un plan de tarifas.	PostClientFlow
mint.mintng_is_apiproduct_monetized	Booleano	Solo lectura	Marca que especifica si el producto de API está monetizado actualmente (es decir, si hay un plan de tarifas activo vigente). Esta variable de flujo se agrega mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Agrega una política de autenticación.	Solicitud de proxy
mint.mintng_price	Numérico	Solo lectura	Ingresos para calcular el porcentaje del desarrollador. La variable de flujo tiene el valor de la variable de monetización revShareGrossPrice.	Política de DataCapture y PostClientFlow
mint.mintng_price_multiplier	Numérico	Solo lectura	El factor (multiplicador) por el que se multiplica el costo por transacción. La variable de flujo tiene el valor de la variable de monetización perUnitPriceMultiplier.	Política de DataCapture y PostClientFlow
mint.mintng_rate	Numérico	Solo lectura	La tarifa que se cobra por la llamada a la API. Esta variable de flujo muestra la tarifa basada en consumo por llamada a la API. Establece la tarifa basada en consumo cuando crees un plan de tarifas. Si configuraste la variable de monetización perUnitPriceMultiplier en tu política de DataCapture, Apigee calcula el costo de la transacción después de considerar 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 que se cobra por la llamada a la API sin el cálculo perUnitPriceMultiplier. Si la política DataCapture capta la variable de monetización perUnitPriceMultiplier, esta variable de flujo muestra el costo de la transacción antes de multiplicar el costo por perUnitPriceMultiplier.	PostClientFlow
mint.mintng_rate_plan_id	String	Solo lectura	ID del plan de tarifas. Esta variable de flujo se agrega mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Agrega una política de autenticación.	Solicitud de proxy
mint.mintng_revenue_share_rates	String	Solo lectura	Tasa de reparto de ingresos. Establece la tasa de reparto de ingresos cuando crees un plan de tarifas.	PostClientFlow
mint.mintng_revenue_share_type	String	Solo lectura	Tipo de reparto de ingresos. Por ejemplo: FIXED. Establece el tipo de reparto de ingresos cuando crees 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 variable de monetización transactionSuccess.	Política de DataCapture
mint.prepaid_updated_developer_usage	Numérico	Solo lectura	Uso actual del desarrollador prepago. El uso se calcula en función de la configuración de tu plan de tarifas y el 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 ciclo. Esta variable de flujo se agrega mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Agrega una política de autenticación.	Solicitud de proxy
mint.rateplan_start_time_ms	Numérico	Solo lectura	Tiempo de activación para el plan de tarifa en milisegundos desde el ciclo. Esta variable de flujo se agrega mediante la política VerifyAPIKey o VerifyAccessToken adjunta al proxy de API. Consulta Agrega una política de autenticación.	Solicitud de proxy
mint.status	String	Solo lectura	Estado de la llamada monetizada Se propaga solo cuando hay errores.	PostClientFlow
mint.status_code	Numérico	Solo lectura	Código de estado HTTP de la llamada monetizada Se propaga solo cuando hay errores.	PostClientFlow
mint.subscription_end_time_ms	Numérico	Solo lectura	Tiempo de vencimiento de la suscripción al producto de la API en milisegundos desde el ciclo. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	Solicitud de proxy
mint.subscription_start_time_ms	Numérico	Solo lectura	Tiempo de activación para la suscripción al producto de la API en milisegundos desde el ciclo. Esta variable de flujo está disponible si la política MonetizationLimitsCheck se adjunta al proxy de API. Consulta Aplica límites de monetización en proxies de API de forma forzosa.	Solicitud de proxy
mint.tx_success_result	Booleano	Solo lectura	Indica si la monetización se realizó de forma correcta para la transacción. La variable mint.tx_success_result puede tener los siguientes valores: tx_success configurado como true: La variable transactionSuccess es true y la transacción se monetiza. Debido a que la transacción se monetiza, se calculan los valores de mint.mintng_rate y mint.mintng_dev_share. tx_success configurado como falso: La variable transactionSuccess es false y la transacción no se monetiza. Debido a que la transacción no se monetiza, no se calculan los valores de las variables mint.mintng_rate ni mint.mintng_dev_share. No se encontró tx_success. El código de estado del mensaje no era 2xx: La variable transactionSuccess no se capta 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 encontró tx_success. El código de estado del mensaje era 2xx: La variable transactionSuccess no se capta y el código de estado HTTP (message.status.code) de la transacción es 2xx. La transacción se monetiza.	PostClientFlow

Para obtener más información, consulta lo siguiente:

• Aplica los límites de monetización
• MonetizationLimitsCheckPolicy

organization

Un contenedor para la propiedad organization.name.

En la siguiente tabla, se describen las propiedades del objeto organization:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
organization.name	String	Solo lectura	Nombre de la organización.	Solicitud de proxy

Para obtener más información sobre las organizaciones, consulta Información sobre las organizaciones.

proxy

La configuración del proxy de la API.

En la siguiente tabla, se describen las propiedades del objeto proxy:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
proxy.basepath	String	Solo lectura	El valor de la ruta base en la configuración del extremo de proxy de tu API La ruta base es el fragmento de URI más a la izquierda que sigue al host en la URL. Los URI de flujo condicional siguen la ruta base. Supongamos que tienes un extremo de proxy de API configurado con una ruta base de /v2/weatherapi. (consulta Configuración de extremos de proxy para obtener detalles). En ese caso, si la solicitud entrante usa la URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, sucede lo siguiente: El nombre de host es myhost.example.net. Para recuperarla, lee la variable request.header.host. La ruta base es /v2/weatherapi. Para recuperarlo, lee la variable proxy.basepath. El sufijo de la ruta de acceso es /forecastrss. Para recuperarlo, lee la variable proxy.pathsuffix. Si defines una ruta base dinámica en la configuración del proxy de tu API, como /v2/*/weatherapicode>, la variable proxy.basepath se establece en la ruta dinámica. Para recuperar la URL real de la solicitud, lee y analiza la variable proxy.url.	Solicitud de proxy
proxy.client.ip	String	Solo lectura	La dirección X-Forwarded-For de la llamada entrante, que es la dirección IP que Apigee recibió del último protocolo de enlace TCP externo. Puede ser el cliente que realiza la llamada o un balanceador de cargas.	Solicitud de proxy
proxy.name	String	Solo lectura	El atributo name configurado para ProxyEndpoint	Solicitud de proxy
proxy.pathsuffix	String	Solo lectura	El valor del sufijo de ruta en la URL que se envía del cliente y se recibe en el ProxyEndpoint. La ruta base es el componente de ruta de acceso más a la izquierda que identifica de forma exclusiva un proxy de API dentro de un grupo de entornos. Supongamos que tienes un extremo de proxy de API configurado con una ruta base de /v2/weatherapi. En ese caso, una solicitud enviada a https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, la variable proxy.pathsuffix contendrá la cadena /forecastrss.	Solicitud de proxy
proxy.url	String	Solo lectura	Obtiene la URL completa asociada con la solicitud de proxy que recibió el ProxyEndpoint, incluidos los parámetros de consulta presentes. Para ver un ejemplo que construye una URL request con el host de solicitud original (en lugar del host de router que se usa en proxy.url), consulta Mensajes de solicitud de acceso.	Solicitud de proxy

Si deseas obtener más información para trabajar con proxies de API, consulta Información sobre las API y los proxies de API.

publishmessage

Se propaga cuando se ejecuta una política PublishMessage.

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
publishmessage.message.id	String	Solo lectura	Muestra el messageId (ID del mensaje publicado) del servidor de Pub/Sub. Apigee establece esta variable de flujo solo si la solicitud de publicación se realiza correctamente.	Solicitud de proxy

ratelimit

Se propaga cuando se ejecuta una política de cuotas o de SpikeArrest.

Nota: La propiedad ratelimit.policy_name.failed es la única propiedad aplicable a la política de Spike Arrest.

En la siguiente tabla, se describen las propiedades del objeto ratelimit:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
ratelimit.policy_name.allowed.count	Largo	Solo lectura	Muestra el recuento de cuotas permitido.	PostClientFlow
ratelimit.policy_name.used.count	Largo	Solo lectura	Muestra la cuota actual que se usó en un intervalo de cuota.	PostClientFlow
ratelimit.policy_name.available.count	Largo	Solo lectura	Muestra el recuento de cuotas disponible en el intervalo de cuota.	PostClientFlow
ratelimit.policy_name.exceed.count	Largo	Solo lectura	Muestra 1 después de que se excede la cuota.	PostClientFlow
ratelimit.policy_name.total.exceed.count	Largo	Solo lectura	Muestra 1 después de que se excede la cuota.	PostClientFlow
ratelimit.policy_name.expiry.time	Largo	Solo lectura	Muestra la hora UTC (en milisegundos), que determina cuándo vence la cuota y cuándo comienza el intervalo de cuota nuevo. Cuando el tipo de política de cuotas es rollingwindow, este valor no es válido porque el intervalo de cuota nunca vence.	PostClientFlow
ratelimit.policy_name.identifier	String	Solo lectura	Muestra la referencia del identificador (cliente) adjunto a la política.	PostClientFlow
ratelimit.policy_name.class	String	Solo lectura	Muestra la clase asociada con el identificador del cliente.	PostClientFlow
ratelimit.policy_name.class.allowed.count	Largo	Solo lectura	Muestra el recuento de cuotas permitido en la clase	PostClientFlow
ratelimit.policy_name.class.used.count	Largo	Solo lectura	Muestra la cuota que se usa en una clase.	PostClientFlow
ratelimit.policy_name.class.available.count	Largo	Solo lectura	Muestra el recuento de cuotas disponible en la clase	PostClientFlow
ratelimit.policy_name.class.exceed.count	Largo	Solo lectura	Muestra el recuento de solicitudes que exceden el límite en la clase en el intervalo de cuota actual	PostClientFlow
ratelimit.policy_name.class.total.exceed.count	Largo	Solo lectura	Muestra el recuento total de solicitudes que exceden el límite en la clase en todos los intervalos de cuota, por lo que es la suma de class.exceed.count para todos los intervalos de cuota.	PostClientFlow
ratelimit.policy_name.failed	Booleano	Solo lectura	Indica si la política falló (verdadero o falso).	PostClientFlow

Para obtener más información, consulta lo siguiente:

• Límite de frecuencia
• Comparar políticas de cuota y SpikeArrest
• Política de cuotas
• Política SpikeArrest

request

La solicitud completa, incluida cualquier carga útil presente.

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

En la siguiente tabla, se describen las propiedades del objeto request:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
request	message	Solo lectura	La solicitud completa, incluida cualquier carga útil presente.	Solicitud de proxy
request.content	String	Lectura/escritura	Obtiene o configura la carga útil del mensaje de solicitud.	Solicitud de proxy
request.formparam.param_name	String	Lectura/escritura	Obtiene o establece el valor del parámetro del 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 en particular en la solicitud, con formato como 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	Número entero	Solo lectura	Recuento de todos los valores del parámetro de formulario especificado asociado con la solicitud.	Solicitud de proxy
request.formparam.param_name.N	String	Lectura/escritura	El valor del parámetro Nth determinado del formulario en el mensaje. Por ejemplo, si la string del formulario es a=hello&a=world, el valor de muestra de request.formparam.a.1 es hello.	Solicitud de proxy
request.formparams.count	Número entero	Solo lectura	Recuento de todos los parámetros asociados con la solicitud enviada desde la aplicación cliente.	Solicitud de proxy
request.formparams.names	Colección	Solo lectura	Una lista de todos los nombres de parámetros asociados con la solicitud.	Solicitud de proxy
request.formparams.names.string	String	Solo lectura	Una lista separada por comas de todos los nombres de parámetros de formulario asociados con la solicitud.	Solicitud de proxy
request.formstring	String	Solo lectura	El formparam completo en la solicitud enviada desde la app cliente. Por ejemplo, name=test&type=first&group=A	Solicitud de proxy
request.grpc.rpc.name	String	Solo lectura	Solo se aplica cuando se usa un servidor de destino de gRPC. El nombre de la RPC. Para obtener información sobre los proxies de gRPC, consulta Crea proxies de API de gRPC.	Solicitud de proxy
request.grpc.service.name	String	Solo lectura	Solo se aplica cuando se usa un servidor de destino de gRPC. El nombre del servicio de estado de gRPC. Para obtener información sobre los proxies de gRPC, consulta Crea proxies de API de gRPC.	Solicitud de proxy
request.header.header_name	String	Lectura/escritura	Obtiene o establece el valor de un encabezado en particular que se encuentra en la solicitud. Si el encabezado contiene una coma, luego de la lectura, solo recibirás el segmento del texto hasta la primera coma. Por ejemplo, si el encabezado Cache-control es public, maxage=16544, entonces el valor de retorno de request.header.cache-control es public. Si quieres el encabezado completo como una string, usa una variable como request.header.header_name.values.string.	Solicitud de proxy
request.header.header_name.N	String	Lectura/escritura	El valor del valor Nth específico del encabezado en la solicitud. Apigee divide los valores de texto del encabezado por comas. El índice comienza en 1 para el valor más a la izquierda. Por ejemplo, si el encabezado Cache-control es public, maxage=16544, entonces el valor de retorno 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 en particular en la solicitud.	Solicitud de proxy
request.header.header_name.  values.count	Número entero	Solo lectura	Recuento de todos los valores de un encabezado en particular en la solicitud.	Solicitud de proxy
request.header.header_name.  values.string	String	Solo lectura	Todos los valores de un encabezado en particular de la solicitud, en forma de una sola string. Por ejemplo, si el encabezado Cache-control es public, maxage=16544, el valor de retorno de request.header.cache-control.values.string es public, maxage=16544.	Solicitud de proxy
request.headers.count	Número entero	Solo lectura	Recuento de todos los encabezados en 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	String	Solo lectura	Una lista separada por comas de los nombres de todos los encabezados de la solicitud	Solicitud de proxy
request.path	String	Solo lectura	La ruta de recursos sin proxy (sin incluir el host) al servicio de backend, sin incluir los parámetros de consulta. Por ejemplo, si el URI para el servicio de backend es https://example.com/rest/api/latest, entonces el valor de request.path es /rest/api/latest.	Solicitud de proxy
request.queryparam.param_name	String	Lectura/escritura	El valor de un parámetro de búsqueda particular que se encuentra en la solicitud.	Solicitud de proxy
request.queryparam.param_name.N	String	Lectura/escritura	El valor del parámetros de búsqueda Nth en la solicitud. Por ejemplo, si request.querystring es a=hello&a=world, entonces el valor de retorno de request.queryparam.a.1 es hello. Como ejemplo de escritura de varios valores para un solo nombre del parámetros de búsqueda, como type=siteid:1&type=language:us-en&type=currency:USD, configura 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 formulario en particular en la solicitud, con formato como una lista separada por comas. Por ejemplo, si request.querystring es a=hello&b=lovely&a=world, entonces el valor de request.queryparam.a.values es ['hello', 'world'].	Solicitud de proxy
request.queryparam.param_name.  values.count	Número entero	Solo lectura	El conteo de todos los valores de un parámetros de búsqueda particular en la solicitud.	Solicitud de proxy
request.queryparams.count	Número entero	Solo lectura	El conteo de todos los parámetros de búsqueda en la solicitud.	Solicitud de proxy
request.queryparams.names	Colección	Solo lectura	Los nombres de todos los parámetros de búsqueda en la solicitud.	Solicitud de proxy
request.queryparams.names.string	String	Solo lectura	Una lista separada por comas de los nombres de todos los parámetros de consulta en la solicitud.	Solicitud de proxy
request.querystring	String	Solo lectura	Lista completa de los parámetros de búsqueda en la solicitud enviada desde la app cliente. Por ejemplo, si la solicitud es http://host.com/123?name=first&surname=second&place=address, esta variable muestra name=first&surname=second&place=address.	Solicitud de proxy
request.transportid	String	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	String	Solo lectura	En un proxy de API, el proxy <BasePath> en ProxyEndpoint (además de la URL base del proxy) se asigna a la URL del servicio de destino en el TargetEndpoint. Por ejemplo: <ProxyEndpoint> ...   <BasePath>/my-mock-proxy</BasePath> Dirige 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 búsqueda. En la respuesta, request.uri es el resto de la dirección, incluidos los parámetros de búsqueda, después de HTTPTargetConnection. La diferencia es porque la solicitud original llegó al proxy, pero el proxy realiza otra solicitud al servicio de destino. Supongamos que la siguiente llamada se realiza a nuestro proxy de muestra, que tiene una ruta base de /my-mock-proxy: http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude Y el proxy llama a lo siguiente: http://mocktarget.apigee.net que agrega /user?user=Dude a esa URL. Solicitud: request.uri = /my-mock-proxy/user?user=Dude Respuesta: request.uri = /user?user=Dude	Solicitud de proxy (diferencias en la respuesta)
request.url	String	Solo lectura	Es la URL completa de la solicitud realizada al extremo de destino, incluidos los parámetros de string de búsqueda, pero no el número de puerto (si se especifica). Por ejemplo, si realizas una llamada a un proxy de muestra http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude y el extremo objetivo es http://example.com:8080, entonces el valor es: Solicitud: N/A Respuesta: http://example.com/user?user=Dude	Respuesta de destino
request.verb	String	Solo lectura	Verbo de HTTP que se usa para la solicitud. Por ejemplo, GET, PUT y DELETE.	Solicitud de proxy
request.version	String	Solo lectura	La 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 del objeto response:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
response	message	Lectura/escritura	Mensaje de respuesta completo que muestra el destino.	Respuesta de destino
response.content	String	Lectura/escritura	Contenido de la carga útil del mensaje de respuesta que muestra el destino.	Respuesta de destino
response.header.header_name	String	Lectura/escritura	Obtiene o configura el valor de un encabezado HTTP especificado en la respuesta. Si el texto del encabezado incluye una coma, Apigee infiere varios valores. En este caso, response.header.header_name solo muestra el primer valor. Por ejemplo, si el encabezado Cache-control es public,maxage=16544, entonces el valor de retorno de response.header.cache-control es public. Si quieres el encabezado completo como una string, usa una variable como response.header.header_name.values.string.	Respuesta de destino
response.header.header_name.  values	Colección	Solo lectura	Todos los valores de un encabezado HTTP especificado en respuesta.	Respuesta de destino
response.header.header_name.  values.count	Número entero	Solo lectura	Recuento de todos los valores del encabezado HTTP especificado en respuesta.	Respuesta de destino
response.header.header_name.  values.string	String	Solo lectura	Todos los valores de un encabezado en particular de la respuesta, en forma de una sola string. Por ejemplo, si el encabezado Cache-control es public,maxage=16544, el valor de retorno de response.header.cache-control.values.string es public,maxage=16544.	Respuesta de destino
response.header.header_name.N	String	Lectura/escritura	El valor del valor Nth determinado del encabezado en la respuesta. Apigee divide los valores de texto del encabezado por comas. El índice comienza en 1 para el valor más a la izquierda. Por ejemplo, si el encabezado Cache-control es public,maxage=16544, entonces response.header.cache-control.2 muestra maxage=16544.	Respuesta de destino
response.headers.count	Número entero	Solo lectura	Recuento de todos los encabezados en la respuesta	Respuesta de destino
response.headers.names	Colección	Solo lectura	Los nombres de todos los encabezados de la respuesta.	Respuesta de destino
response.headers.names.string	String	Solo lectura	Una lista separada por comas de los nombres de todos los encabezados de la respuesta.	Respuesta de destino
response.reason.phrase	String	Lectura/escritura	Frase del motivo de la respuesta para una solicitud en particular.	Respuesta de destino
response.status.code	Número entero	Lectura/escritura	El código de respuesta que se muestra para una solicitud. Puedes usar esta variable para anular el código de estado de respuesta, que se almacena en message.status.code. Para obtener más información, consulta message.	Respuesta de destino
response.transport.message	String	Solo lectura	Respuesta de tipo TransportMessage, que es un objeto contextual.	Respuesta de destino

route

Especifica los nombres de <RouteRule> y TargetEndpoint.

En la siguiente tabla, se describen las propiedades del objeto route:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
route.name	String	Solo lectura	El nombre de <RouteRule> que se ejecutó en ProxyEndpoint. Por ejemplo, default. Una RouteRule hace referencia a un TargetEndpoint del proxy de API que se ejecutará.	Solicitud de destino
route.target	String	Solo lectura	El nombre del TargetEndpoint que se ejecutó. Por ejemplo, default.	Solicitud de destino

servicecallout

Describe el TargetEndpoint para una política de Servicio de texto destacado.

En la siguiente tabla, se describen las propiedades del objeto servicecallout:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
servicecallout.policy_name.expectedcn	String	Lectura/escritura	El nombre común esperado del TargetEndpoint, al que se hace referencia en una política ServiceCallout. Esto es significativo solo cuando el TargetEndpoint hace referencia a un extremo TLS/SSL.	Solicitud de proxy
servicecallout.policy_name.target.url	String	Lectura/escritura	La URL de TargetEndpoint para una política de servicio de texto destacado particular.	Solicitud de proxy
servicecallout.requesturi	String	Lectura/escritura	El URI de TargetEndpoint para una política ServiceCallout. El URI es la URL de TargetEndpoint sin la especificación del protocolo y el dominio.	Solicitud de proxy

system

Especifica la dirección IP del sistema y los detalles del proxy.

En la siguiente tabla, se describen las propiedades del objeto system:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
system.interface.interface_name	String	Solo lectura	Dirección IP del sistema.	Solicitud de proxy
system.pod.name	String	Solo lectura	El nombre del Pod en el que se ejecuta el proxy.	Solicitud de proxy
system.region.name	String	Solo lectura	El nombre de la región del centro de datos donde se ejecuta el proxy.	Solicitud de proxy
system.time	String	Solo lectura	El momento en que se leyó esta variable. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 GMT Este valor es la representación de string del valor correspondiente de system.timestamp. Por ejemplo, mié, 21 de agosto de 2013, 19:16:47 GMT corresponde al valor de la marca de tiempo de 1377112607413.	Solicitud de proxy
system.time.year	Número entero	Solo lectura	La parte del año de system.time.	Solicitud de proxy
system.time.month	Número entero	Solo lectura	La parte del mes de system.time.	Solicitud de proxy
system.time.day	Número entero	Solo lectura	Parte del día del mes de system.time.	Solicitud de proxy
system.time.dayofweek	Número entero	Solo lectura	El día de la semana de system.time.	Solicitud de proxy
system.time.hour	Número entero	Solo lectura	La parte de hora de system.time.	Solicitud de proxy
system.time.minute	Número entero	Solo lectura	La parte de minutos de system.time.	Solicitud de proxy
system.time.second	Número entero	Solo lectura	La segunda parte de system.time.	Solicitud de proxy
system.time.millisecond	Número entero	Solo lectura	La parte de milésimas de segundo de system.time.	Solicitud de proxy
system.time.zone	String	Solo lectura	Zona horaria del sistema.	Solicitud de proxy
system.timestamp	Largo	Solo lectura	El número entero de 64 bits (largo) que representa la hora a la que se leyó esta variable. El valor es la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC. Por ejemplo: 1534783015000	Solicitud de proxy
system.uuid	String	Solo lectura	UUID del procesador de mensajes que controla el proxy.	Solicitud de proxy

target

Describe el destino de la solicitud.

En la siguiente tabla, se describen las propiedades del objeto target:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
target.basepath	String	Solo lectura	La ruta del recurso (sin incluir el dominio) al servicio de destino, sin incluir los parámetros de consulta, que se define en el 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 el siguiente: <TargetEndpoint name="default"> ...   <HTTPTargetConnection>     <URL>http://mocktarget.apigee.net</URL>   </HTTPTargetConnection> El valor target.basepath será nulo.	Solicitud de destino
target.copy.pathsuffix	Booleano	Lectura/escritura	Cuando es true, la solicitud reenviada de ProxyEndpoint a TargetEndpoint mantiene el sufijo de la ruta de acceso (el fragmento de ruta de URI que sigue al URI definido en la ruta base de proxyEndpoint).	Solicitud de destino
target.copy.queryparams	Booleano	Lectura/escritura	Cuando es true, la solicitud reenviada desde ProxyEndpoint a TargetEndpoint conserva los parámetros de consulta.	Solicitud de destino
target.country	String	Solo lectura	País del certificado TLS/SSL que presentó el servidor de destino	Respuesta de destino
target.cn	String	Solo lectura	El nombre común del TargetEndpoint. Esto es significativo solo cuando el TargetEndpoint hace referencia a un extremo TLS/SSL.	Solicitud de destino
target.email.address	String	Solo lectura	Dirección de correo electrónico del certificado TLS/SSL que presentó el servidor de destino	Respuesta de destino
target.expectedcn	String	Lectura/escritura	El nombre común esperado del TargetEndpoint. Esto es significativo solo cuando el TargetEndpoint hace referencia a un extremo TLS/SSL.	Solicitud de proxy
target.host	String	Solo lectura	El nombre de dominio del servicio de destino que muestra la respuesta al proxy de la API.	Respuesta de destino
target.ip	String	Solo lectura	La dirección IP del servicio de destino que reenvía la respuesta al proxy de API.	Respuesta de destino
target.locality	String	Solo lectura	Localidad (ciudad) del certificado TLS/SSL que presentó el servidor de destino	Respuesta de destino
target.name	String	Solo lectura	El objetivo es indicar a qué mensaje llega desde el extremo target.	Solicitud de destino
target.organization	String	Solo lectura	Organización del certificado TLS/SSL que presentó el servidor de destino.	Respuesta de destino
target.organization.unit	String	Solo lectura	Unidad organizativa del certificado TLS/SSL que presentó el servidor de destino.	Respuesta de destino
target.port	Número entero	Solo lectura	El número de puerto del servicio de destino que muestra la respuesta al proxy de API.	Respuesta de destino
target.received.end.time	String	Solo lectura	El tiempo, expresado en forma de string, en el que el TargetEndpoint terminó de recibir la respuesta del destino. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, Miércoles, 21 de agosto de 2013, 19:16:47 UT" corresponde al valor de la marca de tiempo de 1377112607413.	Respuesta de destino
target.received.end.   timestamp	Largo	Solo lectura	El valor de la marca de tiempo que especifica cuándo TargetEndpoint terminó de recibir la respuesta del destino. Por ejemplo, 1534783015000. Este valor es un número entero de 64 bits (largo) que especifica la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC.	Respuesta de destino
target.received.start.time	String	Solo lectura	El tiempo, expresado en forma de string, en el que el TargetEndpoint comenzó a recibir la respuesta del destino. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, Miércoles, 21 de agosto de 2013, 19:16:47 UTC corresponde al valor de la marca de tiempo de 1377112607413.	Respuesta de destino
target.received.start.   timestamp	Largo	Solo lectura	El valor de la marca de tiempo que especifica cuándo TargetEndpoint comenzó a recibir la respuesta del destino. Por ejemplo, 1534783015000. Este valor es un número entero de 64 bits (largo) que especifica la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC.	Respuesta de destino
target.scheme	String	Solo lectura	El alcance comienza: Respuesta objetivo Tipo: String Permiso: Lectura/escritura Muestra http o https según el mensaje de solicitud.	Solicitud de destino
target.sent.end.time	String	Solo lectura	La hora, expresada en forma de string, en la que el proxy comenzó a enviar la solicitud a la URL especificada en el TargetEndpoint. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, Miércoles, 21 de agosto de 2013, 19:16:47 UTC corresponde al valor de la marca de tiempo de 1377112607413.	Solicitud de destino
target.sent.end.timestamp	Largo	Solo lectura	El valor de la marca de tiempo que especifica cuándo el proxy terminó de enviar la solicitud a la URL especificada en el TargetEndpoint. Por ejemplo, 1377112607413. Este valor es un número entero de 64 bits (largo) que contiene la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC.	Solicitud de destino
target.sent.start.time	String	Solo lectura	La hora, expresada en forma de string, en la que el proxy comenzó a enviar la solicitud a la URL especificada en el TargetEndpoint. Por ejemplo, mié., 21 de agosto de 2013 a las 19:16:47 UTC Este valor de tiempo es la representación de string de la cantidad de marcas de tiempo de 32 bits correspondientes. Por ejemplo, Miércoles, 21 de agosto de 2013, 19:16:47 UTC corresponde al valor de la marca de tiempo de 1377112607413.	Solicitud de destino
target.sent.start.timestamp	Largo	Solo lectura	El valor de la marca de tiempo que especifica cuándo el proxy comenzó a enviar la solicitud a la URL especificada en el TargetEndpoint. Por ejemplo, 1534783015000. Este valor es un número entero de 64 bits (largo) que especifica la cantidad de milisegundos transcurridos desde la medianoche del 1 de enero de 1970 UTC.	Solicitud de destino
target.ssl.enabled	Booleano	Solo lectura	Establece si TargetEndpoint se ejecuta en TLS/SSL.	Solicitud de proxy
target.state	String	Solo lectura	Estado del certificado TLS/SSL que presentó el servidor de destino.	Respuesta de destino
target.url	String	Lectura/escritura	La URL configurada en el archivo XML de TargetEndpoint o la URL de destino dinámica (si target.url se configura durante el flujo de mensajes). La variable no incluye elementos de ruta de acceso adicionales ni parámetros de consulta. Muestra null si se llama fuera del alcance o no se configura. Nota: Usa una política de JavaScript adjunta a TargetEndpoint para configurar esta variable.	Solicitud de destino

variable

Un contenedor para la propiedad variable.expectedcn.

En la siguiente tabla, se describen las propiedades del objeto variable:

Propiedad	Tipo	Lectura/escritura	Descripción	El permiso comienza
variable.expectedcn	String	Lectura/escritura	Variable expuesta del nombre común si se ejecuta en TLS/SSL.	Solicitud de proxy

Si deseas obtener más información para trabajar con TLS, consulta las opciones para configurar TLS.