Referência de variáveis de fluxo

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Esta seção fornece informações de referência sobre as variáveis de fluxo.

A Apigee define as seguintes variáveis de fluxo:

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 uma dessas variáveis é descrita nas seções a seguir.

apigee

Uma variável auxiliar que fornece informações sobre o tempo de execução da política.

A tabela a seguir descreve as propriedades da variável apigee:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
apigee.metrics.policy.policy_name.timeTaken Número inteiro Somente leitura O tempo, em nanossegundos, que a política levou para ser executada. Política

apiproduct

Uma variável auxiliar que fornece informações sobre produtos de API.

A tabela a seguir descreve as propriedades da variável apiproduct:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
apiproduct.operation String Somente leitura

Nome da operação do produto da API. Essa variável ajuda a diferenciar as configurações da Política de cotas e as configurações de cota na operação de um produto da API.

Por exemplo, my-operation

 Solicitação de proxy
apiproduct.operation.resource String Somente leitura

O nome do recurso da operação que corresponde a uma solicitação.

 Solicitação de proxy
apiproduct.operation.methods Matriz Somente leitura

Uma matriz de métodos HTTP permitidos pela operação que está sendo correspondida.

 Solicitação de proxy
apiproduct.operation.attributes.key_name Matriz Somente leitura

Recebe o valor do atributo personalizado que corresponde ao key_name.

 Solicitação de proxy

Para ver mais informações, consulte os seguintes tópicos:

apiproxy

Descreve o proxy da API.

A tabela a seguir descreve as propriedades da variável apiproxy:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
apiproxy.name String Somente leitura Nome do proxy da API. Por exemplo, My Proxy Solicitação de proxy
apiproxy.revision String Somente leitura O número da revisão de um proxy de API. Por exemplo, 6 Solicitação de proxy
apiproxy.basepath String Somente leitura O caminho base da implantação (especificado durante a implantação da API). Solicitação de proxy

Para mais informações sobre como trabalhar com proxies de API, consulte Noções básicas sobre APIs e proxies de API.

client

O aplicativo ou sistema que enviou uma solicitação ao balanceador de carga.

A tabela a seguir descreve as propriedades da variável client:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
client.cn String Somente leitura

O nome comum especificado no certificado TLS/SSL apresentado pelo app cliente.

 Solicitação de proxy
client.country String Somente leitura

O país no certificado TLS/SSL apresentado pelo aplicativo cliente.

 Solicitação de proxy
client.email.address String Somente leitura

O endereço de e-mail no certificado TLS/SSL apresentado pelo app cliente.

 Solicitação de proxy
client.host String Somente leitura

O IP do host HTTP associado à solicitação recebida pelo ProxyEndpoint.

 Solicitação de proxy
client.ip String Somente leitura

O endereço IP do cliente ou sistema que envia a mensagem para o balanceador de carga. Por exemplo, pode ser o IP original do cliente ou um IP do balanceador de carga.

 Solicitação de proxy
client.locality String Somente leitura

A localidade (cidade) no certificado TLS/SSL apresentado pelo cliente.

 Solicitação de proxy
client.organization String Somente leitura A organização no certificado TLS/SSL apresentado pelo cliente. Não é necessariamente equivalente à organização na Apigee. Solicitação de proxy
client.organization.unit String Somente leitura

A unidade organizacional no certificado TLS/SSL apresentada pelo cliente.

 Solicitação de proxy
client.port Número inteiro Somente leitura

A porta HTTP associada à solicitação do cliente de origem para o ProxyEndpoint.

 Solicitação de proxy
client.received.end.time String Somente leitura

A hora, expressa em forma de string, em que o proxy terminou de receber a solicitação do cliente de origem no ProxyEndpoint. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor de tempo é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Solicitação de proxy
client.received.end.timestamp Longo Somente leitura

O valor de carimbo de data/hora que especifica quando o proxy terminou de receber a solicitação do cliente original no ProxyEndpoint. Esse valor é um número inteiro de 64 bits (longo) que contém o número de milissegundos decorrido desde a meia-noite de 1o de janeiro de 1970 UTC.

 Solicitação de proxy
client.received.start.time String Somente leitura

A hora, expressa em forma de string, em que o proxy começou a receber a solicitação do cliente de origem no ProxyEndpoint. Por exemplo: Qua, 21 Ago 2013 19:16:47 UTC

Esse valor de tempo é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Solicitação de proxy
client.received.start.timestamp Longo Somente leitura

O valor do carimbo de data/hora que especifica quando o proxy começou a receber a solicitação do cliente de origem no ProxyEndpoint. Esse valor é um número inteiro de 64 bits (longo) que contém o número de milissegundos decorrido desde a meia-noite de 1o de janeiro de 1970 UTC.

 Solicitação de proxy
client.scheme String Somente leitura

Retorna HTTP ou HTTPS, dependendo do transporte usado pelo aplicativo cliente para enviar a mensagem de solicitação.

 Solicitação de proxy
client.sent.end.time String Somente leitura

A hora, expressa em forma de string, em que o proxy terminou de enviar a resposta do ProxyEndpoint para o cliente. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor é uma representação de string do client.sent.end.timestamp de 32 bits correspondente. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 PostClientFlow
client.sent.end.timestamp Longo Somente leitura O valor de carimbo de data/hora que especifica quando o ProxyEndpoint terminou de retornar a resposta ao app cliente de origem. Esse valor é um número inteiro de 64 bits (longo) contendo o número de milissegundos decorridos desde a meia-noite, no dia 1º de janeiro de 1970, em UTC. PostClientFlow
client.sent.start.time String Somente leitura A data/hora, expressa na forma de string, em que o ProxyEndpoint começou a retornar a resposta ao aplicativo cliente de origem. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor é uma representação de string do client.sent.start.timestamp de 32 bits correspondente. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 PostClientFlow
client.sent.start.timestamp Longo Somente leitura Quando o proxy começou a enviar a resposta para o cliente a partir do ProxyEndpoint. Esse valor é expresso como um inteiro de 64 bits (longo) que contém o número de milissegundos decorridos desde a meia-noite, no dia 1º de janeiro de 1970, em UTC. PostClientFlow
client.ssl.enabled String Somente leitura

true se o ProxyEndpoint estiver configurado para TLS/SSL. Caso contrário, false.

 Solicitação de proxy
client.state String Somente leitura

O estado no certificado TLS/SSL apresentado pelo cliente.

 Solicitação de proxy

current

Contém informações sobre o fluxo atual do proxy da API.

A tabela a seguir descreve as propriedades da variável current:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
current.flow.name String Somente leitura O nome do fluxo que está sendo executado no momento (como PreFlow, PostFlow ou o nome de um fluxo condicional). Solicitação de proxy
current.flow.description String Somente leitura A descrição do fluxo em execução no momento. Este é o mesmo valor do elemento <Description> na configuração XML do fluxo. Solicitação de proxy

