HTTP Get

Aperçu

Nous travaillons toujours sur cette fonctionnalité, mais nous aimerions que vous l'essayiez !

Cette fonctionnalité est actuellement fournie dans le cadre d'un programme d'aperçu conformément à nos politiques de pré-sortie.

Cette page fournit une référence complète pour HTTP Get disponible dans le catalogue des actions d'automatisation des workflows. Ces actions vous permettent d'effectuer des opérations de requête HTTP GET.

Prérequis

Avant d'utiliser les actions HTTP dans l'automatisation workflow, assurez-vous de disposer de :

cible points de terminaison d'API URLs.
Toutes les informations d'identification d'authentification requises (clé API, jeton, etc.).
Compréhension des formats de requête/réponse de l'API.

Conseil

Les actions HTTP prennent en charge la syntaxe secrète pour toute valeur d'en-tête, ce qui vous permet de transmettre en toute sécurité des données sensibles telles que les clés API. Consultez le gestionnaire de secrets pour plus d'informations.

En-têtes de requête automatiques

Toutes les requêtes HTTP effectuées par Workflow Automation incluent automatiquement les en-têtes suivants :

En-tête	Format
`x-abuse-info`	`Request sent by a New Relic WorkflowAutomation. {runId}` où `{runId}` est l'ID d'exécution du workflow
`User-Agent`	`NewRelic/WorkflowAutomation (region={region}; https://newrelic.com ; support@newrelic.com)` où `{region}` est la région New Relic

En-tête

Format

x-abuse-info

Request sent by a New Relic WorkflowAutomation. {runId}

où

{runId}

est l'ID d'exécution du workflow

User-Agent

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

où

{region}

est la région New Relic

Demander des données Web

Effectuez un appel HTTP GET pour récupérer des données à partir d'un point de terminaison d'API.

Important

Si vous devez transmettre des données sensibles à une entrée, par exemple un en-tête Api-Key, vous pouvez utiliser les valeurs stockées via la mutation NerdGraph secretsManagementCreateSecret.

Exemple

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

Champ de saisie	optionnalité	Type	Description
url	Requis	Chaîne	L'URL cible de la requête. Le schéma doit être inclus : `https://example.com` . Voir utilisation des entrées de workflow pour les valeurs dynamiques.
urlParams	Facultatif	Carte	Les paramètres de requête à ajouter à l'URL. Prend un objet JSON converti en chaîne de caractères.
en-têtes	Facultatif	Carte	Les en-têtes à ajouter à la requête. Prend un objet JSON converti en chaîne de caractères.
sélecteurs	Facultatif	List	Les sélecteurs permettant d'obtenir uniquement les paramètres spécifiés en sortie.

Sélecteurs

Objectif : Extraire des données spécifiques de la réponse de l'API.

Structure :

name: Le nom de la variable pour stocker la valeur extraite
expression: JSONPath ou expression pour analyser la réponse
Utilisez responseBody | fromjson pour analyser les réponses JSON
Chaîner des filtres supplémentaires à l'aide de la notation par points (par exemple, .abbreviation)

Champ de sortie	Type	Description
corps de réponse	Chaîne	Le corps de la réponse.
code d'état	Int	Le code d'état de la réponse.
succès	Booléen	Statut de la requête.
message d'erreur	Chaîne	Motif de l'échec : message.

définition du flux de travail	Saisir	Sortir
`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 }`

définition du flux de travail

Saisir

Sortir

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
    }

Cette traduction automatique est fournie pour votre commodité.