Uso de la API de Blob Storage para las configuraciones del agente

característica Disponibilidad

Fleet Control for Kubernetes clusters está disponible de forma general (GA). El soporte para administrar agentes en Linux and Windows hosts se encuentra actualmente en versión preliminar pública.

Para obtener una lista completa de agentes compatibles y sus entornos, consulte nuestra documentación de compatibilidad de tipos de agentes.

La función de vista previa pública se proporciona de conformidad con nuestras políticas de prelanzamiento.

El Blob Storage API es un servicio New Relic diseñado para cargar y gestionar archivos en tu cuenta. NerdGraph está optimizado para consultas y mutaciones de datos estructurados, por lo que la API de Blob Storage se utiliza para operaciones que involucran la transferencia de contenido de archivos y el control de versiones.

Dentro de Fleet Control, el Blob Storage API gestiona las configuraciones de los agentes—encargándose de la creación, el control de versiones, la recuperación de contenido y la eliminación de los archivos de configuración.

Importante

Las configuraciones del agente en Fleet Control utilizan el Blob Storage API, no NerdGraph. Para operaciones de flota, miembro y despliegue, consulte el tutorial deNerdGraph .

Requisitos previos

Una cuenta deNew Relic con una clave de API de usuario
Su New Relic Organization ID
Los permisos adecuados para administrar configuraciones

Autenticación

Todas las solicitudes a la API de Blob Storage requieren autenticación mediante una clave de API de usuario de New Relic.

Generar una clave de API:

Vaya a one.newrelic.com
Haga clic en su nombre en la esquina inferior izquierda
Selecciona API Keys
Crea una clave de User (no una clave de Browser o Licence)

Incluir en los encabezados de la solicitud:

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

Endpoint base

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

Para las cuentas de la región de la UE, use:

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

Operaciones de configuración del agente

Crea una nueva configuración de agente en una organización.

Extremo

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.
`Content-Type`	Encabezamiento	Cadena	Sí	Debe ser `application/x-yaml` .
`NewRelic-Entity`	Encabezamiento	cadena JSON	Sí	Objeto JSON que contiene metadatos de configuración (name, agentType, managedEntityType).
Cuerpo de la solicitud	Cuerpo	Texto sin formato	Sí	Contenido de configuración del agente en formato YAML.

Formato del encabezado NewRelic-Entity

El encabezado NewRelic-Entity debe contener un objeto JSON con los siguientes campos:

Campo	Tipo de datos	¿Es requerido?	Descripción
`name`	Cadena	Sí	El nombre de la configuración.
`agentType`	Cadena	Sí	Tipo de agente (por ejemplo, `NRInfra` , `NRDOT` , `FluentBit` ).
`managedEntityType`	Cadena	Sí	Tipo de entidad: `HOST` o `KUBERNETESCLUSTER` .

Campo

Tipo de datos

¿Es requerido?

Descripción

name

Cadena

Sí

El nombre de la configuración.

agentType

Cadena

Sí