Veja essas propriedades na visualização do Trace da IU da Apigee.

environment

Um contêiner para a propriedade environment.name.

A tabela a seguir descreve as propriedades da variável environment:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
environment.name String Somente leitura Nome do ambiente em que a transação foi executada. Solicitação de proxy

error

Um objeto contextual que representa uma mensagem de erro no fluxo de erro.

A tabela a seguir descreve as propriedades da variável error:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
error message Read/Write Erro do tipo message, que é um objeto contextual no fluxo de erro. Erro
error.content String Read/Write Conteúdo do erro. Erro
error.message String Somente leitura

Mensagem associada a um erro, em que o valor está disponível somente antes que o fluxo de erro seja executado.

 Erro
error.status.code Número inteiro Somente leitura

O código de status HTTP associado ao erro. Por exemplo, 400

 Erro
error.reason.phrase String Somente leitura

A frase de motivo associada ao erro. Por exemplo, Bad Request.

 Erro
error.transport.message TransportMessage Somente leitura

Qualquer erro do tipo TransportMessage.

 Erro
error.state Número inteiro Somente leitura

Estado no fluxo em que ocorreu um erro.

 Erro
error.header.header_name String Read/Write

Recebe ou define o cabeçalho de resposta.

 Erro

fault

Mostra informações sobre a fonte do erro do ambiente de execução, o motivo e os detalhes. A Apigee define essas variáveis quando uma política gera um erro, e os valores são específicos para cada política. Para entender quando as variáveis fault são definidas, consulte Sobre erros de política.

Propriedade Tipo Leitura/gravação Descrição O escopo começa
fault.name String Somente leitura é o nome da falha, conforme descrito na tabela Erros de ambiente de execução, incluída em cada tópico de referência de política. Essa variável pode ser útil nas condições aplicadas a FaultRules. Erro
fault.reason String Somente leitura O motivo da falha. Por exemplo, quando a política OASValidation detectar que uma solicitação de entrada não é validada em relação à especificação da OpenAPI, ela definirá essa variável como uma string que descreve o nome da política, o nome da especificação e os detalhes que descrevem por que a solicitação não é validada em relação à especificação. Outras políticas definem essa variável como mensagens adequadas às respectivas falhas. Erro
fault.category String Somente leitura A categoria. Por exemplo, se a falha ocorrer em uma etapa da política, essa variável poderá conter o valor "Step". Essa variável pode ser útil nas condições aplicadas a FaultRules. Erro
fault.subcategory String Somente leitura A subcategoria. Por exemplo, se a política OASValidation detectar que uma solicitação não é validada em relação a uma especificação da OpenAPI, ela definirá essa variável como "OASValidationFailure". Essa variável pode ser útil nas condições aplicadas a FaultRules. Erro

graphql

Oferece acesso aos resultados de uma consulta GraphQL no ambiente de execução. Para mais informações, consulte a política GraphQL.

A tabela a seguir descreve as propriedades da variável graphql:

Propriedade Tipo Leitura/gravação Descrição
graphql Tipo complexo SOMENTE LER/LER GRAVAÇÃO A consulta GraphQL de raiz. ESCOPO
graphql.fragment Tipo complexo SOMENTE LER/LER GRAVAÇÃO Uma referência para o fragmento padrão desta consulta. ESCOPO
graphql.fragment.count Número inteiro Somente leitura O número de fragmentos gerados por essa consulta GraqhQL. ESCOPO
graphql.fragment.INDEX.selectionSet.INDEX TIPO SOMENTE LER/LER GRAVAÇÃO Uma referência ao conjunto de seleção no índice especificado. ESCOPO
graphql.fragment.INDEX.selectionSet.INDEX.name String SOMENTE LER/LER GRAVAÇÃO O nome do conjunto de seleção no índice especificado. ESCOPO
graphql.fragment.INDEX.selectionSet.count Número inteiro Somente leitura O número de conjuntos de seleção neste fragmento. ESCOPO
graphql.fragment.INDEX.selectionSet.name String SOMENTE LER/LER GRAVAÇÃO Nome da seleção padrão definida no fragmento. ESCOPO
graphql.operation Tipo complexo SOMENTE LER/LER GRAVAÇÃO Uma referência à operação padrão da consulta.

Não é possível definir cotas no nível da operação. Defina-as no nível do ambiente.

 ESCOPO
graphql.operation.name String Somente leitura O nome da operação padrão da consulta. ESCOPO
graphql.operation.operationType Enumeração Somente leitura O tipo de operação padrão da consulta que pode ser executada nesse proxy de API. Os valores possíveis são query, mutation ou all. ESCOPO
graphql.operation.selectionSet Tipo complexo A seleção padrão definida para a operação padrão da consulta. ESCOPO
graphql.operation.selectionSet.count Número inteiro Somente leitura O número de conjuntos de seleção na operação padrão da consulta. ESCOPO
graphql.operation.selectionSet.name String Somente leitura O nome do conjunto de seleção padrão da operação da consulta. ESCOPO
graphql.operation.selectionSet.INDEX Número inteiro Somente leitura Uma referência ao conjunto de seleção no índice especificado na lista de conjuntos de seleção. ESCOPO
graphql.operation.selectionSet.INDEX.name String Somente leitura O nome da seleção no índice especificado na lista de conjuntos de seleção para esta operação. ESCOPO
graphql.operation.selectionSet.INDEX.[selectionSet] Tipo complexo SOMENTE LER/LER GRAVAÇÃO Um ou mais objetos de conjunto de seleção adicionais.

Os conjuntos de seleção podem ser acessados recursivamente. Por exemplo, após uma selectionSet.index, é possível ter outra selectionSet.index em vez de uma propriedade name. Depois dessa, outra e assim por diante, até chegar ao valor de <MaxCount> definido na política GraphQL.

ESCOPO
graphql.operation.selectionSet.INDEX.directive Tipo complexo Uma referência à diretiva padrão no conjunto de seleções especificado. ESCOPO
graphql.operation.selectionSet.INDEX.directive.count Tipo complexo ESCOPO
graphql.operation.selectionSet.INDEX.directive.INDEX Número inteiro Somente leitura Uma referência à diretiva no índice especificado. ESCOPO
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX Número inteiro Somente leitura Uma referência ao argumento no índice especificado. ESCOPO
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name String O nome do argumento no índice especificado. ESCOPO
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value String O valor do argumento no índice especificado. ESCOPO
graphql.operation.selectionSet.INDEX.directive.name String ESCOPO
graphql.operation.variableDefinitions Tipo complexo Uma referência a uma lista de definições de variável para a operação padrão da consulta. ESCOPO
graphql.operation.variableDefinitions.count Número inteiro O número de definições de variável para a operação padrão da consulta. ESCOPO
graphql.operation.variableDefinitions.INDEX Número inteiro Uma referência à definição da variável no índice especificado. ESCOPO
graphql.operation.variableDefinitions.INDEX.name String O nome da definição da variável no índice especificado. ESCOPO
graphql.operation.variableDefinitions.INDEX.type O tipo do valor da definição de variável no índice especificado. ESCOPO

