HTTP GET

visualização

Ainda estamos trabalhando nesse recurso, mas adoraríamos que você experimentasse!

Atualmente, esse recurso é fornecido como parte de um programa de visualização de acordo com nossas políticas de pré-lançamento.

Esta página fornece uma referência completa para o método HTTP GET disponível no catálogo de ações de automação de fluxo de trabalho. Essas ações permitem que você execute operações HTTP GET (solicitação).

Pré-requisitos

Antes de usar ações HTTP na automação de fluxo de trabalho, certifique-se de ter:

endpointde destino de URLs API.
Quaisquer credenciais de autenticação necessárias (chave de API, token, etc.).
Compreensão dos formatos de requisição/resposta da API.

Dica

As ações HTTP suportam sintaxe secreta para qualquer valor de cabeçalho, permitindo que você passe dados sensíveis com segurança, como a chave de API. Consulte o gerenciador de segredos para obter mais informações.

Cabeçalhos de solicitação automáticos

Todas requests HTTP realizadas pelo fluxo de trabalho Automation incluem automaticamente os seguintes cabeçalhos:

Cabeçalho	Formatar
`x-abuse-info`	`Request sent by a New Relic WorkflowAutomation. {runId}` onde `{runId}` é o ID da execução do fluxo de trabalho
`User-Agent`	`NewRelic/WorkflowAutomation (region={region}; https://newrelic.com ; support@newrelic.com)` onde `{region}` é a região de New Relic

Cabeçalho

Formatar

x-abuse-info

Request sent by a New Relic WorkflowAutomation. {runId}

onde

{runId}

é o ID da execução do fluxo de trabalho

User-Agent

NewRelic/WorkflowAutomation (region={region}; https://newrelic.com ; support@newrelic.com)

onde

{region}

é a região de New Relic

Solicitar dados da web

Realize uma chamada HTTP GET para recuperar dados de um endpointda API.

Importante

Se você precisar passar dados sensíveis para uma entrada, por exemplo um cabeçalho Api-Key, você pode usar valores armazenados por meio da mutação secretsManagementCreateSecret do NerdGraph.

Exemplo

{
    "inputs": [
      {
        "key": "headers",
        "value": "{\"Api-Key\": \"${{ :secrets:NR_API_KEY }}\"}"
      }
    ]
  }

Campo de entrada	Opcionalidade	Tipo	Descrição
url	Obrigatório	Corda	A URL de destino da solicitação. O esquema deve ser incluído: `https://example.com` . Consulte a seção sobre como usar entradas de fluxo de trabalho para valores dinâmicos.
parâmetros da URL	Opcional	Mapa	O parâmetro de consulta deve ser adicionado à URL. Recebe um objeto JSON em formato de string.
cabeçalhos	Opcional	Mapa	Os cabeçalhos a serem adicionados à solicitação. Recebe um objeto JSON em formato de string.
seletores	Opcional	Lista	Os seletores permitem obter apenas o parâmetro especificado como saída.

Seletores

Objetivo: Extrair dados específicos da resposta da API.

Estrutura:

name: O nome da variável para armazenar o valor extraído
expression: JSONPath ou expressão para analisar a resposta
Use responseBody | fromjson para analisar respostas JSON
Adicione filtros adicionais em cadeia usando a notação de ponto (por exemplo, .abbreviation).

Campo de saída	Tipo	Descrição
respostaCorpo	Corda	O corpo da resposta.
código de status	Interno	O código de status da resposta.
sucesso	Boleano	Status da solicitação.
mensagem de erro	Corda	Motivo da falha como mensagem.

Definição de fluxo de trabalho	Entrada	Saída
`name: httpGetTest steps: - name: query type: action action: http.get version: 1 inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} selectors: ${{ .workflowInputs.selectors }}`	`{ "inputs": [ { "key": "url", "value": "https://example.com" }, { "key": "urlParams", "value": "{\"foo\": \"bar\"}" }, { "key": "headers", "value": "{\"baz\": \"bat\"}" }, { "key": "selectors", "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]" } ] }`	`Success case: { "responseBody": "<!doctype html>\n<html>...</html>\n", "statusCode": 200, "success": true } Failure case: { "errorMessage": "An unexpected error failed to call http get endpoint.", "success": false }`

Definição de fluxo de trabalho

Entrada

Saída

name: httpGetTest
steps:
  - name: query
    type: action
    action: http.get
    version: 1
    inputs:
      url: ${{ .workflowInputs.url }}
      urlParams: ${{ .workflowInputs.urlParams }}
      headers: ${{ .workflowInputs.headers }}
      selectors: ${{ .workflowInputs.selectors }}

{
    "inputs": [
      {
        "key": "url",
        "value": "https://example.com"
      },
      {
        "key": "urlParams",
        "value": "{\"foo\": \"bar\"}"
      },
      {
        "key": "headers",
        "value": "{\"baz\": \"bat\"}"
      },
      {
        "key": "selectors",
        "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]"
      }
    ]
  }

Success case:
    {
      "responseBody": "<!doctype html>\n<html>...</html>\n",
      "statusCode": 200,
      "success": true
    }

  Failure case:
    {
      "errorMessage": "An unexpected error failed to call http get endpoint.",
      "success": false
    }

Esta tradução de máquina é fornecida para sua comodidade.