Referência de variáveis de fluxo

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

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

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

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

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

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

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

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

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 19:16:47 UTC" corresponde ao valor de carimbo de data/hora 1377112607413.

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.

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 19:16:47 UTC" corresponde ao valor de carimbo de data/hora 1377112607413.

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.

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

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".

Esse valor é uma representação de string do client.sent.end.timestamp de 32 bits correspondente. Por exemplo, "Qua, 21 Ago 2013 1916:47 UTC" corresponde ao valor do carimbo de data/hora de 1377112607413.

Esse valor é uma representação de string do client.sent.start.timestamp de 32 bits correspondente. Por exemplo, "Qua, 21 Ago 2013 1916:47 UTC" corresponde ao valor do carimbo de data/hora de 1377112607413.

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

O estado no certificado TLS/SSL apresentado pelo cliente.

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

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

A frase de motivo associada ao erro. Por exemplo: "Solicitação inválida".

Qualquer erro do tipo TransportMessage.

Estado no fluxo em que ocorreu um erro.

Recebe ou define o cabeçalho de resposta.

Sinalização de erro.

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

"true" se o fallback for ativado para o TargetServer invocado durante o balanceamento de carga em TargetEndpoint.

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.

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.

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

Valor do parâmetro de formulário especificado.

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

Contagem dos valores dos parâmetros de formulário especificados na mensagem./p>

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

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

Valor da string do formulário na mensagem.

Consegue ou define o valor do cabeçalho HTTP especificado na mensagem. Se o cabeçalho contiver uma vírgula, após a leitura, você receberá apenas o segmento do texto até a primeira vírgula. Se você quiser todo o cabeçalho, use o formato request.header.header_name.
 values

O valor do enésimo cabeçalho específico na mensagem, solicitação ou resposta, dependendo do estado do fluxo. O Apigee Edge divide os valores de texto do cabeçalho por vírgulas. Observe que o índice com o valor que é usado para N é baseado em 1, não em 0,

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

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

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

Contagem de todos os cabeçalhos HTTP na mensagem.

Valor de todos os cabeçalhos HTTP na mensagem

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

Retorna o parâmetro de consulta de mensagem especificado.

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".

Como 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", defina o seguinte:

• message.queryparam.type.1 para "siteid:1"
• message.queryparam.type.2 para "language:en-us"
• message.queryparam.type.3 para "currency:USD"

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']".

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

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

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

Para iterar sobre os nomes de parâmetro de consulta usando JavaScript, consulte a seguinte postagem da comunidade da Apigee: Como iterar a coleção de "request.queryparams.names" no JS? na comunidade Apigee.

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=nic&surname=danger".

ReasonPhrase da mensagem de resposta do destino.

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

Mensagem do tipo TransportMessage, que é um objeto contextual.

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".

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

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

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

Esse ID é registrado nos registros de erros do Edge para correlacionar os messageid com os erros.

Nome da organização.

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

No URL "http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282":

• O host é "myorg-test.apigee.net", que inclui o nome e o ambiente da organização
• O caminho base é "/v2/weatherapi"

A única maneira de saber isso é analisar a definição do proxy de API ou verificar o valor da variável proxy.basepath. O sufixo do caminho do proxy segue o caminho base ("/forecastrss"), junto com quaisquer parâmetros de consulta.

Se você definir um caminho base dinâmico na configuração do proxy da API, como "/v2/*/weatherapi", essa variável será definida como o caminho dinâmico ("/v2/*/weatherapi"), mesmo que o caminho base gere um valor estático, como "/v2/foo/weatherapi".

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

O atributo nome configurado para o ProxyEndpoint.

O valor do sufixo do caminho base do proxy de API que é enviado pelo cliente e recebido no ProxyEndpoint.

O caminho base é definido como o componente de caminho que identifica exclusivamente o proxy de API. O URL público de um proxy de API é composto pelo nome da organização, pelo ambiente em que o proxy é implantado, pelo caminho base, pelo sufixo do caminho base e por todos os parâmetros de consulta.

Por exemplo, em uma solicitação para http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282, o sufixo do caminho base é "/forecastrss".

Recebe o URL completo associado à solicitação de proxy recebida pelo ProxyEndpoint, incluindo todos os parâmetros de consulta presentes. O host do URL sempre será localhost. se o proxy for invocado com <LocalTargetConnection> para executar o encadeamento de proxy.

