Publicación 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 las publicaciones http disponibles en el catálogo de acciones de automatización del flujo de trabajo. Estas acciones le permiten realizar operaciones de solicitud de publicación 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 Gestión 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

Enviar datos a un servidor

Realiza una llamada HTTP POST para enviar datos a un extremo de API.

Importante

Si necesita pasar datos confidenciales a una entrada, por ejemplo, un encabezado de clave de API, 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 para la solicitud. El esquema debe estar incluido: `https://example.com`
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.
cuerpo	Opcional	Cadena	El cuerpo de la solicitud.
selectores	Opcional	Lista	Los selectores para obtener únicamente el parámetro especificado como resultado.

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: httpPostTest steps: - name: query type: action action: http.post version: 1 inputs: url: ${{ .workflowInputs.url }} urlParams: ${{ .workflowInputs.urlParams }} headers: ${{ .workflowInputs.headers }} body: ${{ .workflowInputs.body }} selectors: ${{ .workflowInputs.selectors }}`	`{ "inputs": [ { "key": "url", "value": "https://example.com" }, { "key": "headers", "value": "{\"Content-Type\":\"application/json\"}" }, { "key": "urlParams", "value": "{\"foo\": \"bar\"}" }, { "key": "body", "value": "{\"foo\": \"bar\"}" }, { "key": "selectors", "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]" } ] }`	`Success case: { "success": true, "responseBody": "", "statusCode": 200 } Failure case: { "errorMessage": "An unexpected error failed to call http post endpoint.", "success": false }`

Definición de flujo de trabajo

Aporte

Producción

name: httpPostTest

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

{
    "inputs": [
      {
        "key": "url",
        "value": "https://example.com"
      },
      {
        "key": "headers",
        "value": "{\"Content-Type\":\"application/json\"}"
      },
      {
        "key": "urlParams",
        "value": "{\"foo\": \"bar\"}"
      },
      {
        "key": "body",
        "value": "{\"foo\": \"bar\"}"
      },
      {
        "key": "selectors",
        "value": "[{\"name\": \"responseBody\", \"expression\": \".responseBody\"}, {\"name\": \"statusCode\", \"expression\": \".statusCode\"}]"
      }
    ]
  }

Success case:
    {
      "success": true,
      "responseBody": "",
      "statusCode": 200
    }

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