is

Um contêiner para a propriedade is.error.

A tabela a seguir descreve as propriedades da variável is:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
is.error Booleano Somente leitura

Sinalização de erro.

 Solicitação de proxy

loadbalancing

Fornece informações sobre o status de balanceamento de carga do TargetEndpoint.

A tabela a seguir descreve as propriedades da variável loadbalancing:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
loadbalancing.failedservers Matriz de strings Somente leitura

Lista de TargetServers com falha durante o balanceamento de carga em TargetEndpoint.

 Resposta de destino
loadbalancing.isfallback Booleano Somente leitura

true se o substituto estiver ativado para o TargetServer invocado durante o balanceamento de carga em TargetEndpoint.

 Resposta de destino
loadbalancing.targetserver String Somente leitura

TargetServer invocado durante o balanceamento de carga em TargetEndpoint. Defina somente se o elemento <Path> estiver definido ao definir o elemento do balanceador de carga.

 Resposta de destino

message

Um objeto contextual, com o mesmo valor de request no fluxo de solicitação ou como response no fluxo de resposta ou como error no fluxo de erros.

A tabela a seguir descreve as propriedades da variável message:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
message message Read/Write

Um objeto contextual, com o mesmo valor que request no fluxo de solicitação ou como response no fluxo de resposta ou como error no fluxo de erro.

 Solicitação de proxy
message.content String Read/Write

Conteúdo da mensagem de solicitação, resposta ou erro.

 Solicitação de proxy
message.formparam.param_name String Read/Write

Valor do parâmetro de formulário especificado.

 Solicitação de proxy
message.formparam.param_name.
 values		 Coleção Somente leitura

Todos os valores do parâmetro de formulário especificado na mensagem.

 Solicitação de proxy
message.formparam.param_name.
 values.count		 Número inteiro Somente leitura

Contagem dos valores dos parâmetros do formulário especificados na mensagem.

 Solicitação de proxy
message.formparams.count Número inteiro Somente leitura

Contagem de todos os parâmetros de formulário na mensagem.

 Solicitação de proxy
message.formparams.names Coleção Somente leitura

Valor de todos os parâmetros de formulário na mensagem.

 Solicitação de proxy
message.formparams.names.string String Somente leitura

Uma lista separada por vírgulas de nomes de todos os parâmetros de formulário na mensagem.

 Solicitação de proxy
message.formstring String Somente leitura

Valor da string do formulário na mensagem.

 Solicitação de proxy
message.header.header_name String Read/Write

Recebe ou define o valor de um determinado cabeçalho encontrado na solicitação. Se o cabeçalho contiver uma vírgula, após a leitura, você receberá apenas o segmento do texto até a primeira vírgula.

Por exemplo, se o cabeçalho Cache-control for public, maxage=16544, o valor de retorno de message.header.cache-control será public.

Se você quiser que o cabeçalho inteiro seja uma string, use uma variável como message.header.header_name.values.string.

 Solicitação de proxy
message.header.header_name.N String Read/Write

O valor do enésimo cabeçalho específico na mensagem, solicitação ou resposta, dependendo do estado do fluxo. A Apigee divide os valores de texto do cabeçalho por vírgulas. O índice começa em 1 para o valor mais à esquerda.

Por exemplo, se o cabeçalho Cache-control for public,maxage=16544, o valor de retorno de message.header.cache-control.2 será maxage=16544.

 Solicitação de proxy
message.header.header_name.
 values		 Coleção Somente leitura

Todos os valores do nome do cabeçalho HTTP especificado na mensagem.

 Solicitação de proxy
message.header.header_name.
 values.count		 Número inteiro Somente leitura

Contagem dos valores do nome do cabeçalho HTTP especificado na mensagem.

 Solicitação de proxy
message.header.header_name.
 values.string		 String Somente leitura

Todos os valores de um cabeçalho específico na mensagem, na forma de uma única string.

Por exemplo, se o cabeçalho Cache-control for public,maxage=16544, o valor de retorno de message.header.cache-control.values.string será public,maxage=16544.

 Solicitação de proxy
message.headers.count Número inteiro Somente leitura

Contagem de todos os cabeçalhos HTTP na mensagem.

 Solicitação de proxy
message.headers.names Coleção Somente leitura

Valor de todos os cabeçalhos HTTP na mensagem.

 Solicitação de proxy
message.headers.names.string String Somente leitura

Uma lista separada por vírgulas de nomes de todos os cabeçalhos na mensagem.

 Solicitação de proxy
message.path String Read/Write

O caminho completo da mensagem de solicitação no URL, excluindo os parâmetros de consulta.

Solicitação de proxy
message.queryparam.param_name String Somente leitura

Retorna o parâmetro de consulta de mensagem especificado.

 Solicitação de proxy
message.queryparam.param_name.N String Read/Write

O valor do enésimo parâmetro de consulta na mensagem. Por exemplo, se request.querystring for a=hello&a=world, o valor de retorno de message.queryparam.a.1 será hello.

Um exemplo de gravação de vários valores para um único nome de parâmetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, define o seguinte:

  • message.queryparam.type.1 a siteid:1
  • De message.queryparam.type.2 para language:en-us
  • message.queryparam.type.3 a currency:USD
 Solicitação de proxy
message.queryparam.param_name.
 values		 Coleção Somente leitura

Todos os valores de um parâmetro de consulta específico na mensagem, formatados como uma lista separada por vírgulas.

Por exemplo, se a string de consulta for a=hello&a=world, o valor de message.queryparam.a.values será ['hello', 'world']code>.

 Solicitação de proxy
message.queryparam.param_name.
 values.count		 Número inteiro Somente leitura

Contagem total de um parâmetro de consulta especificado associado à solicitação enviada ao ProxyEndpoint do aplicativo cliente.

 Solicitação de proxy
message.queryparams.count Número inteiro Somente leitura

A contagem total de todos os parâmetros de consulta associados à solicitação enviada ao ProxyEndpoint do aplicativo cliente.

 Solicitação de proxy
message.queryparams.names Coleção Somente leitura

Uma lista de todos os nomes de parâmetros de consulta associados à solicitação enviada ao ProxyEndpoint do aplicativo cliente.

 Solicitação de proxy
message.queryparams.names.string String Somente leitura

Uma lista separada por vírgulas de nomes de todos os parâmetros de consulta na mensagem.

 Solicitação de proxy
message.querystring String Somente leitura

Uma string que contém todos os nomes de parâmetros de consulta e valores associados à solicitação enviada ao ProxyEndpoint do aplicativo cliente.

Por exemplo, para a solicitação http://api.apifactory.com/inventors?name=nick&surname=danger, o valor de message.querystring é name=nick&surname=danger.

 Solicitação de proxy
