Referência de variáveis de fluxo

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

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

O 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 destas variáveis é descrita nas secções que se seguem.

apigee

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

A tabela seguinte descreve as propriedades da variável apigee:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
apigee.metrics.policy.policy_name.timeTaken Número inteiro Só de leitura O tempo, em nanosegundos, que a política demorou a executar. Política

apiproduct

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

A tabela seguinte descreve as propriedades da variável apiproduct:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
apiproduct.operation String Só de leitura

Nome da operação do produto API. Esta variável ajuda a distinguir entre as definições da política de quotas e as definições de quotas na operação de um produto da API.

Por exemplo, my-operation.

 Pedido de proxy
apiproduct.operation.resource String Só de leitura

O nome do recurso da operação que corresponde a um pedido.

 Pedido de proxy
apiproduct.operation.methods Matriz Só de leitura

Uma matriz de métodos HTTP que a operação correspondente permite.

 Pedido de proxy
apiproduct.operation.attributes.key_name Matriz Só de leitura

Obtém o valor do atributo personalizado que corresponde ao key_name.

 Pedido de proxy

Para mais informações, consulte o seguinte:

apiproxy

Descreve o proxy de API.

A tabela seguinte descreve as propriedades da variável apiproxy:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
apiproxy.name String Só de leitura Nome do proxy de API. Por exemplo, My Proxy. Pedido de proxy
apiproxy.revision String Só de leitura O número de revisão de um proxy de API. Por exemplo, 6. Pedido de proxy
apiproxy.basepath String Só de leitura O caminho base de implementação (especificado durante a implementação da API). Pedido de proxy

Para mais informações sobre como trabalhar com proxies de API, consulte o artigo Compreender as APIs e os proxies de API.

client

A aplicação ou o sistema que enviou um pedido ao balanceador de carga.

A tabela seguinte descreve as propriedades da variável client:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
client.cn String Só de leitura

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

 Pedido de proxy
client.country String Só de leitura

O país no certificado TLS/SSL apresentado pela app cliente.

 Pedido de proxy
client.email.address String Só de leitura

O endereço de email no certificado TLS/SSL apresentado pela app cliente.

 Pedido de proxy
client.host String Só de leitura

O IP do anfitrião HTTP associado ao pedido recebido pelo ProxyEndpoint.

 Pedido de proxy
client.ip String Só de leitura

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

 Pedido de proxy
client.locality String Só de leitura

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

 Pedido de proxy
client.organization String Só de leitura A organização no certificado TLS/SSL apresentado pelo cliente. (Não necessariamente equivalente à organização no Apigee.) Pedido de proxy
client.organization.unit String Só de leitura

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

 Pedido de proxy
client.port Número inteiro Só de leitura

A porta HTTP associada ao pedido do cliente de origem ao ProxyEndpoint.

 Pedido de proxy
client.received.end.time String Só de leitura

A hora, expressa no formato de string, em que o proxy terminou de receber o pedido do cliente de origem no ProxyEndpoint. Por exemplo: Wed, 21 Aug 2013 19:16:47 UTC.

Este valor temporal é a representação de string da quantidade de data/hora de 32 bits correspondente. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Pedido de proxy
client.received.end.timestamp Longo Só de leitura

O valor da data/hora que especifica quando o proxy terminou de receber o pedido do cliente de origem no ProxyEndpoint. Este valor é um número inteiro de 64 bits (longo) que contém o número de milissegundos decorridos desde a meia-noite de 1 de janeiro de 1970 UTC.

 Pedido de proxy
client.received.start.time String Só de leitura

A hora, expressa em formato de string, em que o proxy começou a receber o pedido do cliente de origem no ProxyEndpoint. Por exemplo: Wed, 21 Aug 2013 19:16:47 UTC

Este valor temporal é a representação de string da quantidade de data/hora de 32 bits correspondente. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Pedido de proxy
client.received.start.timestamp Longo Só de leitura

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

 Pedido de proxy
client.resolved.ip String Só de leitura

O endereço IP do cliente resolvido. Este é o valor determinado a partir de uma definição de resolução de IP do cliente configurada ou do algoritmo predefinido, se não for especificada uma definição de resolução de IP do cliente. Consulte o artigo Resolução do IP do cliente para ver informações.

 Pedido de proxy
client.scheme String Só de leitura

Devolve HTTP ou HTTPS, consoante o transporte usado pela app cliente para enviar a mensagem de pedido.

 Pedido de proxy
client.sent.end.time String Só de leitura

A hora, expressa no formato de string, em que o proxy terminou de enviar a resposta do ProxyEndpoint para o cliente. Por exemplo: Wed, 21 Aug 2013 19:16:47 UTC.

Este valor é uma representação de string do client.sent.end.timestamp de 32 bits correspondente. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora 1377112607413.

 PostClientFlow
client.sent.end.timestamp Longo Só de leitura O valor da data/hora que especifica quando o ProxyEndpoint terminou de devolver a resposta à app cliente de origem. Este valor é um número inteiro de 64 bits (longo) que contém o número de milissegundos decorridos desde a meia-noite de 1 de janeiro de 1970 UTC. PostClientFlow
client.sent.start.time String Só de leitura A hora, expressa no formato de string, em que o ProxyEndpoint começou a devolver a resposta à app cliente de origem. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC.

Este valor é uma representação de string do client.sent.start.timestamp de 32 bits correspondente. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora 1377112607413.

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

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

 Pedido de proxy
client.state String Só de leitura

O estado no certificado TLS/SSL apresentado pelo cliente.

 Pedido de proxy

current

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

A tabela seguinte descreve as propriedades da variável current:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
current.flow.name String Só de leitura O nome do fluxo que está atualmente a ser executado (como PreFlow, PostFlow ou o nome de um fluxo condicional). Pedido de proxy
current.flow.description String Só de leitura A descrição do fluxo em execução atual. Este valor é igual ao valor do elemento <Description> na configuração XML do fluxo. Pedido de proxy

Pode ver estas propriedades na vista Trace da IU do Apigee.

