Utilisation de l'API Blob Storage pour les configurations d'agent

fonctionnalité Disponibilité

Fleet Control for Kubernetes clusters est en disponibilité générale (GA). La prise en charge de la gestion des agents sur Linux and Windows hosts est actuellement en version préliminaire publique.

Pour une liste complète des agents pris en charge et de leurs environnements, consultez notre documentation sur la compatibilité des types d'agents.

La fonctionnalité d'aperçu public est fournie conformément à nos politiques de pré-sortie.

Le Blob Storage API est un service New Relic conçu pour téléverser et gérer des fichiers dans votre compte. NerdGraph est optimisé pour les requêtes et les mutations de données structurées, c'est pourquoi l'API Blob Storage est utilisée pour les opérations impliquant le transfert et le versionnage du contenu des fichiers.

Dans Fleet Control, le Blob Storage API gère les configurations d'agent — en assurant la création, la gestion des versions, la récupération de contenu et la suppression des fichiers de configuration.

Important

Les configurations d'agent dans Fleet Control utilisent le Blob Storage API, et non NerdGraph. Pour les opérations de flotte, de membre et de déploiement, consultez le tutorielNerdGraph .

Prérequis

Un compteNew Relic avec une clé d'API utilisateur
Ton New Relic Organization ID
Les permissions appropriées pour gérer les configurations

Authentification

Toutes les requêtes d'API Blob Storage nécessitent une authentification à l'aide d'une clé d'API utilisateur New Relic.

Générer une clé d'API :

Allez sur one.newrelic.com
Cliquez sur votre nom dans le coin inférieur gauche
Sélectionnez API Keys
Créez une clé User (et non une clé Browser ou Licence)

Inclure dans les en-têtes de requête :

Api-Key: NRAK-YOUR-USER-API-KEY

Point de terminaison de base

https://blob-api.service.newrelic.com/v1/e

Pour les comptes de la région UE, utilisez :

https://blob-api.service.eu.newrelic.com/v1/e

Opérations de configuration de l'Agent

Crée une nouvelle configuration d'agent dans une organisation.

Point de terminaison

POST /v1/e/organizations/{orgId}/AgentConfigurations

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.
`Content-Type`	En-tête	Chaîne	Oui	Doit être `application/x-yaml` .
`NewRelic-Entity`	En-tête	chaîne JSON	Oui	Objet JSON contenant des métadonnées de configuration (name, agentType, managedEntityType).
Corps de la requête	Corps	Texte brut	Oui	Contenu de la configuration de l'agent au format YAML.

Format de l'en-tête NewRelic-Entity

L'en-tête NewRelic-Entity doit contenir un objet JSON avec les champs suivants :

Champ	Type de données	Est-ce requis ?	Description
`name`	Chaîne	Oui	Le nom de la configuration.
`agentType`	Chaîne	Oui	Type d'agent (par exemple, `NRInfra` , `NRDOT` , `FluentBit` ).
`managedEntityType`	Chaîne	Oui	Type d'entité : `HOST` ou `KUBERNETESCLUSTER` .

Champ

Type de données

Est-ce requis ?

Description

name

Chaîne

Oui

Le nom de la configuration.

agentType

Chaîne

Oui

Type d'agent (par exemple,

NRInfra

NRDOT

FluentBit

managedEntityType

Chaîne

Oui

Type d'entité :

HOST

KUBERNETESCLUSTER

Types d'agents pris en charge

Agents d'infrastructure (pour HOST et KUBERNETESCLUSTER) :

NRInfra - Agent New Relic Infrastructure
NRDOT - Distribution New Relic du collecteur OpenTelemetry
FluentBit - Agent de logging Fluent Bit
NRPrometheusAgent - Agent Prometheus
PipelineControlGateway - Gateway de contrôle de pipeline
NRApmOperator - Opérateur APM pour Kubernetes
NReBPFAgent - Agent eBPF

Demande d'échantillon

bash

$curl -X POST \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations \
>  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>  -H 'Content-Type: application/x-yaml' \
>  -H 'NewRelic-Entity: {"name": "Production Infra Config", "agentType": "NRInfra", "managedEntityType": "HOST"}' \
>  -d 'license_key: YOUR_LICENSE_KEY
$log:
$  level: info
$  forward: true
$integrations:
$  - name: nri-docker
$    enabled: true'

Exemple de réponse

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 1
  }
}

Important : Enregistrez le entityGuid de la réponse. Vous en aurez besoin pour versionner, récupérer et supprimer la configuration.

Crée une nouvelle version d'une configuration d'agent existante.

Point de terminaison

POST /v1/e/organizations/{orgId}/AgentConfigurations/{parentConfigurationId}

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`parentConfigurationId`	Chemin	Chaîne	Oui	Le GUID de l'entité de configuration parente.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.
`Content-Type`	En-tête	Chaîne	Oui	Doit être `application/x-yaml` .
Corps de la requête	Corps	Texte brut	Oui	Contenu de la configuration de l'agent mis à jour au format YAML.

Demande d'échantillon

bash

$curl -X POST \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY' \
>  -H 'Content-Type: application/x-yaml' \
>  -d 'license_key: YOUR_LICENSE_KEY
$log:
$  level: debug
$  forward: true
$integrations:
$  - name: nri-docker
$    enabled: true
$  - name: nri-nginx
$    enabled: true'

Exemple de réponse

{
  "entityGuid": "<YOUR_ENTITY_GUID>",
  "blobId": "<YOUR_BLOB_ID>",
  "blobVersionEntity": {
    "entityGuid": "<YOUR_ENTITY_GUID>",
    "version": 2
  }
}