message.status.code Número inteiro Somente leitura

Código de status HTTP da mensagem de resposta do destino.

 Resposta de destino
message.transport.message TransportMessage Somente leitura

Mensagem do tipo TransportMessage, que é um objeto contextual.

 Solicitação de proxy
message.uri String Somente leitura

O caminho completo do URI (após o URL de domínio), incluindo os parâmetros de consulta.

Por exemplo, para a solicitação http://api.apifactory.com/inventors?name=nikola&surname=tesla, essa variável retorna inventors?name=nikola&surname=tesla.

 Solicitação de proxy
message.verb String Somente leitura

O verbo HTTP (GET, PUT, POST, DELETE etc.) associado à solicitação.

 Solicitação de proxy
message.version String Read/Write

A versão HTTP associada à solicitação enviada ao ProxyEndpoint do aplicativo cliente.

 Solicitação de proxy

Para mais informações sobre mensagens, consulte Referência da função de modelo de mensagem.

messageid

Um contêiner para o ID globalmente exclusivo da solicitação.

A tabela a seguir descreve as propriedades da variável messageid:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
messageid String Somente leitura

Contém o ID globalmente exclusivo da solicitação, que inclui o nome de host do balanceador de carga. Esse ID permite que as solicitações recebidas no balanceador de carga sejam rastreadas após o envio do processador de mensagens.

Esse ID é registrado nos registros de erros da Apigee para correlacionar o messageid com os erros.

 Solicitação de proxy

mint

Uma variável auxiliar que fornece informações sobre monetização.

A tabela a seguir descreve as propriedades da variável mint:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
mint.limitscheck.is_request_blocked Booleano Somente leitura

Sinalização que especifica se a solicitação de API está bloqueada. Defina como true se is_subscription_found for false.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.limitscheck.is_subscription_found Booleano Somente leitura

Sinalização que especifica se o desenvolvedor tem uma assinatura ativa do produto de API. Defina como true se um desenvolvedor tiver uma assinatura.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.limitscheck.prepaid_developer_balance Numérico Somente leitura

Saldo atual na carteira da conta pré-paga do desenvolvedor associada à moeda do plano de tarifas.

 Solicitação de proxy
mint.limitscheck.prepaid_developer_currency String Somente leitura

Moeda do saldo disponível na variável mint.limitscheck.prepaid_developer_balance.

 Solicitação de proxy
mint.limitscheck.purchased_product_name String Somente leitura

Nome do produto da API associado.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.limitscheck.status_message String Somente leitura

Informações extras sobre a execução da política MonetizationLimitsCheck para fins de depuração.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.mintng_consumption_pricing_rates String Somente leitura

taxas por consumo.

Defina as taxas quando criar um plano de preços.

 PostClientFlow
mint.mintng_consumption_pricing_type String Somente leitura

Tipo de preços baseado no consumo. Por exemplo: FIXED_PER_UNIT

Defina as taxas com base no consumo quando criar um plano de taxas.

 PostClientFlow
mint.mintng_currency String Somente leitura

Moeda para calcular a receita.

Essa variável de fluxo tem o valor currency variável de monetização.

 Política DataCapture
mint.mintng_dev_share Numérico Somente leitura

Receita a ser compartilhada com o desenvolvedor.

Defina a receita a ser compartilhada com o desenvolvedor ao criar um plano de tarifas.

 PostClientFlow
mint.mintng_is_apiproduct_monetized Booleano Somente leitura

Sinalização que especifica se o produto de API gera receita (ou seja, se há um plano de taxas ativo em vigor).

Essa variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy da API. Consulte Como adicionar uma política de autenticação.

 Solicitação de proxy
mint.mintng_price Numérico Somente leitura

Receita para calcular a participação do desenvolvedor.

A variável de fluxo tem o valor da variável de monetização revShareGrossPrice.

 Política do DataCapture e PostClientFlow
mint.mintng_price_multiplier Numérico Somente leitura

Fator (multiplicador) pelo qual o custo por transação é multiplicado.

A variável de fluxo tem o valor da variável de monetização perUnitPriceMultiplier.

 Política do DataCapture e PostClientFlow
mint.mintng_rate Numérico Somente leitura

Taxa cobrada pela chamada de API.

Essa variável de fluxo mostra a taxa com base no consumo por chamada de API. Defina as taxas com base no consumo quando criar um plano de taxas. Se você configurou a variável de monetização perUnitPriceMultiplier na política do DataCapture, a Apigee calculará o custo da transação depois de considerar o valor da variável perUnitPriceMultiplier. Para mais informações, consulte Api price multiplier em Métricas.

 PostClientFlow
mint.mintng_rate_before_multipliers Numérico Somente leitura

Taxa cobrada pela chamada de API sem o cálculo de perUnitPriceMultiplier.

Se a política DataCapture capturar a variável de monetização perUnitPriceMultiplier, essa variável de fluxo mostrará o custo da transação antes de multiplicar o custo por perUnitPriceMultiplier.

 PostClientFlow
mint.mintng_rate_plan_id String Somente leitura

ID do plano de taxas.

Essa variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy da API. Consulte Como adicionar uma política de autenticação.

 Solicitação de proxy
mint.mintng_revenue_share_rates String Somente leitura

Taxas de participação na receita.

Defina a taxa de participação na receita ao criar um plano de tarifas.

 PostClientFlow
mint.mintng_revenue_share_type String Somente leitura

Tipo de participação na receita. Por exemplo: FIXED

Defina o tipo de participação na receita ao criar um plano de tarifas.

 PostClientFlow
mint.mintng_tx_success Booleano Somente leitura

Especifica se a transação é monetizada.

Essa variável de fluxo tem o valor transactionSuccess variável de monetização.

 Política DataCapture
mint.prepaid_updated_developer_usage Numérico Somente leitura

Uso atual do desenvolvedor pré-pago

O uso é calculado com base na configuração do plano de tarifas e no valor da variável de monetização perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Numérico Somente leitura

Prazo de validade do plano de preços em milissegundos desde a época.

Essa variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy da API. Consulte Como adicionar uma política de autenticação.

 Solicitação de proxy
mint.rateplan_start_time_ms Numérico Somente leitura

Tempo de ativação do plano de taxa em milissegundos desde a época.

Essa variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy da API. Consulte Como adicionar uma política de autenticação.

 Solicitação de proxy
mint.status String Somente leitura

Status da chamada com monetização. Preenchido apenas em caso de erro.

 PostClientFlow
mint.status_code Numérico Somente leitura

Código de status HTTP da chamada monetizada. Preenchido apenas em caso de erro.

 PostClientFlow
mint.subscription_end_time_ms Numérico Somente leitura

Prazo de validade da assinatura do produto da API em milissegundos desde a época.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.subscription_start_time_ms Numérico Somente leitura