Para um exemplo que crie um URL request usando o host original, consulte Acessar mensagens de solicitação.

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

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

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

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']".

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

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

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

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

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

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

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.

Se você quiser todo o cabeçalho, use o formato request.header.header_name.values.

O valor do enésimo cabeçalho específico na solicitação. O Apigee Edge divide os valores de texto de cabeçalho por vírgulas. Observe que o índice com o valor que é usado para N é baseado em 1, não em 0.

Por exemplo, se o cabeçalho Cache-control for "public, maxage16544", o valor de retorno de request.header.cache-control.1 será "maxage16544".

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

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

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

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

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, do URI para o serviço de back-end é "https://example.com/rest/api/latest", o valor de request.path é "/rest/api/latest".

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

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".

Como 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", defina o seguinte:

• request.queryparam.type.1 para "siteid:1"
• request.queryparam.type.2 para "language:en-us"
• request.queryparam.type.3 para "currency:USD"

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']".

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

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

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

Para iterar os nomes dos parâmetros de consulta usando JavaScript, consulte Como iterar a coleção de "request.queryparams.names" em JS? na Comunidade da Apigee.

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".

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

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

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 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 o proxy chama:

http://mocktarget.apigee.net

Quais anexam "/user?user=Dude" a esse URL.

• Solicitação: request.uri = "/my-mock-proxy/user?user=Dude"
• Resposta: request.uri = "/user?user=Dude"

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 amostra "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"

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

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

Mensagem de resposta completa retornada pelo destino.

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

O valor de um parâmetro de formulário na resposta.

Contagem de todos os valores do parâmetro de formulário especificado em resposta.

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

Os nomes de todos os parâmetros do formulário na resposta.

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 Edge inferirá vários valores. Nesse caso, response.header.header_name retorna o primeiro valor apenas.

Para ler o cabeçalho inteiro, use o formulário response.header.header_name.values.

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

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

O valor do enésimo valor do cabeçalho na resposta. O Apigee Edge divide os valores de texto de cabeçalho por vírgulas. Observe que o índice com o valor que é usado para N é baseado em 1, não em 0.

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

Contagem de todos os cabeçalhos na resposta.

Os nomes de todos os cabeçalhos na resposta.

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

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 do tipo TransportMessage, que é um objeto contínuo.

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.

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

Obsoleto e retorna nulo. (Antigo UUID do roteador que processava o proxy.)

O nome comum esperado do TargetEndpoint, conforme referido em uma Política de destaque de serviço. Isso é significativo somente quando o TargetEndpoint se para um endpoint TLS/SSL.

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

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

Endereço IP do sistema.

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

O nome do data center região onde o proxy está sendo executado.

A hora em que essa variável foi lida. Por exemplo, "Quarta-feira, 21 de agosto de 2013 19:16:47 UTC".

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

A parte do ano de system.time.

A parte do mês de system.time.

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

O dia da parte da semana de system.time.

A parte de hora de system.time.

A parte do minuto de system.time.

A segunda parte de system.time.

A parte em milissegundos de system.time.

Fuso horário do sistema.

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".

O UUID do processador de mensagens que processa o proxy.

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, o target.basepath é "/user".

Se o destino fosse este:

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

O target.basepath seria nulo.

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).

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

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

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

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

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

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

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

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

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

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

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

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

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 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, "Qua, 21 Ago 2013 1916:47 UTC" corresponde ao valor do carimbo de data/hora de "1377112607413".

O valor de 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.

O tempo expresso 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 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 19:16:47 UTC" corresponde ao valor de carimbo de data/hora de "1377112607413".

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.

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

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

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 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 19:16:47 UTC" corresponde ao valor de carimbo de data/hora de "1377112607413".

O valor de 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.

A 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 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 19:16:47 UTC" corresponde ao valor de carimbo de data/hora de "1377112607413".

O valor de carimbo de data/hora que especifica quando o proxy começou a enviar a solicitação ao URL especificado em 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.

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

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

É 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.

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

Aliases de host do host virtual que é atingido durante uma solicitação específica.

Nome do host virtual que atende à solicitação do cliente de origem.

Retorna "true" se o TLS/SSL estiver ativado na configuração do host virtual.