Cette traduction automatique est fournie pour votre commodité.
En cas d'incohérence entre la version anglaise et la version traduite, la version anglaise prévaudra. Veuillez visiter cette page pour plus d'informations.
Le REST API Explorer inclut également le format de requête curl, les paramètres disponibles, les codes d'état de réponse potentiels et la structure de réponse JSON pour chacun des appels d'API disponibles. Vous pouvez également créer une condition d'alerte dans l'UI.
En général, n'importe quel rôle peut utiliser un avec des fonctions GET > List pour view données d'alerte. Le propriétaire du compte et les administrateurs peuvent utiliser leur clé API.
La sortie de la liste sera paginée. Les fonctions disponibles incluent :
Vous pouvez avoir un rôle Owner ou Admin dans votre compte and une clé utilisateur ou avoir un rôle personnalisé qui accorde des autorisations pour gérer les alertes et une clé utilisateur afin d'utiliser n'importe quelle fonction de maintenance, y compris POST > Create, PUT > Add, PUT > Update et DELETE.
Conditions exclues de l'API REST
Ces types de conditions n'ont pas de point de terminaison disponible dans l'API:
APM: centile Web des transactions, conditions de ciblage des étiquettes et anomalie
NRQL: anomalie
Qègle d'alerte
Ces fonctions API incluent des liens vers l'explorateur d'API, où vous pouvez créer, supprimer ou répertorier des stratégies.
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"
$
}
$
}'
Pour supprimer une politique existante, utilisez votre clé utilisateur et incluez le policy_id (disponible depuis API Explorer > Alerts Policies > GET > List) dans l'appel d'API:
Pour afficher une liste des politiques existantes pour votre compte, utilisez votre clé utilisateur et incluez ces valeurs facultatives dans l'appel d'API:
curl-X GET 'https://api.newrelic.com/v2/alerts_policies.json'\
>
-H"$API_KEY"-i
Conditions pour APM, navigateur et mobile
Ces fonctions API incluent des liens vers l'explorateur d'API, où vous pouvez créer, mettre à jour, supprimer ou répertorier les conditions de politique. Ces appels concernent des conditions avec ces types d'entités :
APM: Applications et clé de transaction
Navigateur : Apps et clé de transaction
Mobile : Applications mobiles
Exception: Les conditions APM suivantes sont not available à partir de ces points de terminaison d'API:
Conditions de ciblage des libellés (ciblage dynamique)
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 réponse JSON renvoie une condition id, dont vous devrez mettre à jour ou supprimer la condition. Vous pouvez également visualiser la condition id à partir de API Explorer > Alerts Conditions > GET > List.
Pour mettre à jour les conditions des politiques, incluez ces valeurs dans l'appel d'API:
curl-X GET 'https://api.newrelic.com/v2/alerts_conditions.json?policy_id=$POLICY_ID'\
>
-H"$API_KEY"-i
Conditions pour obtenir le NRQL
Ces fonctions API incluent des liens vers l'explorateur d'API, où vous pouvez créer, mettre à jour, supprimer ou répertorier les conditions NRQL pour vos politiques.
Exception: Les conditions d'anomalie NRQL sont not available à partir de ce point de terminaison.
Recommandation : en raison de la manière dont les données NRQL sont diffusées, définissez aggregation_method sur EVENT_FLOW et utilisez les paramètres par défaut de 60 pour aggregation_window et 120 pour aggregation_delay. EVENT_FLOW fonctionne dans la plupart des cas d'utilisation, mais pour une discussion sur les cas d'utilisation qui fonctionnent mieux avec EVENT_TIMER, voir Choisissez votre méthode d'agrégation.
API Explorer > Alerts NRQL Conditions > POST > Create
Pour créer des conditions NRQL pour les stratégies :
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 vous omettez type ou le définissez sur static, l'alerte NRQL standard sera utilisée par défaut.
Important
Les clients bénéficiant des plans tarifaires Advanced et Core Compute peuvent encourir des frais CCU supplémentaires lors de l'utilisation de l'agrégation de fenêtres coulissantes. Bien que cette méthode améliore l’analyse des données en atténuant les fluctuations, son utilisation peut entraîner une augmentation des coûts par rapport à d’autres méthodes. Pour plus de détails, consultez la section de tarification des fenêtres coulissantes. Pour déterminer si vous utilisez les plans tarifaires Advanced ou Core Compute, reportez-vous à votre commande.
Pour mettre à jour les conditions NRQL des politiques, incluez ces valeurs dans l'appel d'API:
curl-X GET 'https://api.newrelic.com/v2/alerts_nrql_conditions.json'\
>
-H"$API_KEY"-i\
>
-d'policy_id=$POLICY_ID'
Conditions pour les prestations externes
Ces fonctions API incluent des liens vers l'explorateur d'API, où vous pouvez créer, mettre à jour, supprimer ou répertorier les conditions de politique. Ces appels concernent les conditions de prestations externes. L'appel d'API peut être utilisé avec et monitoring des applications mobiles.
Pour ajouter des conditions pour les services externes aux politiques qui ont des applications mobiles APM ou monitoring , incluez ces valeurs dans l'appel d'API:
Le policy_id (disponible à partir de API Explorer > Alerts Policies > GET > List)
Les valeurs external_service_condition requises dans l'appel d'API (décrites dans la page API Explorer et dans le glossaire API condition d'alerte)
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 réponse JSON renvoie une condition id, dont vous devrez mettre à jour ou supprimer la condition. Vous pouvez également visualiser la condition id à partir de API Explorer > Alerts External Service Conditions > GET > List.
Pour mettre à jour les conditions des services externes vers des politiques qui ont des applications mobiles APM ou monitoring , incluez ces valeurs dans l'appel d'API:
La condition de service externe id (disponible à partir de API Explorer > Alerts External Service Conditions > GET > List)
Les valeurs external_service_condition requises dans l'appel d'API (décrites dans la page API Explorer et dans le glossaire API condition d'alerte)
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"
$
}
$
]
$
}
$
}'
Pour supprimer des conditions pour des services externes à partir de politiques avec APM ou monitoring d'applications mobiles, incluez ces valeurs dans l'appel d'API:
Pour afficher la liste des conditions existantes pour les politiques avec des applications de service externes (APM ou monitoring des applications mobiles), utilisez votre clé utilisateur et le policy_id associé dans l'appel d'API.
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'
Conditions de monitoring Synthétique
Ces fonctions API incluent des liens vers l'API Explorer, où vous pouvez créer, mettre à jour, supprimer ou répertorier les conditions de votre règle d'alerte. L'appel d'API peut être utilisé avec Synthétique monitoring.
Pour ajouter des conditions aux politiques de monitoring Synthétique, incluez ces valeurs dans l'appel d'API:
Le policy_id (disponible à partir de API Explorer > Alerts Policies > GET > List)
Les valeurs synthetics_condition requises dans l'appel d'API (décrites dans la page API Explorer et dans le glossaire API condition d'alerte)
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 réponse JSON renvoie une condition id, dont vous devrez mettre à jour ou supprimer la condition. Vous pouvez également visualiser la condition id à partir de API Explorer > Alerts Synthetics Conditions > GET > List.
Pour mettre à jour les conditions des politiques, incluez ces valeurs dans l'appel d'API:
Pour afficher la liste des conditions de politique existantes pour Synthétique monitoring, utilisez votre clé utilisateur et le policy_id associé dans l'appel d'API.
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'
Conditions multi-sites pour monitoring Synthétique
Ces fonctions API incluent des liens vers l'API Explorer, où vous pouvez créer, mettre à jour, supprimer ou répertorier les conditions de votre règle d'alerte. L'appel d'API peut être utilisé pour des conditions multi-sites avec monitoring Synthétique. Avant de créer ou de mettre à jour une condition, lisez les règles relatives à la condition d'alerte multi-emplacements.
Pour ajouter des conditions aux politiques de monitoring Synthétique multi-sites, incluez ces valeurs dans l'appel d'API:
Le policy_id (disponible à partir de API Explorer > Alerts Policies > GET > List)
Les valeurs location_failure_condition requises dans l'appel d'API (décrites dans la page API Explorer et dans le glossaire API condition d'alerte)
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 réponse JSON renvoie une condition id, dont vous devrez mettre à jour ou supprimer la condition. Vous pouvez également visualiser la condition id à partir de API Explorer > Alerts Location Failure Conditions > GET > List.
Pour mettre à jour les conditions de politique pour monitoring Synthétique multi-sites, incluez ces valeurs dans l'appel d'API:
Pour afficher la liste des conditions de politique existantes pour monitoring Synthétique multi-sites, utilisez votre clé utilisateur et le policy_id associé dans l'appel d'API.
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
Conditions d'alerte de l'entité
Ces fonctions API incluent des liens vers l'API Explorer, où vous pouvez répertorier, ajouter et supprimer des entités dans les conditions de votre règle d'alerte.
Pour afficher les conditions d'une entité qui s'appliquent à une entité dans APM, navigateur, mobile ou clé de transaction, incluez ces valeurs dans l'appel d'API:
Le entity_id Il s'agit de l'entité (alerte cible) à monitorer. Il s'agit de l'ID numérique de l'application APM, de l'application de navigateur, de la transaction clé ou de l'application mobile.
Le condition_id (disponible à partir de API Explorer > Alerts Conditions > GET > List)
Le entity_type, qui doit être l'un des suivants :
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'\
Le entity_id Il s'agit de l'entité de monitoring spécifique (alerte cible) à supprimer. Il s'agit de l'ID numérique de l'application APM, de l'application de navigateur, de la transaction clé ou de l'application mobile.
Le condition_id (disponible à partir de API Explorer > Alerts Conditions > GET > List)
Le entity_type, qui doit être l'un des suivants :
Application
BrowserApplication
MobileApplication
KeyTransaction
API Explorer > Alerts Entity Conditions > DELETE > Remove