environment

Um contentor para a propriedade environment.name.

A tabela seguinte descreve as propriedades da variável environment:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
environment.name String Só de leitura Nome do ambiente no qual a transação foi executada. Pedido de proxy

error

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

A tabela seguinte descreve as propriedades da variável error:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
error message Leitura/escrita Erro do tipo message, que é um objeto contextual no fluxo de erros. Erro
error.content String Leitura/escrita Conteúdo do erro. Erro
error.message String Só de leitura

Mensagem associada a um erro, cujo valor só está disponível antes da execução do fluxo de erros.

 Erro
error.status.code Número inteiro Só de leitura

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

 Erro
error.transport.message TransportMessage Só de leitura

Qualquer erro do tipo TransportMessage.

 Erro
error.state Número inteiro Só de leitura

Indique no Flow onde ocorreu um erro.

 Erro
error.header.header_name String Leitura/escrita

Obtenha ou defina o cabeçalho da resposta.

 Erro

fault

Fornece informações sobre a origem, o motivo e os detalhes de um erro de tempo de execução. O Apigee define estas variáveis quando uma política gera um erro, e os valores são específicos de cada política. Para compreender quando as variáveis fault são definidas, consulte Acerca dos erros de políticas.

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
fault.name String Só de leitura O nome da falha, conforme descrito na tabela Erros de tempo de execução incluída em cada tópico de referência de políticas. Esta variável pode ser útil em condições aplicadas a FaultRules. Erro
fault.reason String Só de leitura O motivo da falha. Por exemplo, quando a política OASValidation deteta que um pedido de entrada não é validado de acordo com a especificação OpenAPI, define esta variável como uma string que descreve o nome da política, o nome da especificação e o detalhe que descreve o motivo pelo qual o pedido não é validado de acordo com a especificação. Outras políticas definem esta variável para mensagens adequadas às respetivas falhas. Erro
fault.category String Só de leitura A categoria. Por exemplo, se a falha ocorrer num passo da política, esta variável pode conter o valor "Passo". Esta variável pode ser útil em condições aplicadas a FaultRules. Erro
fault.subcategory String Só de leitura A subcategoria. Por exemplo, se a política OASValidation detetar que um pedido não é validado em relação a uma especificação OpenAPI, define esta variável como "OASValidationFailure". Esta variável pode ser útil em condições aplicadas a FaultRules. Erro

graphql

Dá-lhe acesso aos resultados de uma consulta GraphQL em tempo de execução. Para mais informações, consulte a política de GraphQL.

A tabela seguinte descreve as propriedades da variável graphql:

Propriedade Tipo Leitura/escrita Descrição
graphql Tipo complexo SÓ DE LEITURA/LEITURA E ESCRITA A consulta GraphQL raiz. ÂMBITO
graphql.fragment Tipo complexo SÓ DE LEITURA/LEITURA E ESCRITA Uma referência ao fragmento predefinido para esta consulta. ÂMBITO
graphql.fragment.count Número inteiro Só de leitura O número de fragmentos gerados por esta consulta GraphQL. ÂMBITO
graphql.fragment.INDEX.selectionSet.INDEX TIPO SÓ DE LEITURA/LEITURA E ESCRITA Uma referência à seleção definida no índice especificado. ÂMBITO
graphql.fragment.INDEX.selectionSet.INDEX.name String SÓ DE LEITURA/LEITURA E ESCRITA O nome do conjunto de seleções no índice especificado. ÂMBITO
graphql.fragment.INDEX.selectionSet.count Número inteiro Só de leitura O número de conjuntos de seleções neste fragmento. ÂMBITO
graphql.fragment.INDEX.selectionSet.name String SÓ DE LEITURA/LEITURA E ESCRITA O nome da seleção predefinida definida no fragmento. ÂMBITO
graphql.operation Tipo complexo SÓ DE LEITURA/LEITURA E ESCRITA Uma referência à operação predefinida da consulta.

Não pode definir quotas ao nível da operação. Em alternativa, defina-os ao nível do ambiente.

 ÂMBITO
graphql.operation.name String Só de leitura O nome da operação predefinida da consulta. ÂMBITO
graphql.operation.operationType Enumeração Só de leitura O tipo de operação predefinida da consulta que pode ser executada contra este proxy de API. Os valores possíveis são query, mutation ou all. ÂMBITO
graphql.operation.selectionSet Tipo de complexo A seleção predefinida definida para a operação predefinida da consulta. ÂMBITO
graphql.operation.selectionSet.count Número inteiro Só de leitura O número de conjuntos de seleção na operação predefinida da consulta. ÂMBITO
graphql.operation.selectionSet.name String Só de leitura O nome do conjunto de seleção predefinido da operação predefinida da consulta. ÂMBITO
graphql.operation.selectionSet.INDEX Número inteiro Só de leitura Uma referência ao conjunto de seleções definido no índice especificado na lista de conjuntos de seleções. ÂMBITO
graphql.operation.selectionSet.INDEX.name String Só de leitura O nome da seleção no índice especificado na lista de conjuntos de seleções para esta operação. ÂMBITO
graphql.operation.selectionSet.INDEX.[selectionSet] Tipo complexo SÓ DE LEITURA/LEITURA E ESCRITA Um ou mais objetos de conjunto de seleção adicionais.

Pode aceder aos conjuntos de seleção de forma recursiva. Por exemplo, após uma selectionSet.index, pode ter outra selectionSet.index em vez de uma propriedade do name. Depois disso, são adicionados mais elementos até atingir o valor de <MaxCount> que definiu na política GraphQL.

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

is

Um contentor para a propriedade is.error.

A tabela seguinte descreve as propriedades da variável is:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
is.error Booleano Só de leitura

Sinalizador de erro.

 Pedido de proxy

loadbalancing

Fornece informações sobre o estado do equilíbrio de carga do TargetEndpoint.

A tabela seguinte descreve as propriedades da variável loadbalancing:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
loadbalancing.failedservers Matriz de strings Só de leitura