Tempo de ativação para a assinatura do produto da API em milissegundos desde a época.

Essa variável de fluxo estará disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte Como aplicar limites de monetização em proxies de API.

 Solicitação de proxy
mint.tx_success_result Booleano Somente leitura

Indica se a monetização foi bem-sucedida para a transação.

A variável mint.tx_success_result pode ter os seguintes valores:

  • tx_success definido como "true": a variável transactionSuccess é true e a transação é monetizada. Como a transação é monetizada, os valores das variáveis mint.mintng_rate e mint.mintng_dev_share são calculados.
  • tx_success definido como "false": a variável transactionSuccess é false e a transação não gera receita. Como a transação não gera receita, os valores das variáveis mint.mintng_rate e mint.mintng_dev_share não são calculados.
  • tx_success não foi encontrado. O código de status da mensagem não era 2xx: a variável transactionSuccess não foi capturada e o código de status HTTP (message.status.code) da transação não foi 2xx. A transação não gera receita.
  • tx_success não foi encontrado. O código de status da mensagem era 2xx: a variável transactionSuccess não foi capturada e o código de status HTTP (message.status.code) da transação foi 2xx. A transação é monetizada.
 PostClientFlow

Para ver mais informações, consulte os seguintes tópicos:

organization

Um contêiner para a propriedade organization.name.

A tabela a seguir descreve as propriedades da variável organization:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
organization.name String Somente leitura

Nome da organização.

 Solicitação de proxy

Para mais informações sobre organizações, consulte Noções básicas sobre organizações.

proxy

A configuração do proxy da API.

A tabela a seguir descreve as propriedades da variável proxy:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
proxy.basepath String Somente leitura

O valor do caminho base na configuração endpoint do proxy de API. O caminho base é o fragmento de URI mais à esquerda que segue o host no URL. Os URIs do fluxo condicional seguem o caminho base.

Suponha que você tenha um endpoint de proxy de API configurado com um caminho base de /v2/weatherapi. Consulte Configuração do endpoint do proxy para mais detalhes. Nesse caso, se a solicitação de entrada usar o URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, faça o seguinte:

  • O nome do host é myhost.example.net. Para recuperá-la, leia a variável request.header.host.
  • O caminho base é /v2/weatherapi. Recupere-o lendo a variável proxy.basepath.
  • O sufixo do caminho é /forecastrss. Recupere-o lendo a variável proxy.pathsuffix.