Récupère le contenu d'une version de configuration spécifique.

Point de terminaison

GET /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configurationVersionId}

Pour récupérer la dernière version d'une configuration, utilisez :

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`configurationVersionId`	Chemin	Chaîne	Oui	Le GUID de l'entité de la version de configuration.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.
`version`	Qequête	Entier	Non	Numéro de version spécifique à récupérer (par exemple, `?version=1` ).

Exemple de requête (version spécifique)

bash

$curl -X GET \
>  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID>' \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

Exemple de requête (dernière version)

bash

$curl -X GET \
>  'https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>' \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

Exemple de réponse

Renvoie le contenu de la configuration en texte brut (YAML) :

license_key: YOUR_LICENSE_KEY
log:
  level: info
  forward: true
integrations:
  - name: nri-docker
    enabled: true

Récupère toutes les versions d'une configuration.

Point de terminaison

GET /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}/versions

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`configurationId`	Chemin	Chaîne	Oui	Le GUID de l'entité de configuration.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.

Demande d'échantillon

bash

$curl -X GET \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID>/versions \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

Exemple de réponse

{
  "versions": [
    {
      "entity_guid": "<YOUR_ENTITY_GUID_1>",
      "blob_id": "<YOUR_BLOB_ID_1>",
      "version": "1",
      "timestamp": "2024-01-01T00:00:00Z"
    },
    {
      "entity_guid": "<YOUR_ENTITY_GUID_2>",
      "blob_id": "<YOUR_BLOB_ID_2>",
      "version": "2",
      "timestamp": "2024-01-02T00:00:00Z"
    }
  ],
  "cursor": null
}

Supprime une configuration et toutes ses versions.

Point de terminaison

DELETE /v1/e/organizations/{orgId}/AgentConfigurations/{configurationId}

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`configurationId`	Chemin	Chaîne	Oui	Le GUID de l'entité de configuration à supprimer.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.

Demande d'échantillon

bash

$curl -X DELETE \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurations/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

Exemple de réponse

Renvoie HTTP 204 No Content en cas de suppression réussie.

Supprime une version de configuration spécifique.

Point de terminaison

DELETE /v1/e/organizations/{orgId}/AgentConfigurationVersions/{configVersionGuid}

Paramètres de la demande

paramètres	Emplacement	Type de données	Est-ce requis ?	Description
`orgId`	Chemin	Chaîne	Oui	Votre ID d'organisation New Relic.
`configVersionGuid`	Chemin	Chaîne	Oui	Le GUID de l'entité de version de configuration à supprimer.
`Api-Key`	En-tête	Chaîne	Oui	Votre clé d'API utilisateur.

Demande d'échantillon

bash

$curl -X DELETE \
>  https://blob-api.service.newrelic.com/v1/e/organizations/YOUR_ORG_ID/AgentConfigurationVersions/<YOUR_ENTITY_GUID> \
>  -H 'Api-Key: NRAK-YOUR-API-KEY'

Exemple de réponse

Renvoie HTTP 204 No Content en cas de suppression réussie.

Meilleures pratiques

Stockez les GUID d'entité : Enregistrez le entityGuid renvoyé par les opérations de création. Vous en aurez besoin pour les opérations de versioning, de récupération et de suppression.
Versionnez de manière incrémentielle : Créez de nouvelles versions pour les modifications de configuration plutôt que de supprimer et de recréer les configurations.
Utilisez des noms descriptifs : Les noms de configuration doivent indiquer clairement leur objectif et leur environnement cible.
Valider le YAML : Assurez-vous que le contenu de votre configuration est un YAML valide avant de le téléverser.
Vérifiez la compatibilité du type d'agent : Assurez-vous que votre type d'agent est compatible avec le type d'entité gérée (HOST ou KUBERNETESCLUSTER).
Sécurisez votre clé d'API : N'exposez jamais votre clé d'API utilisateur dans du code côté client ou des dépôts publics.
Vérifiez les codes d'état HTTP : L'API renvoie 2xx pour les opérations réussies, 404 pour non trouvé, et d'autres codes d'état pour les erreurs.

Réponses d'erreur courantes

Code d'état	Description	Solution
`400 Bad Request`	Paramètres de requête invalides ou JSON malformé dans l'en-tête NewRelic-Entity	Vérifier le format de la requête et les valeurs d'en-tête
`401 Unauthorized`	Clé API manquante ou invalide	Vérifiez que votre clé d'API utilisateur est valide et incluse dans l'en-tête Api-Key
`404 Not Found`	Configuration ou version introuvable	Vérifiez que le GUID de l'entité est correct
`415 Unsupported Media Type`	En-tête Content-Type incorrect	Utiliser `Content-Type: application/x-yaml`

Ressources supplémentaires

Tutoriel NerdGraph Fleet Control - Pour gérer les flottes et les déploiements
Fleet Control CLI - Interface en ligne de commande basée sur ces API
Vue d'ensemble de Fleet Control
Clés d'API New Relic

Cette traduction automatique est fournie pour votre commodité.

Utilisation de l'API Blob Storage pour les configurations d'agent

fonctionnalité Disponibilité

Important

Prérequis.css-21sua1{background:none;border:none;width:0;padding:0;}

Authentification

Point de terminaison de base

Opérations de configuration de l'Agent

Créer une version de configuration

Obtenir le contenu de la configuration

Lister les versions de configuration

Supprimer la configuration

Supprimer la version de configuration

Meilleures pratiques

Réponses d'erreur courantes

Ressources supplémentaires

Prérequis