Te ofrecemos esta traducción automática para facilitar la lectura.
En caso de que haya discrepancias entre la versión en inglés y la versión traducida, se entiende que prevalece la versión en inglés. Visita esta página para obtener más información.
El explorador API REST también incluye el formato de solicitud curl, los parámetros disponibles, los posibles códigos de estado de respuesta y la estructura de respuesta JSON para cada una de las API de llamada disponibles. También puedes crear condición de alerta en la UI.
Datos y funciones disponibles a través de REST API
REST API functions
Comments
Ver datos de la cuenta
En general, cualquier rol puede usar un con funciones GET > List para view datos de alertas. El propietario y los administradores de la cuenta pueden emplear su clave de API.
La salida de la lista será paginada. Las funciones disponibles incluyen:
Puede tener un rol Owner o Admin en su cuenta and una clave de usuario o tener un rol personalizado que otorgue licencias para gestionar alertas y una clave de usuario para usar cualquier función de mantenimiento, incluidas POST > Create, PUT > Add, PUT > Update y DELETE.
Condiciones excluidas de la API REST
Este tipo de condiciones no tienen extremo disponible en la API:
APM: percentil de transacción web, condiciones dirigidas a etiquetas y anomalía
NRQL: anomalía
Politica de alertas
Estas funciones de API incluyen enlaces al Explorador de API, donde puede crear, eliminar o enumerar políticas.
Importante
De forma predeterminada, este extremo utiliza el centro de datos de EE. UU. Si su organización aloja datos en el centro de datos de la UE, asegúrese de utilizar los extremos de API adecuados para las cuentas de la región de la UE. Para las cuentas del centro de datos de JP, asegúrese de utilizar los extremos de API adecuados de la región de JP.
Para agregar nuevas políticas, use su clave de usuario e incluya estos dos valores en la llamada API:
curl-X PUT 'https://api.newrelic.com/v2/alerts_policies/{id}.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"policy": {
$
"incident_preference": "string",
$
"name": "string"
$
}
$
}'
Para eliminar una política existente, use su clave de usuario e incluya el policy_id (disponible en API Explorer > Alerts Policies > GET > List) en la llamada API:
curl-X GET 'https://api.newrelic.com/v2/alerts_policies.json'\
>
-H"$API_KEY"-i
Condiciones para APM, browser y dispositivos móviles
Estas funciones de la API incluyen enlaces al API Explorer, donde puede crear, actualizar, eliminar o listar condiciones de políticas. Estas llamadas son para condiciones con estos tipos de entidades:
APM: Apps y clave de transacciones
Browser: Clave de aplicaciones y transacciones
Móvil: aplicaciones móviles
Exception: Las siguientes condiciones de APM son not available de estos extremos de API:
Condiciones de etiquetas de orientación (orientación dinámica)
Condiciones percentil transacción web
Condiciones de anomalía
Importante
El Explorador de API proporciona información sobre otros tipos de condiciones mediante separate endpoints, incluidos los servicios externos (APM y móvil) y el monitoreo sintético. Considere todos los tipos de condiciones de alerta al buscar o actualizar. De forma predeterminada, este extremo usa el centro de datos de EE. UU. Si su cuenta aloja datos en el centro de datos de la UE, asegúrese de usar los extremos de API para cuentas de la región de la UE adecuados.
Para agregar condiciones a las políticas, incluya estos valores en la llamada API:
Su
El policy_id (disponible en API Explorer > Alerts Policies > GET > List)
curl-X POST 'https://api.newrelic.com/v2/alerts_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"condition": {
$
"type": "string",
$
"name": "string",
$
"enabled": boolean,
$
"entities": [
$
integer
$
],
$
"metric": "string",
$
"gc_metric": "string",
$
"condition_scope": "string",
$
"violation_close_timer": integer,
$
"runbook_url": "string",
$
"terms": [
$
{
$
"duration": "string",
$
"operator": "string",
$
"priority": "string",
$
"threshold": "string",
$
"time_function": "string"
$
}
$
],
$
"user_defined": {
$
"metric": "string",
$
"value_function": "string"
$
}
$
}
$
}'
La respuesta JSON devuelve una condición id, que deberá actualizar o eliminar. También puede ver la condición id de API Explorer > Alerts Conditions > GET > List.
Para actualizar las condiciones de las políticas, incluya estos valores en la llamada API:
curl-X GET 'https://api.newrelic.com/v2/alerts_conditions.json?policy_id=$POLICY_ID'\
>
-H"$API_KEY"-i
Condiciones para NRQL
Estas funciones de la API incluyen enlaces al API Explorer, donde puede crear, actualizar, eliminar o enumerar condiciones NRQL para sus políticas.
Exception: Las condiciones de anomalía NRQL son not available de este extremo.
Importante
De forma predeterminada, este extremo utiliza el centro de datos de EE. UU. Si su organización aloja datos en el centro de datos de la UE, asegúrese de estar utilizando los extremos de API adecuados para las cuentas de la región de la UE. Para las cuentas del centro de datos de JP, asegúrese de utilizar los extremos de API adecuados de la región de JP.
Recomendación: debido a la forma en que se transmiten los datos NRQL, configure aggregation_method en EVENT_FLOW y emplee las configuraciones predeterminadas de 60 para aggregation_window y 120 para aggregation_delay. EVENT_FLOW funciona en la mayoría de los casos de uso, pero para una discusión sobre qué casos de uso funcionan mejor con EVENT_TIMER, consulte Elija su método de agregación.
API Explorer > Alerts NRQL Conditions > POST > Create
Para crear condiciones NRQL para políticas:
bash
$
curl-X POST 'https://api.newrelic.com/v2/alerts_nrql_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"nrql_condition": {
$
"type": "string",
$
"name": "string",
$
"runbook_url": "string",
$
"enabled": boolean,
$
"terms": [
$
{
$
"duration": "string",
$
"operator": "string",
$
"priority": "string",
$
"threshold": "string",
$
"time_function": "string"
$
}
$
],
$
"value_function": "string",
$
"nrql": {
$
"query": "string"
$
},
$
"signal": {
$
"aggregation_window": "string",
$
"slide_by": "integer",
$
"aggregation_method": "string",
$
"aggregation_delay": integer,
$
"aggregation_timer": integer,
$
"fill_option": "string",
$
"fill_value": "string"
$
},
$
"expiration": {
$
"expiration_duration": "string",
$
"open_violation_on_expiration": boolean,
$
"close_violations_on_expiration": boolean
$
}
$
}
$
}'
Si omite type o lo configura como static, se utilizarán de forma predeterminada las alertas NRQL estándar.
Importante
Los clientes con planes de precios de Calcular avanzados y básicos pueden incurrir en cargos CCU adicionales al emplear la agregación de ventana deslizante. Si bien este método mejora el análisis de datos al suavizar las fluctuaciones, su uso puede generar mayores costos en comparación con otros métodos. Para obtener más detalles, consulte la sección de precios de ventanas corredizas. Para determinar si tiene planes de precios de Calcular avanzados o básicos, consulte su pedido.
Para actualizar las condiciones NRQL de las políticas, incluya estos valores en la llamada API:
curl-X GET 'https://api.newrelic.com/v2/alerts_nrql_conditions.json'\
>
-H"$API_KEY"-i\
>
-d'policy_id=$POLICY_ID'
Condiciones para servicios externos.
Estas funciones de la API incluyen enlaces al API Explorer, donde puede crear, actualizar, eliminar o listar condiciones de políticas. Estas llamadas son para condiciones de servicios externos. Las llamadas de API se pueden usar con y aplicaciones de monitoreo móvil.
Importante
De forma predeterminada, este extremo utiliza el centro de datos de EE. UU. Si su organización aloja datos en el centro de datos de la UE, asegúrese de estar utilizando los extremos de API adecuados para las cuentas de la región de la UE. Para las cuentas del centro de datos de JP, asegúrese de utilizar los extremos de API adecuados de la región de JP.
Para agregar condiciones para servicios externos a políticas que tengan APM o monitoreo de aplicaciones móviles, incluya estos valores en la llamada API:
El policy_id (disponible en API Explorer > Alerts Policies > GET > List)
Los valores external_service_condition requeridos en la llamada API (descritos en la página API Explorer y en el glosario API condición de alerta)
API Explorer > Alerts External Service Conditions > POST > Create
bash
$
curl-X POST 'https://api.newrelic.com/v2/alerts_external_service_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"external_service_condition": {
$
"type": "string",
$
"name": "string",
$
"enabled": boolean,
$
"entities": [
$
integer
$
],
$
"external_service_url": "string",
$
"metric": "string",
$
"runbook_url": "string",
$
"terms": [
$
{
$
"duration": "string",
$
"operator": "string",
$
"priority": "string",
$
"threshold": "string",
$
"time_function": "string"
$
}
$
]
$
}
$
}'
La respuesta JSON devuelve una condición id, que deberá actualizar o eliminar. También puede ver la condición id de API Explorer > Alerts External Service Conditions > GET > List.
Para actualizar condiciones de servicios externos a políticas que tengan APM o monitoreo de aplicaciones móviles, incluya estos valores en la llamada API:
La condición del servicio externo id (disponible en API Explorer > Alerts External Service Conditions > GET > List)
Los valores external_service_condition requeridos en la API de llamada (descritos en la página del Explorador de API y en el glosario de API de condición de alerta)
API Explorer > Alerts External Service Conditions > PUT > Update
bash
$
curl-X PUT 'https://api.newrelic.com/v2/alerts_external_service_conditions/$CONDITION_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"external_service_condition": {
$
"type": "string",
$
"name": "string",
$
"enabled": boolean,
$
"entities": [
$
integer
$
],
$
"external_service_url": "string",
$
"metric": "string",
$
"runbook_url": "string",
$
"terms": [
$
{
$
"duration": "string",
$
"operator": "string",
$
"priority": "string",
$
"threshold": "string",
$
"time_function": "string"
$
}
$
]
$
}
$
}'
Para eliminar condiciones de servicios externos de políticas con APM o monitoreo de apps móviles, incluya estos valores en la llamada API:
Para ver una lista de condiciones existentes para políticas con aplicaciones de servicios externos (APM o monitoreo de celulares), use su clave de usuario y el policy_id asociado en la API de llamada.
API Explorer > Alerts External Service Conditions > GET > List
bash
$
curl-X GET 'https://api.newrelic.com/v2/alerts_external_service_conditions.json'\
>
-H"$API_KEY"-i\
>
-d'policy_id=$POLICY_ID'
Condiciones para el monitoreo sintético
Estas funciones de la API incluyen enlaces al API Explorer, donde puede crear, actualizar, eliminar o listar condiciones para sus políticas de alertas. Las llamadas de API se pueden usar con el monitoreo sintético.
Para agregar condiciones a las políticas para el monitoreo sintético, incluya estos valores en la llamada API:
El policy_id (disponible en API Explorer > Alerts Policies > GET > List)
Los valores synthetics_condition requeridos en la API de llamada (descritos en la página del Explorador de API y en el glosario de API de condición de alerta)
API Explorer > Alerts Synthetics Conditions > POST > Create
bash
$
curl-X POST 'https://api.newrelic.com/v2/alerts_synthetics_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"synthetics_condition": {
$
"name": "string",
$
"monitor_id": "string",
$
"runbook_url": "string",
$
"enabled": boolean
$
}
$
}'
La respuesta JSON devuelve una condición id, que deberá actualizar o eliminar. También puede ver la condición id de API Explorer > Alerts Synthetics Conditions > GET > List.
Para actualizar las condiciones de las políticas, incluya estos valores en la llamada API:
Para ver una lista de las condiciones de políticas existentes para Sintético monitoreo, emplee su clave de usuario y el policy_id asociado en la API de llamada.
API Explorer > Alerts Synthetics Conditions > GET > List
bash
$
curl-X GET 'https://api.newrelic.com/v2/alerts_synthetics_conditions.json'\
>
-H"$API_KEY"-i\
>
-d'policy_id=$POLICY_ID'
Condiciones de múltiples ubicaciones para el monitoreo sintético
Estas funciones de la API incluyen enlaces al API Explorer, donde puede crear, actualizar, eliminar o listar condiciones para sus políticas de alertas. Las llamadas de API se pueden utilizar para condiciones de múltiples ubicaciones con monitoreo sintético. Antes de crear o actualizar una condición, lea las reglas para condiciones de alerta de múltiples ubicaciones.
Para agregar condiciones a las políticas para el monitoreo sintético de múltiples ubicaciones, incluya estos valores en la llamada API:
El policy_id (disponible en API Explorer > Alerts Policies > GET > List)
Los valores location_failure_condition requeridos en la API de llamada (descritos en la página del Explorador de API y en el glosario de API de condición de alerta)
API Explorer > Alerts Location Failure Conditions > POST > Create
bash
$
curl-X POST 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"location_failure_condition": {
$
"name": "string",
$
"runbook_url": "string",
$
"enabled": boolean,
$
"entities":
$
[
$
"string"
$
],
$
"terms": [
$
{
$
"priority": "string",
$
"threshold": integer,
$
}
$
],
$
"violation_time_limit_seconds": integer
$
}
$
}'
La respuesta JSON devuelve una condición id, que deberá actualizar o eliminar. También puede ver la condición id de API Explorer > Alerts Location Failure Conditions > GET > List.
Para actualizar las condiciones de la política para el monitoreo sintético de múltiples ubicaciones, incluya estos valores en la llamada API:
La condición id (disponible en API Explorer > Alerts Location Failure Conditions > GET > List)
Los valores location_failure_condition requeridos en la API de llamada (descritos en la página del Explorador de API y en el glosario de API de condición de alerta)
API Explorer > Alerts Location Failure Conditions > PUT > Update
bash
$
curl-X PUT 'https://api.newrelic.com/v2/alerts_location_failure_conditions/$CONDITION_ID.json'\
>
-H"$API_KEY"-i\
>
-H'Content-Type: application/json'\
>
-d\
>
'{
$
"location_failure_condition": {
$
"name": "string",
$
"runbook_url": "string",
$
"enabled": boolean,
$
"entities":
$
[
$
"string"
$
],
$
"terms": [
$
{
$
"priority": "string",
$
"threshold": integer,
$
}
$
],
$
"violation_time_limit_seconds": integer
$
}
$
}'
Para eliminar las condiciones de la política para el monitoreo sintético de múltiples ubicaciones, incluya estos valores en la llamada API:
Para ver una lista de las condiciones de políticas existentes para el monitoreo sintético en múltiples ubicaciones, use su clave de usuario y el policy_id asociado en la API de llamada.
API Explorer > Alerts Location Failure Conditions > GET > List
bash
$
curl-X GET 'https://api.newrelic.com/v2/alerts_location_failure_conditions/policies/$POLICY_ID.json'\
>
-H"$API_KEY"-i
Condiciones de la entidad de alerta
Estas funciones API incluyen enlaces al API Explorer, donde puede enumerar, agregar y eliminar entidades en las condiciones de su política de alertas.
Importante
De forma predeterminada, este extremo utiliza el centro de datos de EE. UU. Si su organización aloja datos en el centro de datos de la UE, asegúrese de estar utilizando los extremos de API adecuados para las cuentas de la región de la UE. Para las cuentas del centro de datos de JP, asegúrese de utilizar los extremos de API adecuados de la región de JP.
Para ver las condiciones de una entidad que se aplican a una entidad en APM, browser, mobile o transacciones clave, incluya estos valores en la llamada a la API:
El entity_id Esta es la entidad (objetivo de la alerta) a monitorear. Es el ID numérico de la aplicación APM, la aplicación de navegador, la transacción clave o la aplicación móvil.
El condition_id (disponible en API Explorer > Alerts Conditions > GET > List)
El entity_type, que debe ser uno de los siguientes:
Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > PUT > Add
bash
$
curl-X PUT 'https://api.newrelic.com/v2/alerts_entity_conditions/$ENTITY_ID.json'\
El entity_id Esta es la entidad (objetivo de la alerta) monitoreada específica que se eliminará. Es el ID numérico de la aplicación APM, la aplicación de navegador, la transacción clave o la aplicación móvil.
El condition_id (disponible en API Explorer > Alerts Conditions > GET > List)
El entity_type, que debe ser uno de los siguientes:
Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > DELETE > Remove