Tipo de agente (por ejemplo,

NRInfra

NRDOT

FluentBit

managedEntityType

Cadena

Sí

Tipo de entidad:

HOST

KUBERNETESCLUSTER

Tipos de agentes admitidos

Agentes de infraestructura (para HOST y KUBERNETESCLUSTER):

NRInfra - Agente de New Relic Infrastructure
NRDOT - Distribución de New Relic del Colector de OpenTelemetry
FluentBit - Agente de logging Fluent Bit
NRPrometheusAgent - Agente de Prometheus
PipelineControlGateway - Gateway de Pipeline Control
NRApmOperator - Operador de APM para Kubernetes
NReBPFAgent - agente eBPF

Solicitud de muestra

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'

Ejemplo de respuesta

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

Importante: Guarde el entityGuid de la respuesta. Lo necesitará para versionar, recuperar y eliminar la configuración.

Crea una nueva versión de una configuración de agente existente.

Extremo

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`parentConfigurationId`	Camino	Cadena	Sí	El GUID de la entidad de configuración padre.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.
`Content-Type`	Encabezamiento	Cadena	Sí	Debe ser `application/x-yaml` .
Cuerpo de la solicitud	Cuerpo	Texto sin formato	Sí	Contenido de la configuración del agente actualizado en formato YAML.

Solicitud de muestra

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'

Ejemplo de respuesta

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

Recupera el contenido de una versión de configuración específica.

Extremo

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

Para obtener la última versión de una configuración, use:

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`configurationVersionId`	Camino	Cadena	Sí	El GUID de la entidad de la versión de configuración.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.
`version`	Consultar	Entero	No	Número de versión específico a recuperar (por ejemplo, `?version=1` ).

Ejemplo de solicitud (versión específica)

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'

Ejemplo de solicitud (última versión)

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'

Ejemplo de respuesta

Devuelve el contenido de la configuración como texto plano (YAML):

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

Recupera todas las versiones de una configuración.

Extremo

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`configurationId`	Camino	Cadena	Sí	El GUID de la entidad de configuración.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.

Solicitud de muestra

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'

Ejemplo de respuesta

{
  "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
}

Elimina una configuración y todas sus versiones.

Extremo

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`configurationId`	Camino	Cadena	Sí	El GUID de la entidad de configuración a eliminar.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.

Solicitud de muestra

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'

Ejemplo de respuesta

Devuelve HTTP 204 No Content tras una eliminación exitosa.

Elimina una versión de configuración específica.

Extremo

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

Solicitar parámetro

Parámetro	Ubicación	Tipo de datos	¿Es requerido?	Descripción
`orgId`	Camino	Cadena	Sí	Tu ID de organización de New Relic.
`configVersionGuid`	Camino	Cadena	Sí	El GUID de la entidad de la versión de configuración a eliminar.
`Api-Key`	Encabezamiento	Cadena	Sí	Tu clave de API de usuario.

Solicitud de muestra

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'

Ejemplo de respuesta

Devuelve HTTP 204 No Content tras una eliminación exitosa.

Mejores practicas

Almacena los GUID de la entidad: Guarda el entityGuid devuelto por las operaciones de creación. Los necesitarás para las operaciones de versionado, recuperación y eliminación.
Versione de forma incremental: Cree nuevas versiones para los cambios de configuración en lugar de eliminar y volver a crear las configuraciones.
Use nombres descriptivos: Los nombres de configuración deben indicar claramente su propósito y entorno de destino.
Validar YAML: Asegúrese de que el contenido de su configuración sea YAML válido antes de cargarlo.
Verifique la compatibilidad del tipo de agente: Asegúrese de que su tipo de agente sea compatible con el tipo de entidad administrada (HOST o KUBERNETESCLUSTER).
Proteja su clave de API: Nunca exponga su clave de API de usuario en el código del lado del cliente ni en repositorios públicos.
Verifique los códigos de estado HTTP: La API devuelve 2xx para operaciones exitosas, 404 para no encontrado y otros códigos de estado para errores.

Respuestas de error comunes

Código de estado	Descripción	Solución
`400 Bad Request`	Parámetros de solicitud inválidos o JSON mal formado en el encabezado NewRelic-Entity	Verificar el formato de la solicitud y los valores del encabezado
`401 Unauthorized`	Clave de API faltante o inválida	Verifica que tu clave de API de usuario sea válida y esté incluida en el encabezado Api-Key
`404 Not Found`	Configuración o versión no encontrada	Verifica que el GUID de la entidad sea correcto
`415 Unsupported Media Type`	Encabezado Content-Type incorrecto	Usar `Content-Type: application/x-yaml`

Recursos adicionales

Tutorial de NerdGraph Fleet Control - Para gestionar flotas y despliegues
Fleet Control CLI - Interfaz de línea de comandos basada en estas API
Descripción general de Fleet Control
Claves de API de New Relic

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

Uso de la API de Blob Storage para las configuraciones del agente

característica Disponibilidad

Importante

Requisitos previos.css-21sua1{background:none;border:none;width:0;padding:0;}

Autenticación

Endpoint base

Operaciones de configuración del agente

Crear versión de configuración

Obtener contenido de configuración

Listar versiones de configuración

Eliminar configuración

Eliminar versión de configuración

Mejores practicas

Respuestas de error comunes

Recursos adicionales

Requisitos previos