Lista de servidores de destino com falhas durante o equilíbrio de carga no TargetEndpoint.

 Resposta-alvo
loadbalancing.isfallback Booleano Só de leitura

true se o fallback estiver ativado para o TargetServer invocado durante o equilíbrio de carga em TargetEndpoint.

 Resposta-alvo
loadbalancing.targetserver String Só de leitura

TargetServer invocado durante o equilíbrio de carga no TargetEndpoint. Defina apenas se o elemento <Path> for definido ao definir o elemento do balanceador de carga.

 Resposta-alvo

message

Um objeto contextual, com o mesmo valor que request no fluxo de pedido ou como response no fluxo de resposta ou como error no fluxo de erros.

A tabela seguinte descreve as propriedades da variável message:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
message message Leitura/escrita

Um objeto contextual com o mesmo valor que request no fluxo de pedido ou que response no fluxo de resposta ou que error no fluxo de erro.

 Pedido de proxy
message.content String Leitura/escrita

Conteúdo do pedido, da resposta ou da mensagem de erro.

 Pedido de proxy
message.content.as.base64 String Só de leitura

Conteúdo do payload codificado em Base64 da mensagem de pedido, resposta ou erro.

 Pedido de proxy
message.content.as.url.safe.base64 String Só de leitura

Conteúdo do payload codificado em base64 seguro para URLs da solicitação, da resposta ou da mensagem de erro.

 Pedido de proxy
message.formparam.param_name String Leitura/escrita

Valor do parâmetro de formulário especificado.

 Pedido de proxy
message.formparam.param_name.
 values		 Coleção Só de leitura

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

 Pedido de proxy
message.formparam.param_name.
 values.count		 Número inteiro Só de leitura

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

 Pedido de proxy
message.formparams.count Número inteiro Só de leitura

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

 Pedido de proxy
message.formparams.names Coleção Só de leitura

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

 Pedido de proxy
message.formparams.names.string String Só de leitura

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

 Pedido de proxy
message.formstring String Só de leitura

Valor da string do formulário na mensagem.

 Pedido de proxy
message.header.header_name String Leitura/escrita

Obtém ou define o valor de um cabeçalho específico encontrado no pedido. Se o cabeçalho contiver uma vírgula, quando o ler, recebe apenas o segmento de texto até à primeira vírgula.

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

Se quiser o cabeçalho completo como uma string, use uma variável como message.header.header_name.values.string.

 Pedido de proxy
message.header.header_name.N String Leitura/escrita

O valor do Nth valor do cabeçalho específico na mensagem, seja pedido ou resposta, consoante o estado do fluxo. O 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 é maxage=16544.

 Pedido de proxy
message.header.header_name.
 values		 Coleção Só de leitura

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

 Pedido de proxy
message.header.header_name.
 values.count		 Número inteiro Só de leitura

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

 Pedido de proxy
message.header.header_name.
 values.string		 String Só de leitura

Todos os valores de um cabeçalho específico na mensagem, sob a 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 é public,maxage=16544.

 Pedido de proxy
message.headers.count Número inteiro Só de leitura

Contagem de todos os cabeçalhos HTTP na mensagem.

 Pedido de proxy
message.headers.names Coleção Só de leitura

Valor de todos os cabeçalhos HTTP na mensagem.

 Pedido de proxy
message.headers.names.string String Só de leitura

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

 Pedido de proxy
message.path String Leitura/escrita

O caminho completo da mensagem de pedido no URL, excluindo quaisquer parâmetros de consulta.

Pedido de proxy
message.queryparam.param_name String Só de leitura

Devolve o parâmetro de consulta de mensagem especificado.

 Pedido de proxy
message.queryparam.param_name.N String Leitura/escrita

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

Como exemplo de escrita de vários valores para um único nome de parâmetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, defina o seguinte:

  • message.queryparam.type.1 a siteid:1
  • message.queryparam.type.2 a language:en-us
  • message.queryparam.type.3 a currency:USD
 Pedido de proxy
message.queryparam.param_name.
 values		 Coleção Só de leitura

Todos os valores de um determinado parâmetro de consulta 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 é ['hello', 'world']code>.

 Pedido de proxy
message.queryparam.param_name.
 values.count		 Número inteiro Só de leitura

A contagem total de um parâmetro de consulta especificado associado ao pedido enviado para o ProxyEndpoint a partir da app cliente.

 Pedido de proxy
message.queryparams.count Número inteiro Só de leitura

A contagem total de todos os parâmetros de consulta associados ao pedido enviado para o ProxyEndpoint a partir da app cliente.

 Pedido de proxy
message.queryparams.names Coleção Só de leitura

Uma lista de todos os nomes de parâmetros de consulta associados ao pedido enviado para o ProxyEndpoint a partir da app cliente.

 Pedido de proxy
message.queryparams.names.string String Só de leitura

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

 Pedido de proxy
message.querystring String Só de leitura

Uma string que contém todos os nomes e valores dos parâmetros de consulta associados ao pedido enviado para o ProxyEndpoint a partir da app cliente.

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

 Pedido de proxy
message.status.code Número inteiro Só de leitura

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

 Resposta-alvo
message.transport.message TransportMessage Só de leitura

Mensagem do tipo TransportMessage, que é um objeto contextual.

 Pedido de proxy
message.uri String Só de leitura

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

Por exemplo, para o pedido http://api.apifactory.com/inventors?name=nikola&surname=tesla, esta variável devolve inventors?name=nikola&surname=tesla.

 Pedido de proxy
message.verb String Só de leitura

O verbo HTTP (GET, PUT, POST, DELETE, etc.) associado ao pedido.

 Pedido de proxy
message.version String Leitura/escrita

A versão HTTP associada ao pedido enviado para o ProxyEndpoint a partir da aplicação cliente.

 Pedido de proxy

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

messageid

Um contentor para o ID globalmente exclusivo do pedido.

A tabela seguinte descreve as propriedades da variável messageid:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
messageid String Só de leitura