Se você definir um caminho base dinâmico na sua configuração de proxy de API, como /v2/*/weatherapicode>, a variável proxy.basepath será definida como o caminho dinâmico. Para recuperar o URL real da solicitação, leia e analise a variável proxy.url.

 Solicitação de proxy
proxy.client.ip String Somente leitura

O endereço X-Forwarded-For da chamada de entrada, que é o endereço IP Apigee recebido do último handshake do TCP externo. Pode ser o cliente da chamada ou o balanceador de carga.

 Solicitação de proxy
proxy.name String Somente leitura

O atributo nome configurado para o ProxyEndpoint.

 Solicitação de proxy
proxy.pathsuffix String Somente leitura

O valor do sufixo do caminho no URL que é enviado do cliente e recebido no ProxyEndpoint.

O caminho base é o componente do caminho mais à esquerda que identifica exclusivamente um proxy de API em um grupo de ambiente. Suponha que você tenha um endpoint de proxy de API configurado com um caminho base de /v2/weatherapi. Nesse caso, uma solicitação enviada para https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, a variável proxy.pathsuffix conterá a string /forecastrss.

 Solicitação de proxy
proxy.url String Somente leitura

Recebe o URL completo associado à solicitação de proxy recebida pelo ProxyEndpoint, incluindo todos os parâmetros de consulta presentes.

 Solicitação de proxy

Para mais informações sobre como trabalhar com proxies de API, consulte Noções básicas sobre APIs e proxies de API.

publishmessage

Preenchido quando uma política PublishMessage é executada.

Propriedade Tipo Leitura/gravação Descrição O escopo começa
publishmessage.message.id String Somente leitura Retorna o messageId (ID da mensagem publicada) do servidor Pub/Sub.

A Apigee define essa variável de fluxo somente se a solicitação de publicação for bem-sucedida.

 Solicitação de proxy

ratelimit

Preenchido quando uma política de cota ou do SpikeArrest é executada.

A tabela a seguir descreve as propriedades da variável ratelimit:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
ratelimit.policy_name.allowed.count Longo Somente leitura Retorna a contagem de cotas permitida PostClientFlow
ratelimit.policy_name.used.count Longo Somente leitura Retorna a cota atual usada dentro de um intervalo de cotas. PostClientFlow
ratelimit.policy_name.available.count Longo Somente leitura Retorna a contagem de cotas disponíveis no intervalo de cotas. PostClientFlow
ratelimit.policy_name.exceed.count Longo Somente leitura Retorna 1 após a cota ser excedida. PostClientFlow
ratelimit.policy_name.total.exceed.count Longo Somente leitura Retorna 1 após a cota ser excedida. PostClientFlow
ratelimit.policy_name.expiry.time Longo Somente leitura

Retorna o horário UTC (em milissegundos), que determina quando a cota expira e quando o novo intervalo de cota é iniciado.

Quando o tipo de política de cotas é rollingwindow, esse valor não é válido porque o intervalo de cota nunca expira.

 PostClientFlow
ratelimit.policy_name.identifier String Somente leitura Retorna a referência do identificador (cliente) anexada à política PostClientFlow
ratelimit.policy_name.class String Somente leitura Retorna a classe associada ao identificador do cliente PostClientFlow
ratelimit.policy_name.class.allowed.count Longo Somente leitura Retorna a contagem de cotas permitidas definida na classe PostClientFlow
ratelimit.policy_name.class.used.count Longo Somente leitura Retorna a cota usada dentro de uma classe PostClientFlow
ratelimit.policy_name.class.available.count Longo Somente leitura Retorna a contagem de cotas disponíveis na classe PostClientFlow
ratelimit.policy_name.class.exceed.count Longo Somente leitura Retorna a contagem de solicitações que excede o limite da classe no intervalo de cota atual. PostClientFlow
ratelimit.policy_name.class.total.exceed.count Longo Somente leitura Retorna a contagem total de solicitações que excedem o limite na classe em todos os intervalos de cota. Portanto, é a soma de class.exceed.count para todos os intervalos de cota. PostClientFlow
ratelimit.policy_name.failed Booleano Somente leitura

Indica se a política falhou (verdadeiro ou falso).

 PostClientFlow

Para ver mais informações, consulte os seguintes tópicos:

request

A solicitação completa, incluindo qualquer payload presente.

Para mais informações sobre dados de solicitação, consulte Como os dados de solicitação são passados para o servidor de back-end?

A tabela a seguir descreve as propriedades da variável request:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
request message Somente leitura

A solicitação completa, incluindo qualquer payload presente.

 Solicitação de proxy
request.content String Read/Write

Recebe ou define o payload da mensagem de solicitação.

 Solicitação de proxy
request.formparam.param_name String Read/Write

Recebe ou define o valor do parâmetro de formulário especificado na solicitação enviada pelo aplicativo cliente.

 Solicitação de proxy
request.formparam.param_name.
 values		 Coleção Somente leitura

Todos os valores de um parâmetro de formulário específico na solicitação, formatados como uma lista separada por vírgulas.

Por exemplo, se o payload for a=hello&x=greeting&a=world, o valor de request.formparam.a.values será ['hello', 'world'].

 Solicitação de proxy
request.formparam.param_name.
 values.count		 Número inteiro Somente leitura

Contagem de todos os valores do parâmetro de formulário especificado associado à solicitação.

 Solicitação de proxy
request.formparam.param_name.N String Read/Write

O valor do enésimo parâmetro do formulário específico na mensagem. Por exemplo, se a string de formulário for a=hello&a=world, o valor de retorno de request.formparam.a.1 será hello.

 Solicitação de proxy
request.formparams.count Número inteiro Somente leitura

Contagem de todos os parâmetros associados à solicitação enviada do aplicativo cliente.

 Solicitação de proxy
request.formparams.names Coleção Somente leitura

Uma lista de todos os nomes de parâmetros associados à solicitação.

 Solicitação de proxy
request.formparams.names.string String Somente leitura

Uma lista separada por vírgulas de todos os nomes de parâmetros de formulário associados à solicitação.

 Solicitação de proxy
request.formstring String Somente leitura

O formparam completo na solicitação enviada pelo app cliente.

Por exemplo, name=test&type=first&group=A

 Solicitação de proxy
request.grpc.rpc.name String Somente leitura

Aplicável somente ao usar um servidor de destino gRPC. Nome da RPC. Para informações sobre proxies gRPC, consulte Como criar proxies de API gRPC.

Solicitação de proxy
request.grpc.service.name String Somente leitura

Aplicável somente ao usar um servidor de destino gRPC. O nome do serviço de status gRPC. Para informações sobre proxies gRPC, consulte Como criar proxies de API gRPC.

Solicitação de proxy
request.header.header_name String Read/Write

Recebe ou define o valor de um determinado cabeçalho encontrado na solicitação. Se o cabeçalho contiver uma vírgula, após a leitura, você receberá apenas o segmento do texto até a primeira vírgula.

Por exemplo, se o cabeçalho Cache-control for public, maxage=16544, o valor de retorno de request.header.cache-control será public.

Se você quiser que o cabeçalho inteiro seja uma string, use uma variável como request.header.header_name.values.string.

 Solicitação de proxy
request.header.header_name.N String Read/Write

O valor do enésimo cabeçalho específico na solicitação. A Apigee divide os valores de texto de cabeçalho por vírgulas. O índice começa em 1 para o valor mais à esquerda.

Por exemplo, se o cabeçalho Cache-control for public, maxage=16544, o valor de retorno de request.header.cache-control.2 será maxage=16544.

 Solicitação de proxy
request.header.header_name.
 values		 Coleção Somente leitura

Todos os valores de um cabeçalho específico na solicitação.

 Solicitação de proxy
request.header.header_name.
 values.count		 Número inteiro Somente leitura

Contagem de todos os valores de um cabeçalho específico na solicitação.

 Solicitação de proxy
request.header.header_name.
 values.string		 String Somente leitura

Todos os valores de um cabeçalho específico na solicitação, na forma de uma única string.

Por exemplo, se o cabeçalho Cache-control for public, maxage=16544, o valor de retorno de request.header.cache-control.values.string será public, maxage=16544.

 Solicitação de proxy
request.headers.count Número inteiro Somente leitura

Contagem de todos os cabeçalhos na solicitação.

 Solicitação de proxy
request.headers.names Coleção Somente leitura

Nomes de todos os cabeçalhos na solicitação.

 Solicitação de proxy
request.headers.names.string String Somente leitura

Uma lista separada por vírgulas de nomes de todos os cabeçalhos da solicitação.

 Solicitação de proxy
request.path String Somente leitura

O caminho do recurso sem proxy (não incluindo o host) para o serviço de back-end, excluindo parâmetros de consulta.

Por exemplo, se o URI do serviço de back-end for https://example.com/rest/api/latest, o valor de request.path será /rest/api/latest.

 Solicitação de proxy
request.queryparam.param_name String Read/Write

O valor de um parâmetro de consulta específico encontrado na solicitação.

 Solicitação de proxy
request.queryparam.param_name.N String Read/Write

O valor do enésimo parâmetro de consulta na solicitação.

Por exemplo, se request.querystring for a=hello&a=world, o valor de retorno de request.queryparam.a.1 será hello.

Um exemplo de gravação de vários valores para um único nome de parâmetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, define o seguinte:

  • request.queryparam.type.1 a siteid:1
  • De request.queryparam.type.2 para language:en-us
  • request.queryparam.type.3 a currency:USD
 Solicitação de proxy
request.queryparam.param_name.
 values		 Coleção Somente leitura

Todos os valores de um parâmetro de consulta específico na solicitação, formatados como uma lista separada por vírgulas.

Por exemplo, se request.querystring for a=hello&b=lovely&a=world, o valor de request.queryparam.a.values será ['hello', 'world'].

 Solicitação de proxy
request.queryparam.param_name.
 values.count		 Número inteiro Somente leitura

A contagem de todos os valores de um parâmetro de consulta específico na solicitação.

 Solicitação de proxy
request.queryparams.count Número inteiro Somente leitura

Contagem de todos os parâmetros de consulta na solicitação.

 Solicitação de proxy
request.queryparams.names Coleção Somente leitura

Os nomes de todos os parâmetros de consulta na solicitação.

 Solicitação de proxy
request.queryparams.names.string String Somente leitura

Uma lista separada por vírgulas dos nomes de todos os parâmetros de consulta na solicitação.

 Solicitação de proxy
request.querystring String Somente leitura

A lista completa de parâmetros de consulta na solicitação enviada do aplicativo cliente.

Por exemplo, se a solicitação for http://host.com/123?name=first&surname=second&place=address, essa variável retornará name=first&surname=second&place=address.

 Solicitação de proxy
request.transportid String Somente leitura

ID da solicitação como o tipo TransportMessage, que é contextual.

 Solicitação de proxy
request.transport.message Transport-Message Somente leitura

Solicitação do tipo TransportMessage, que é contextual.

 Solicitação de proxy
request.uri String Somente leitura

Em um proxy de API, o proxy <BasePath> no ProxyEndpoint (além do URL base do proxy) mapeia para o URL de serviço de destino no TargetEndpoint. Exemplo:

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

Aponta para

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

Na solicitação, request.uri é o caminho base do proxy + o restante do endereço, incluindo os parâmetros de consulta.

Na resposta, request.uri é o restante do endereço, incluindo os parâmetros de consulta, após o HTTPTargetConnection.

A diferença é que a solicitação original veio ao proxy, mas esse proxy fará outra solicitação ao serviço de destino.

Digamos que a seguinte chamada seja feita para nosso proxy de amostra, que tem um caminho base de /my-mock-proxy:

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

E o proxy chama:

http://mocktarget.apigee.net

que anexa /user?user=Dude a esse URL

  • Solicitação: request.uri = /my-mock-proxy/user?user=Dude
  • Resposta: request.uri = /user?user=Dude
 Solicitação de proxy (as diferenças na resposta)
request.url String Somente leitura

O URL completo da solicitação feita ao endpoint de destino, incluindo os parâmetros da string de consulta, mas sem incluir o número da porta (se especificado).

Por exemplo, se você fizer uma chamada para um proxy de exemplo http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude e o endpoint de destino for http://example.com:8080, o valor será:

  • Solicitação: n/a
  • Resposta: http://example.com/user?user=Dude
 Resposta de destino
request.verb String Somente leitura

O verbo HTTP usado para a solicitação. Por exemplo, GET, PUT e DELETE.

 Solicitação de proxy
request.version String Somente leitura

A versão HTTP da solicitação. Por exemplo, 1.1

 Solicitação de proxy

response

A resposta completa, incluindo qualquer payload presente.

A tabela a seguir descreve as propriedades da variável response:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
response message Read/Write

Mensagem de resposta completa retornada pelo destino.

 Resposta de destino
response.content String Read/Write

Conteúdo de payload da mensagem de resposta retornada pelo destino.

 Resposta de destino
response.header.header_name String Read/Write

Recebe ou define o valor de um cabeçalho HTTP especificado na resposta.

Se o texto do cabeçalho incluir uma vírgula, a Apigee inferirá vários valores. Nesse caso, response.header.header_name retorna o primeiro valor apenas.

Por exemplo, se o cabeçalho Cache-control for public,maxage=16544, o valor de retorno de response.header.cache-control será public.

Se você quiser que o cabeçalho inteiro seja uma string, use uma variável como response.header.header_name.values.string.

 Resposta de destino
response.header.header_name.
 values		 Coleção Somente leitura

Todos os valores de um cabeçalho HTTP especificado em resposta.

 Resposta de destino
response.header.header_name.
 values.count		 Número inteiro Somente leitura

Contagem de todos os valores do cabeçalho HTTP especificado em resposta.

 Resposta de destino
response.header.header_name.
 values.string		 String Somente leitura

Todos os valores de um cabeçalho específico na resposta, na forma de uma única string.

Por exemplo, se o cabeçalho Cache-control for public,maxage=16544, o valor de retorno de response.header.cache-control.values.string será public,maxage=16544.

 Resposta de destino
response.header.header_name.N String Read/Write

O valor do enésimo valor do cabeçalho na resposta. A Apigee divide os valores de texto de cabeçalho por vírgulas. O índice começa em 1 para o valor mais à esquerda.

Por exemplo, se o cabeçalho Cache-control for public,maxage=16544, response.header.cache-control.2 retornará maxage=16544.

 Resposta de destino
response.headers.count Número inteiro Somente leitura

Contagem de todos os cabeçalhos na resposta.

 Resposta de destino
response.headers.names Coleção Somente leitura

Os nomes de todos os cabeçalhos na resposta.

 Resposta de destino
response.headers.names.string String Somente leitura

Uma lista separada por vírgulas dos nomes de todos os cabeçalhos na resposta.

 Resposta de destino
response.reason.phrase String Read/Write

A frase do motivo da resposta para uma determinada solicitação.

 Resposta de destino
response.status.code Número inteiro Read/Write

O código de resposta retornado para uma solicitação. Use essa variável para substituir o código de status de resposta, armazenado em message.status.code. Para mais informações, consulte message.

 Resposta de destino
response.transport.message String Somente leitura

Resposta do tipo TransportMessage, que é um objeto contínuo.

 Resposta de destino

route

Especifica os nomes de <RouteRule> e TargetEndpoint.

A tabela a seguir descreve as propriedades da variável route:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
route.name String Somente leitura

O nome do <RouteRule> que foi executado no ProxyEndpoint. Por exemplo, default. Uma RouteRule faz referência a um TargetEndpoint da API para ser executado.

 Solicitação de destino
route.target String Somente leitura

O nome do TargetEndpoint que foi executado. Por exemplo, default

 Solicitação de destino

servicecallout

Descreve o TargetEndpoint para uma política ServiceCallout.

A tabela a seguir descreve as propriedades da variável servicecallout:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
servicecallout.policy_name.expectedcn String Read/Write

O nome comum esperado do TargetEndpoint, conforme mencionado em uma política ServiceCallout. Isso é significativo somente quando o TargetEndpoint se refere a um endpoint TLS/SSL.

 Solicitação de proxy
servicecallout.policy_name.target.url String Read/Write

O URL TargetEndpoint de uma política ServiceCallout específica.

 Solicitação de proxy
servicecallout.requesturi String Read/Write

O URI TargetEndpoint de uma política ServiceCallout. O URI é o URL TargetEndpoint sem o protocolo e a especificação do domínio.

 Solicitação de proxy

system

Especifica o endereço IP do sistema, bem como detalhes sobre o proxy.

A tabela a seguir descreve as propriedades da variável system:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
system.interface.interface_name String Somente leitura

Endereço IP do sistema.

 Solicitação de proxy
system.pod.name String Somente leitura

O nome do pod em que o proxy está sendo executado.

 Solicitação de proxy
system.region.name String Somente leitura

O nome da região do data center em que o proxy está sendo executado.

 Solicitação de proxy
system.time String Somente leitura

A hora em que essa variável foi lida. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor é a representação de string do valor correspondente de system.timestamp. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor de carimbo de data/hora 1377112607413.

 Solicitação de proxy
system.time.year Número inteiro Somente leitura

A parte do ano de system.time.

 Solicitação de proxy
system.time.month Número inteiro Somente leitura

A parte do mês de system.time.

 Solicitação de proxy
system.time.day Número inteiro Somente leitura

Parte do dia do mês de system.time.

 Solicitação de proxy
system.time.dayofweek Número inteiro Somente leitura

O dia da parte da semana de system.time.

 Solicitação de proxy
system.time.hour Número inteiro Somente leitura

A parte de hora de system.time.

 Solicitação de proxy
system.time.minute Número inteiro Somente leitura

A parte do minuto de system.time.

 Solicitação de proxy
system.time.second Número inteiro Somente leitura

A segunda parte de system.time.

 Solicitação de proxy
system.time.millisecond Número inteiro Somente leitura

A parte em milissegundos de system.time.

 Solicitação de proxy
system.time.zone String Somente leitura

Fuso horário do sistema.

 Solicitação de proxy
system.timestamp Longo Somente leitura

O inteiro de 64 bits (longo) que representa o momento em que essa variável foi lida. O valor é o número de milissegundos decorridos à meia-noite de 1º de janeiro de 1970 UTC. Por exemplo, 1534783015000:

 Solicitação de proxy
system.uuid String Somente leitura

O UUID do processador de mensagens que processa o proxy.

 Solicitação de proxy

target

Descreve o destino da solicitação.

A tabela a seguir descreve as propriedades da variável target:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
target.basepath String Somente leitura

O caminho do recurso (sem incluir o domínio) para o serviço de destino, excluindo parâmetros de consulta, que é definido no TargetEndpoint do proxy.

Por exemplo, digamos que um proxy de API chame o seguinte destino:

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

Neste exemplo, target.basepath é /user.

Se o destino fosse este:

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

O target.basepath seria nulo.

 Solicitação de destino
target.copy.pathsuffix Booleano Read/Write

Quando true, a solicitação encaminhada de ProxyEndpoint para TargetEndpoint mantém o sufixo de caminho (o fragmento do caminho de URI após o URI definido no caminho base de ProxyEndpoint).

 Solicitação de destino
target.copy.queryparams Booleano Read/Write

Quando true, a solicitação encaminhada de ProxyEndpoint para TargetEndpoint mantém os parâmetros de consulta.

 Solicitação de destino
target.country String Somente leitura

País do certificado TLS/SSL apresentado pelo servidor de destino

 Resposta de destino
target.cn String Somente leitura

O nome comum do TargetEndpoint. Isso é significativo somente quando o TargetEndpoint se refere a um endpoint TLS/SSL.

 Solicitação de destino
target.email.address String Somente leitura

Endereço de e-mail do certificado TLS/SSL apresentado pelo servidor de destino

 Resposta de destino
target.expectedcn String Read/Write

O nome comum esperado do TargetEndpoint. Isso é significativo somente quando o TargetEndpoint se refere a um endpoint TLS/SSL.

 Solicitação de proxy
target.host String Somente leitura

O nome de domínio do serviço de destino que retorna a resposta ao proxy de API.

 Resposta de destino
target.ip String Somente leitura

O endereço IP do serviço de destino que retorna a resposta ao proxy de API.

 Resposta de destino
target.locality String Somente leitura

Localidade (cidade) do certificado TLS/SSL apresentado pelo servidor de destino

 Resposta de destino
target.name String Somente leitura

Destino que a mensagem alcança do endpoint de destino.

 Solicitação de destino
target.organization String Somente leitura

Organização do certificado TLS/SSL apresentado pelo servidor de destino.

 Resposta de destino
target.organization.unit String Somente leitura

Unidade organizacional do certificado TLS/SSL apresentada pelo servidor de destino.

 Resposta de destino
target.port Número inteiro Somente leitura

O número da porta do serviço de destino que retorna a resposta para o proxy da API.

 Resposta de destino
target.received.end.time String Somente leitura

A data/hora, expressa na forma de string, em que o TargetEndpoint concluiu o recebimento da resposta do destino. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor de data/hora é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Resposta de destino
target.received.end.
  timestamp		 Longo Somente leitura

O valor do carimbo de data/hora que especifica quando o TargetEndpoint terminou de receber a resposta do destino. Por exemplo, 1534783015000 Esse valor é um número inteiro (longo) de 64 bits que especifica o número de milissegundos decorridos desde a meia-noite, em 1º de janeiro de 1970, em UTC.

 Resposta de destino
target.received.start.time String Somente leitura

A data/hora expressa na forma de string, em que o TargetEndpoint começou a receber a resposta do destino. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor de data/hora é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Resposta de destino
target.received.start.
  timestamp		 Longo Somente leitura

O valor do carimbo de data/hora que especifica quando o TargetEndpoint começou a receber a resposta do destino. Por exemplo, 1534783015000 Esse valor é um número inteiro (longo) de 64 bits que especifica o número de milissegundos decorridos desde a meia-noite, em 1º de janeiro de 1970, em UTC.

 Resposta de destino
target.scheme String Somente leitura

Escopo iniciado: resposta de destino
Tipo: string
Permissão: leitura/gravação

Retorna http ou https, dependendo da mensagem de solicitação.

 Solicitação de destino
target.sent.end.time String Somente leitura

A data/hora, expressa na forma de string, em que o proxy parou de enviar a solicitação ao URL especificado no TargetEndpoint. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor de data/hora é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Solicitação de destino
target.sent.end.timestamp Longo Somente leitura

O valor do carimbo de data/hora que especifica quando o proxy terminou de enviar a solicitação ao URL especificado no TargetEndpoint. Por exemplo, 1377112607413. Esse valor é um inteiro (longo) de 64 bits contendo o número de milissegundos decorridos desde a meia-noite, em 1º de janeiro de 1970, no horário UTC.

 Solicitação de destino
target.sent.start.time String Somente leitura

A data/hora, expressa na forma de string, em que o proxy começou a enviar a solicitação para o URL especificado no TargetEndpoint. Por exemplo: quarta-feira, 21 de agosto de 2013 19h16m47s UTC.

Esse valor de data/hora é a representação de string da quantidade de carimbo de data/hora correspondente de 32 bits. Por exemplo, quarta-feira, 21 de agosto de 2013 19h16m47s UTC corresponde ao valor do carimbo de data/hora 1377112607413.

 Solicitação de destino
target.sent.start.timestamp Longo Somente leitura

O valor do carimbo de data/hora que especifica quando o proxy começou a enviar a solicitação ao URL especificado no TargetEndpoint. Por exemplo, 1534783015000 Esse valor é um número inteiro de 64 bits (longo) que especifica o número de milissegundos decorridos desde a meia-noite, em 1º de janeiro de 1970, em UTC.

 Solicitação de destino
target.ssl.enabled Booleano Somente leitura

Indica se o TargetEndpoint está sendo executado em TLS/SSL.

 Solicitação de proxy
target.state String Somente leitura

Estado do certificado TLS/SSL apresentado pelo servidor de destino.

 Resposta de destino
target.url String Read/Write

É o URL configurado no arquivo XML TargetEndpoint ou no URL de destino dinâmico (se target.url estiver definido durante o fluxo da mensagem). A variável não inclui outros elementos de caminho ou parâmetros de consulta. Retorna nulo se chamado fora do escopo ou não definido.

 Solicitação de destino

variable

Um contêiner para a propriedade variable.expectedcn.

A tabela a seguir descreve as propriedades da variável variable:

Propriedade Tipo Leitura/gravação Descrição O escopo começa
variable.expectedcn String Read/Write

Variável exposta para o nome comum se estiver sendo executada em TLS/SSL.

 Solicitação de proxy

Para mais informações sobre como trabalhar com o TLS, consulte Opções para configurar o TLS.