Obtener HTTP

avance

Todavía estamos trabajando en esta característica, ¡pero nos encantaría que la probaras!

Esta característica se proporciona actualmente como parte de un programa de vista previa de conformidad con nuestras políticas de prelanzamiento.

Esta página proporciona una referencia completa para HTTP Get disponible en el catálogo de acciones de automatización del flujo de trabajo. Estas acciones le permiten realizar operaciones GET de solicitud HTTP.

Requisitos previos

Antes de emplear acciones HTTP en la automatización de flujos de trabajo, cerciorar de tener:

Objetivo extremos de URL de API.
Cualquier credencial de autenticación requerida (clave de API, token, etc.).
Comprensión de los formatos de solicitud/respuesta de la API.

Sugerencia

Las acciones HTTP admiten la sintaxis secreta para cualquier valor de encabezado, lo que le permite pasar de forma segura datos confidenciales como la clave de API. Consulte el administrador de secretos para obtener más información.

Encabezados de solicitud automáticos

Todas requests HTTP realizadas por flujo de trabajo Automation incluyen automáticamente los siguientes encabezados:

Encabezamiento	Formato
`x-abuse-info`	`Request sent by a New Relic WorkflowAutomation. {runId}` donde `{runId}` es el ID de ejecución del flujo de trabajo
`User-Agent`	`NewRelic/WorkflowAutomation (region={region}; https://newrelic.com ; support@newrelic.com)` donde `{region}` es la región New Relic

Encabezamiento

Formato

x-abuse-info

Request sent by a New Relic WorkflowAutomation. {runId}

donde

{runId}

es el ID de ejecución del flujo de trabajo

User-Agent

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

donde

{region}

es la región New Relic

Aplicar datos sitio web

Realizar una llamada HTTP GET para recuperar datos de un extremo de API.

Importante

Si necesita pasar datos confidenciales a una entrada, por ejemplo un encabezado Api-Key, puede usar valores almacenados a través de la mutación NerdGraph secretsManagementCreateSecret.

Ejemplo

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

Campo de entrada	Opcionalidad	Tipo	Descripción
url	Requerido	Cadena	La URL de destino de la solicitud. El esquema debe incluir: `https://example.com` . Consulte cómo usar entradas de flujo de trabajo para obtener valores dinámicos.
parámetros de URL	Opcional	Mapa	El parámetro consulta que se agregará a la URL. Toma un objeto JSON en formato de cadena.
encabezados	Opcional	Mapa	Las cabeceras que se deben agregar a la solicitud. Toma un objeto JSON en formato de cadena.
selectores	Opcional	Lista	Los selectores para obtener únicamente el parámetro especificado como resultado.

Selectores

Propósito: Extraer datos específicos de la respuesta de la API.

Estructura:

name:El nombre de la variable para almacenar el valor extraído
expression:JSONPath o expresión para analizar la respuesta
Emplee responseBody | fromjson para analizar las respuestas JSON
filtros adicionales de cadena usando notación de puntos (por ejemplo, .abbreviation)

Campo de salida	Tipo	Descripción
cuerpo de respuesta	Cadena	El cuerpo de la respuesta.
código de estado	En t	El código de estado de la respuesta.
éxito	Booleano	Estado de la solicitud.
mensaje de error	Cadena	Mensaje de motivo del fallo.

Definición de flujo de trabajo	Aporte	Producción
`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 }`

Definición de flujo de trabajo

Aporte

Producción

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
    }

Te ofrecemos esta traducción automática para facilitar la lectura.