Contém o ID globalmente exclusivo do pedido, que inclui o nome do anfitrião do equilibrador de carga. Este ID permite que os pedidos recebidos no equilibrador de carga sejam monitorizados depois de serem enviados para o processador de mensagens.

Este ID é registado nos registos de erros do Apigee para correlacionar o messageid com os erros.

 Pedido de proxy

mint

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

A tabela seguinte descreve as propriedades da variável mint:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
mint.limitscheck.is_request_blocked Booleano Só de leitura

Sinalização que especifica se o pedido da API está bloqueado. Definido como true se is_subscription_found for false.

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.limitscheck.is_subscription_found Booleano Só de leitura

Flag que especifica se o programador tem uma subscrição ativa do produto API. Definido como true se um programador tiver uma subscrição.

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.limitscheck.prepaid_developer_balance Numérico Só de leitura

Saldo atual na carteira da conta pré-paga do programador associada à moeda do plano tarifário.

 Pedido de proxy
mint.limitscheck.prepaid_developer_currency String Só de leitura

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

 Pedido de proxy
mint.limitscheck.purchased_product_name String Só de leitura

Nome do produto API associado.

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.limitscheck.status_message String Só de leitura

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

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.mintng_consumption_pricing_rates String Só de leitura

Taxas baseadas no consumo.

Defina as taxas quando criar um plano tarifário.

 PostClientFlow
mint.mintng_consumption_pricing_type String Só de leitura

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

Defina as taxas baseadas no consumo quando criar um plano tarifário.

 PostClientFlow
mint.mintng_currency String Só de leitura

Moeda para calcular a receita.

Esta variável de fluxo tem o valor da currency variável de rentabilização.

 Política de Captura de Dados
mint.mintng_dev_share Numérico Só de leitura

Receita a partilhar com o programador.

Defina a receita a partilhar com o programador quando criar um plano tarifário.

 PostClientFlow
mint.mintng_is_apiproduct_monetized Booleano Só de leitura

Sinalização que especifica se o produto API está atualmente rentabilizado (ou seja, se existe um plano tarifário ativo em vigor).

Esta variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy de API. Consulte o artigo Adicionar uma política de autenticação.

 Pedido de proxy
mint.mintng_price Numérico Só de leitura

Receita para calcular a quota do programador.

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

 Política de captura de dados e PostClientFlow
mint.mintng_price_multiplier Numérico Só de leitura

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

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

 Política de captura de dados e PostClientFlow
mint.mintng_rate Numérico Só de leitura

Tarifa cobrada pela chamada API.

Esta variável de fluxo mostra a taxa baseada no consumo por chamada API. Defina a taxa baseada no consumo quando criar um plano tarifário. Se configurou a perUnitPriceMultiplier variável de rentabilização na sua política de captura de dados, o Apigee calcula 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 Só de leitura

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

Se a política de captura de dados capturar a perUnitPriceMultiplier variável de rentabilização, esta variável de fluxo mostra o custo da transação antes de multiplicar o custo por perUnitPriceMultiplier.

 PostClientFlow
mint.mintng_rate_plan_id String Só de leitura

ID do plano tarifário.

Esta variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy de API. Consulte o artigo Adicionar uma política de autenticação.

 Pedido de proxy
mint.mintng_revenue_share_rates String Só de leitura

Taxas de partilha de receita.

Defina a taxa de partilha de receita quando criar um plano tarifário.

 PostClientFlow
mint.mintng_revenue_share_type String Só de leitura

Tipo de partilha de receita. Por exemplo: FIXED

Defina o tipo de partilha de receita quando criar um plano tarifário.

 PostClientFlow
mint.mintng_tx_success Booleano Só de leitura

Especifica se a transação é rentabilizada.

Esta variável de fluxo tem o valor da transactionSuccess variável de rentabilização.

 Política de Captura de Dados
mint.prepaid_updated_developer_usage Numérico Só de leitura

Utilização atual do crédito de programador pré-pago.

A utilização é calculada com base na configuração do seu plano tarifário e no valor da variável de rentabilização perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Numérico Só de leitura

Hora de expiração do plano tarifário em milissegundos desde a época.

Esta variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy de API. Consulte o artigo Adicionar uma política de autenticação.

 Pedido de proxy
mint.rateplan_start_time_ms Numérico Só de leitura

Hora de ativação do plano tarifário em milissegundos desde a época.

Esta variável de fluxo é adicionada pela política VerifyAPIKey ou VerifyAccessToken anexada ao proxy de API. Consulte o artigo Adicionar uma política de autenticação.

 Pedido de proxy
mint.status String Só de leitura

Estado da chamada rentabilizada. Preenchido apenas em caso de erro.

 PostClientFlow
mint.status_code Numérico Só de leitura

Código de estado HTTP da chamada rentabilizada. Preenchido apenas em caso de erro.

 PostClientFlow
mint.subscription_end_time_ms Numérico Só de leitura

Hora de expiração da subscrição do produto API em milissegundos desde epoch.

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.subscription_start_time_ms Numérico Só de leitura

Hora de ativação da subscrição do produto API em milissegundos desde a época.

Esta variável de fluxo está disponível se a política MonetizationLimitsCheck estiver anexada ao proxy da API. Consulte as variáveis do fluxo MonetizationLimitsChecks.

 Pedido de proxy
mint.tx_success_result Booleano Só de leitura

Indica se a rentabilização é bem-sucedida para a transação.

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

  • tx_success definido como verdadeiro: a variável transactionSuccess é true e a transação é rentabilizada. Uma vez que a transação é rentabilizada, os valores das variáveis mint.mintng_rate e mint.mintng_dev_share são calculados.
  • tx_success definido como falso: a variável transactionSuccess é false e a transação não é rentabilizada. Uma vez que a transação não é rentabilizada, os valores das variáveis mint.mintng_rate e mint.mintng_dev_share não são calculados.
  • tx_success não encontrado. O código de estado da mensagem não era 2xx: a variável transactionSuccess não é capturada e o código de estado HTTP (message.status.code) da transação não é 2xx. A transação não é rentabilizada.
  • tx_success não encontrado. O código de estado da mensagem era 2xx: a variável transactionSuccess não é capturada e o código de estado HTTP (message.status.code) da transação é 2xx. A transação está rentabilizada.
 PostClientFlow

Para mais informações, consulte o seguinte:

organization

Um contentor para a propriedade organization.name.

A tabela seguinte descreve as propriedades da variável organization:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
organization.name String Só de leitura

Nome da organização.

 Pedido de proxy

Para mais informações sobre organizações, consulte o artigo Compreender as organizações.

proxy

A configuração do proxy de API.

A tabela seguinte descreve as propriedades da variável proxy:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
proxy.basepath String Só de leitura

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

Suponhamos que tem um ponto final do proxy da API configurado com um caminho base de /v2/weatherapi. (Consulte a configuração do ponto final do proxy para ver mais detalhes.) Nesse caso, se o pedido de entrada usar o URL https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, então:

  • O nome do anfitrião é myhost.example.net. Pode obter este valor lendo a variável request.header.host.
  • O caminho base é /v2/weatherapi. Recupere esta informação lendo a variável proxy.basepath.
  • O sufixo do caminho é /forecastrss. Recupere esta informação lendo a variável proxy.pathsuffix.

Se definir um caminho base dinâmico na configuração do proxy de API, como /v2/*/weatherapicode>, a variável proxy.basepath é definida como o caminho dinâmico. Para obter o URL real do pedido, leia e analise a variável proxy.url.

 Pedido de proxy
proxy.client.ip String Só de leitura

O endereço X-Forwarded-For da chamada recebida, que é o endereço IP que o Apigee recebeu do último handshake TCP externo. Pode ser o cliente de chamadas ou um equilibrador de carga.

 Pedido de proxy
proxy.name String Só de leitura

O atributo name configurado para o ProxyEndpoint.

 Pedido de proxy
proxy.pathsuffix String Só de leitura

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

O caminho base é o componente do caminho mais à esquerda que identifica exclusivamente um proxy de API num grupo de ambientes. Suponhamos que tem um ponto final do proxy da API configurado com um caminho base de /v2/weatherapi. Nesse caso, um pedido enviado para https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, a variável proxy.pathsuffix vai conter a string /forecastrss.

 Pedido de proxy
proxy.url String Só de leitura

Obtém o URL completo associado ao pedido de proxy recebido pelo ProxyEndpoint, incluindo quaisquer parâmetros de consulta presentes.

 Pedido de proxy

Para mais informações sobre como trabalhar com proxies de API, consulte o artigo Compreender as APIs e os proxies de API.

publishmessage

Preenchido quando uma política PublishMessage é executada.

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
publishmessage.message.id String Só de leitura Devolve o messageId (ID da mensagem publicada) do servidor do Pub/Sub.

O Apigee define esta variável de fluxo apenas se o pedido de publicação for bem-sucedido.

 Pedido de proxy

ratelimit

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

A tabela seguinte descreve as propriedades da variável ratelimit:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
ratelimit.policy_name.allowed.count Longo Só de leitura Devolve a contagem da quota permitida. PostClientFlow
ratelimit.policy_name.used.count Longo Só de leitura Devolve a quota atual usada num intervalo de quota. PostClientFlow
ratelimit.policy_name.available.count Longo Só de leitura Devolve a contagem de quota disponível no intervalo de quota. PostClientFlow
ratelimit.policy_name.exceed.count Longo Só de leitura Devolve 1 após a quota ser excedida. PostClientFlow
ratelimit.policy_name.total.exceed.count Longo Só de leitura Devolve 1 após a quota ser excedida. PostClientFlow
ratelimit.policy_name.expiry.time Longo Só de leitura

Devolve a hora UTC (em milissegundos), que determina quando a quota expira e quando o novo intervalo de quota começa.

Quando o tipo da política de quota é rollingwindow, este valor não é válido, uma vez que o intervalo de quota nunca expira.

 PostClientFlow
ratelimit.policy_name.identifier String Só de leitura Devolve a referência do identificador (cliente) anexada à política PostClientFlow
ratelimit.policy_name.class String Só de leitura Devolve a classe associada ao identificador do cliente PostClientFlow
ratelimit.policy_name.class.allowed.count Longo Só de leitura Devolve a contagem da quota permitida definida na classe PostClientFlow
ratelimit.policy_name.class.used.count Longo Só de leitura Devolve a quota usada numa classe PostClientFlow
ratelimit.policy_name.class.available.count Longo Só de leitura Devolve a contagem de quota disponível na classe PostClientFlow
ratelimit.policy_name.class.exceed.count Longo Só de leitura Devolve a contagem de pedidos que excede o limite na classe no intervalo de quota atual PostClientFlow
ratelimit.policy_name.class.total.exceed.count Longo Só de leitura Devolve a contagem total de pedidos que excede o limite na classe em todos os intervalos de quotas, pelo que é a soma de class.exceed.count para todos os intervalos de quotas. PostClientFlow
ratelimit.policy_name.failed Booleano Só de leitura

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

 PostClientFlow

Para mais informações, consulte o seguinte:

request

O pedido completo, incluindo qualquer payload presente.

Para mais informações acerca dos dados de pedidos, consulte o artigo Como são transmitidos os dados de pedidos para o servidor de back-end?

A tabela seguinte descreve as propriedades da variável request:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
request message Só de leitura

O pedido completo, incluindo qualquer payload presente.

 Pedido de proxy
request.content String Leitura/escrita

Obtém ou define a carga útil da mensagem de pedido.

 Pedido de proxy
request.content.as.base64 String Só de leitura

Conteúdo do payload codificado em Base64 da mensagem de pedido.

 Pedido de proxy
request.content.as.url.safe.base64 String Só de leitura

Conteúdo do payload codificado em base64 seguro para URL da mensagem de pedido.

 Pedido de proxy
request.formparam.param_name String Leitura/escrita

Obtém ou define o valor do parâmetro de formulário especificado no pedido enviado a partir da aplicação cliente.

 Pedido de proxy
request.formparam.param_name.
 values		 Coleção Só de leitura

Todos os valores de um parâmetro de formulário específico no pedido, formatados como uma lista separada por vírgulas.

Por exemplo, se a carga útil for a=hello&x=greeting&a=world, o valor de request.formparam.a.values é ['hello', 'world'].

 Pedido de proxy
request.formparam.param_name.
 values.count		 Número inteiro Só de leitura

A contagem de todos os valores do parâmetro de formulário especificado associado ao pedido.

 Pedido de proxy
request.formparam.param_name.N String Leitura/escrita

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

 Pedido de proxy
request.formparams.count Número inteiro Só de leitura

A contagem de todos os parâmetros associados ao pedido enviado a partir da aplicação cliente.

 Pedido de proxy
request.formparams.names Coleção Só de leitura

Uma lista de todos os nomes de parâmetros associados ao pedido.

 Pedido de proxy
request.formparams.names.string String Só de leitura

Uma lista separada por vírgulas de todos os nomes de parâmetros de formulário associados ao pedido.

 Pedido de proxy
request.formstring String Só de leitura

O formparam completo no pedido enviado a partir da app cliente.

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

 Pedido de proxy
request.grpc.rpc.name String Só de leitura

Aplicável apenas quando usar um servidor de destino gRPC. O nome do RPC. Para ver informações sobre proxies gRPC, consulte o artigo Criar proxies de API gRPC.

Pedido de proxy
request.grpc.service.name String Só de leitura

Aplicável apenas quando usar um servidor de destino gRPC. O nome do serviço de estado gRPC. Para ver informações sobre proxies gRPC, consulte o artigo Criar proxies de API gRPC.

Pedido de proxy
request.header.header_name String Leitura/escrita

Obtém ou define o valor de um cabeçalho específico encontrado no pedido. Se o cabeçalho contiver uma vírgula, quando o ler, recebe apenas o segmento de texto até à primeira vírgula.

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

Se quiser o cabeçalho completo como uma string, use uma variável como request.header.header_name.values.string.

 Pedido de proxy
request.header.header_name.N String Leitura/escrita

O valor do Nésimo valor do cabeçalho específico no pedido. O 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 request.header.cache-control.2 é maxage=16544.

 Pedido de proxy
request.header.header_name.
 values		 Coleção Só de leitura

Todos os valores de um cabeçalho específico no pedido.

 Pedido de proxy
request.header.header_name.
 values.count		 Número inteiro Só de leitura

Contagem de todos os valores de um cabeçalho específico no pedido.

 Pedido de proxy
request.header.header_name.
 values.string		 String Só de leitura

Todos os valores de um cabeçalho específico no pedido, sob a 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 é public, maxage=16544.

 Pedido de proxy
request.headers.count Número inteiro Só de leitura

Contagem de todos os cabeçalhos no pedido.

 Pedido de proxy
request.headers.names Coleção Só de leitura

Nomes de todos os cabeçalhos no pedido.

 Pedido de proxy
request.headers.names.string String Só de leitura

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

 Pedido de proxy
request.path String Só de leitura

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

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

 Pedido de proxy
request.queryparam.param_name String Leitura/escrita

O valor de um parâmetro de consulta específico encontrado no pedido.

 Pedido de proxy
request.queryparam.param_name.N String Leitura/escrita

O valor do parâmetro de consulta Nth no pedido.

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

Como exemplo de escrita de vários valores para um único nome de parâmetro de consulta, como type=siteid:1&type=language:us-en&type=currency:USD, defina o seguinte:

  • request.queryparam.type.1 a siteid:1
  • request.queryparam.type.2 a language:en-us
  • request.queryparam.type.3 a currency:USD
 Pedido de proxy
request.queryparam.param_name.
 values		 Coleção Só de leitura

Todos os valores de um determinado parâmetro de consulta no pedido, 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 é ['hello', 'world'].

 Pedido de proxy
request.queryparam.param_name.
 values.count		 Número inteiro Só de leitura

A contagem de todos os valores de um parâmetro de consulta específico no pedido.

 Pedido de proxy
request.queryparams.count Número inteiro Só de leitura

A contagem de todos os parâmetros de consulta no pedido.

 Pedido de proxy
request.queryparams.names Coleção Só de leitura

Os nomes de todos os parâmetros de consulta no pedido.

 Pedido de proxy
request.queryparams.names.string String Só de leitura

Uma lista separada por vírgulas dos nomes de todos os parâmetros de consulta no pedido.

 Pedido de proxy
request.querystring String Só de leitura

A lista completa de parâmetros de consulta no pedido enviado a partir da app cliente.

Por exemplo, se o pedido for http://host.com/123?name=first&surname=second&place=address, esta variável devolve name=first&surname=second&place=address.

 Pedido de proxy
request.transportid String Só de leitura

ID do pedido como tipo TransportMessage, que é contextual.

 Pedido de proxy
request.transport.message Transport-Message Só de leitura

Pedido do tipo TransportMessage que é contextual.

 Pedido de proxy
request.uri String Só de leitura

Num proxy de API, o caminho <BasePath> no ProxyEndpoint (além do URL base do proxy) é mapeado para o URL do serviço de destino no TargetEndpoint. Por exemplo:

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

Direciona para

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

No pedido, request.uri é o caminho base do proxy + o resto do endereço, incluindo os parâmetros de consulta.

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

A diferença deve-se ao facto de o pedido original ter sido recebido pelo proxy, mas, em seguida, o proxy ter feito outro pedido ao serviço de destino.

Suponhamos que a seguinte chamada é feita ao nosso proxy de exemplo, que tem um caminho base de /my-mock-proxy:

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

E as chamadas de proxy:

http://mocktarget.apigee.net

Que anexa /user?user=Dude a esse URL.

  • Pedido: request.uri = /my-mock-proxy/user?user=Dude
  • Resposta: request.uri = /user?user=Dude
 Pedido de proxy (difere na resposta)
request.url String Só de leitura

O URL completo do pedido feito ao ponto final de destino, incluindo os parâmetros da string de consulta, mas não incluindo o número da porta (se especificado).

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

  • Pedido: n/a
  • Resposta: http://example.com/user?user=Dude
 Resposta-alvo
request.verb String Só de leitura

O verbo HTTP usado para o pedido. Por exemplo, GET, PUT e DELETE.

 Pedido de proxy
request.version String Só de leitura

A versão HTTP do pedido. Por exemplo, 1.1.

 Pedido de proxy

response

A resposta completa, incluindo qualquer payload presente.

A tabela seguinte descreve as propriedades da variável response:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
response message Leitura/escrita

Mensagem de resposta completa devolvida pelo destino.

 Resposta-alvo
response.content String Leitura/escrita

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

 Resposta-alvo
response.content.as.base64 String Só de leitura

Conteúdo do payload codificado em Base64 da mensagem de resposta.

 Resposta-alvo
response.content.as.url.safe.base64 String Só de leitura

Conteúdo útil codificado em base64 seguro para URL da mensagem de resposta.

 Resposta-alvo
response.event.current.content String Leitura/escrita

O conteúdo devolvido numa resposta de streaming EventFlow. Consulte o artigo Streaming de eventos enviados pelo servidor para mais informações.

 Resposta do EventFlow
response.event.current.count Número inteiro Leitura

Conta incrementalmente o número de eventos de resposta enviados. Este valor é atualizado para cada evento recebido. Consulte o artigo Streaming de eventos enviados pelo servidor para mais informações.

. 		Resposta do EventFlow
response.header.header_name String Leitura/escrita

Obtém ou define o valor de um cabeçalho HTTP especificado na resposta.

Se o texto do cabeçalho incluir uma vírgula, o Apigee infere vários valores. Neste caso, response.header.header_name devolve apenas o primeiro valor.

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

Se quiser o cabeçalho completo como uma string, use uma variável como response.header.header_name.values.string.

 Resposta-alvo
response.header.header_name.
 values		 Coleção Só de leitura

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

 Resposta-alvo
response.header.header_name.
 values.count		 Número inteiro Só de leitura

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

 Resposta-alvo
response.header.header_name.
 values.string		 String Só de leitura

Todos os valores de um cabeçalho específico na resposta, no formato 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 é public,maxage=16544.

 Resposta-alvo
response.header.header_name.N String Leitura/escrita

O valor do Nésimo valor do cabeçalho específico na resposta. O 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, response.header.cache-control.2 devolve maxage=16544.

 Resposta-alvo
response.headers.count Número inteiro Só de leitura

Contagem de todos os cabeçalhos na resposta.

 Resposta-alvo
response.headers.names Coleção Só de leitura

Os nomes de todos os cabeçalhos na resposta.

 Resposta-alvo
response.headers.names.string String Só de leitura

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

 Resposta-alvo
response.status.code Número inteiro Leitura/escrita

O código de resposta devolvido para um pedido. Pode usar esta variável para substituir o código de estado da resposta, que está armazenado em message.status.code. Para mais informações, consulte message.

 Resposta-alvo
response.transport.message String Só de leitura

Resposta do tipo TransportMessage, que é um objeto contextual.

 Resposta-alvo

route

Especifica os nomes do <RouteRule> e do TargetEndpoint.

A tabela seguinte descreve as propriedades da variável route:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
route.name String Só de leitura

O nome do <RouteRule> que foi executado no ProxyEndpoint. Por exemplo, default. Uma RouteRule faz referência a um TargetEndpoint do proxy de API para execução.

 Pedido de segmentação
route.target String Só de leitura

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

 Pedido de segmentação

servicecallout

Descreve o TargetEndpoint de uma política ServiceCallout.

A tabela seguinte descreve as propriedades da variável servicecallout:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
servicecallout.policy_name.expectedcn String Leitura/escrita

O nome comum esperado do TargetEndpoint, conforme referido numa política ServiceCallout. Isto só é significativo quando o TargetEndpoint se refere a um ponto final TLS/SSL.

 Pedido de proxy
servicecallout.policy_name.target.url String Leitura/escrita

O URL TargetEndpoint para uma determinada política ServiceCallout.

 Pedido de proxy
servicecallout.requesturi String Leitura/escrita

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

 Pedido de proxy

system

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

A tabela seguinte descreve as propriedades da variável system:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
system.interface.interface_name String Só de leitura

Endereço IP do sistema.

 Pedido de proxy
system.pod.name String Só de leitura

O nome do pod onde o proxy está em execução.

 Pedido de proxy
system.region.name String Só de leitura

O nome da região do data center onde o proxy está a ser executado.

 Pedido de proxy
system.time String Só de leitura

A hora em que esta variável foi lida. Por exemplo, Wed, 21 Aug 2013 19:16:47 GMT.

Este valor é a representação de string do valor correspondente de system.timestamp. Por exemplo, Wed, 21 Aug 2013 19:16:47 GMT corresponde ao valor de data/hora 1377112607413.

 Pedido de proxy
system.time.year Número inteiro Só de leitura

A parte do ano de system.time.

 Pedido de proxy
system.time.month Número inteiro Só de leitura

A parte do mês de system.time.

 Pedido de proxy
system.time.day Número inteiro Só de leitura

A parte do dia do mês de system.time.

 Pedido de proxy
system.time.dayofweek Número inteiro Só de leitura

A parte do dia da semana de system.time.

 Pedido de proxy
system.time.hour Número inteiro Só de leitura

A parte da hora de system.time.

 Pedido de proxy
system.time.minute Número inteiro Só de leitura

A parte dos minutos de system.time.

 Pedido de proxy
system.time.second Número inteiro Só de leitura

A segunda parte de system.time.

 Pedido de proxy
system.time.millisecond Número inteiro Só de leitura

A parte dos milissegundos de system.time.

 Pedido de proxy
system.time.zone String Só de leitura

Fuso horário do sistema.

 Pedido de proxy
system.timestamp Longo Só de leitura

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

 Pedido de proxy
system.uuid String Só de leitura

O UUID do processador de mensagens que processa o proxy.

 Pedido de proxy

target

Descreve o destino do pedido.

A tabela seguinte descreve as propriedades da variável target:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
target.basepath String Só de leitura

O caminho do recurso (não incluindo o domínio) para o serviço de destino, excluindo os parâmetros de consulta, que está definido no TargetEndpoint do proxy.

Por exemplo, suponhamos que um proxy de API chama o seguinte destino:

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

Neste exemplo, o target.basepath é /user.

Se o alvo fosse este:

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

O valor de target.basepath seria nulo.

 Pedido de segmentação
target.copy.pathsuffix Booleano Leitura/escrita

Quando true, o pedido encaminhado do ProxyEndpoint para o TargetEndpoint retém o sufixo do caminho (o fragmento do caminho do URI após o URI definido no caminho base do ProxyEndpoint).

 Pedido de segmentação
target.copy.queryparams Booleano Leitura/escrita

Quando true, o pedido encaminhado do ProxyEndpoint para o TargetEndpoint retém os parâmetros de consulta.

 Pedido de segmentação
target.country String Só de leitura

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

 Resposta-alvo
target.cn String Só de leitura

O nome comum do TargetEndpoint. Isto só é significativo quando o TargetEndpoint se refere a um ponto final TLS/SSL.

 Pedido de segmentação
target.email.address String Só de leitura

Endereço de email do certificado TLS/SSL apresentado pelo servidor de destino

 Resposta-alvo
target.expectedcn String Leitura/escrita

O nome comum esperado do TargetEndpoint. Isto só é significativo quando o TargetEndpoint se refere a um ponto final TLS/SSL.

 Pedido de proxy
target.header.host String Leitura/escrita

A variável de fluxo usada pelo Apigee para definir o valor do cabeçalho Host para o pedido de saída para o destino. Usado para definir o valor para um nome de anfitrião em situações em que é usado um endereço IP no URL de destino ou no servidor de destino, como seria o caso com um destino baseado no ponto final do PSC.

 Pedido de segmentação
target.host String Só de leitura

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

 Resposta-alvo
target.ip String Só de leitura

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

 Resposta-alvo
target.locality String Só de leitura

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

 Resposta-alvo
target.name String Só de leitura

Alvo ao qual a mensagem está a chegar a partir de targetendpoint.

 Pedido de segmentação
target.organization String Só de leitura

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

 Resposta-alvo
target.organization.unit String Só de leitura

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

 Resposta-alvo
target.port Número inteiro Só de leitura

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

 Resposta-alvo
target.received.end.time String Só de leitura

A hora, expressa no formato de string, em que o TargetEndpoint terminou de receber a resposta do destino. Por exemplo, qua., 21 de agosto de 2013, 19:16:47 UTC.

Este valor temporal é a representação de string da quantidade de data/hora correspondente de 32 bits. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Resposta-alvo
target.received.end.
  timestamp		 Longo Só de leitura

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

 Resposta-alvo
target.received.start.time String Só de leitura

A hora, expressa no formato de string, à qual o TargetEndpoint começou a receber a resposta do destino. Por exemplo, qua., 21 de agosto de 2013, 19:16:47 UTC.

Este valor temporal é a representação de string da quantidade de data/hora correspondente de 32 bits. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Resposta-alvo
target.received.start.
  timestamp		 Longo Só de leitura

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

 Resposta-alvo
target.scheme String Só de leitura

Scope begins: Target response
Type: String
Permission: Read/Write

Devolve http ou https, consoante a mensagem de pedido.

 Pedido de segmentação
target.sent.end.time String Só de leitura

A hora, expressa no formato de string, em que o proxy deixou de enviar o pedido para o URL especificado no TargetEndpoint. Por exemplo, qua., 21 de agosto de 2013, 19:16:47 UTC.

Este valor temporal é a representação de string da quantidade de data/hora correspondente de 32 bits. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Pedido de segmentação
target.sent.end.timestamp Longo Só de leitura

O valor da data/hora que especifica quando o proxy terminou de enviar o pedido para o URL especificado no TargetEndpoint. Por exemplo, 1377112607413. Este valor é um número inteiro de 64 bits (longo) que contém o número de milissegundos decorridos desde a meia-noite de 1 de janeiro de 1970 UTC.

 Pedido de segmentação
target.sent.start.time String Só de leitura

A hora, expressa no formato de string, em que o proxy começou a enviar o pedido para o URL especificado no TargetEndpoint. Por exemplo, qua., 21 de agosto de 2013, 19:16:47 UTC.

Este valor temporal é a representação de string da quantidade de data/hora correspondente de 32 bits. Por exemplo, Wed, 21 Aug 2013 19:16:47 UTC corresponde ao valor da data/hora de 1377112607413.

 Pedido de segmentação
target.sent.start.timestamp Longo Só de leitura

O valor da data/hora que especifica quando o proxy começou a enviar o pedido para o URL especificado no TargetEndpoint. Por exemplo, 1534783015000. Este valor é um número inteiro de 64 bits (longo) que especifica o número de milissegundos decorridos desde a meia-noite de 1 de janeiro de 1970 UTC.

 Pedido de segmentação
target.ssl.enabled Booleano Só de leitura

Se o TargetEndpoint está a ser executado em TLS/SSL.

 Pedido de proxy
target.state String Só de leitura

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

 Resposta-alvo
target.url String Leitura/escrita

O URL configurado no ficheiro XML TargetEndpoint ou o URL de destino dinâmico (se target.url estiver definido durante o fluxo de mensagens). A variável não inclui elementos de caminho adicionais nem parâmetros de consulta. Devolve o valor nulo se for chamado fora do âmbito ou se não estiver definido.

 Pedido de segmentação

variable

Um contentor para a propriedade variable.expectedcn.

A tabela seguinte descreve as propriedades da variável variable:

Propriedade Tipo Leitura/escrita Descrição O âmbito começa
variable.expectedcn String Leitura/escrita

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

 Pedido de proxy

Para mais informações sobre como trabalhar com o TLS, consulte as Opções de configuração do TLS.