Obtention des détails sur une alerte utilisateur

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur une alerte :

curl -X GET <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json"

Où

• <REST_API_ENDPOINT> indique le point de terminaison visé par l'appel à l'API REST. Pour plus d'informations, voir Noeuds finaux d'API REST Monitoring. Par exemple, le noeud final public d'une instance disponible dans la région us-south est le suivant : https://us-south.monitoring.cloud.ibm.com/api

• Vous pouvez transmettre plusieurs en-têtes à l'aide de l'indicateur -H.

  Authorization et IBMInstanceID sont les en-têtes requis pour l'authentification.

  TeamID est facultatif. Lorsque vous spécifiez cet en-tête, vous limitez la demande aux données et aux ressources disponibles pour l'équipe spécifiée.

  Pour obtenir AUTH_TOKEN et GUID, voir En-têtes des jetons IAM.

• <ALERT_ID> définit l'identifiant de l'alerte que vous souhaitez modifier.

Par exemple, le corps de la réponse d'une alerte se présente comme suit :

{
  "alert": {
    "autoCreated": false,
    "condition": "min(min(dallas_prod)) = 0",
    "createdOn": 1551358413000,
    "enabled": false,
    "id": 23211,
    "modifiedOn": 1551634372000,
    "name": "Monitoring Uptime Alert",
    "filter": "env in (\"prod\")",
    "notificationChannelIds": [
      4
    ],
    "segmentBy": [
      "host.hostname"
    ],
    "segmentCondition": {
      "type": "ANY"
    },
    "notificationCount": 60,
    "rateOfChange": false,
    "reNotify": false,
    "severity": 0,
    "severityLabel": "HIGH",
    "teamId": 493,
    "timespan": 60000000,
    "type": "MANUAL",
    "version": 9
  }
}

Création d'une alerte

Vous pouvez utiliser la commande cURL suivante pour créer une alerte :

curl -X POST <REST_API_ENDPOINT>/api/alerts -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json" -d @alert.json

Où

• <REST_API_ENDPOINT> indique le point de terminaison visé par l'appel à l'API REST. Pour plus d'informations, voir Noeuds finaux d'API REST Monitoring. Par exemple, le noeud final public d'une instance disponible dans la région us-south est le suivant : https://us-south.monitoring.cloud.ibm.com/api

• Vous pouvez transmettre plusieurs en-têtes à l'aide de l'indicateur -H.

  Authorization et IBMInstanceID sont les en-têtes requis pour l'authentification.

  TeamID est facultatif. Lorsque vous spécifiez cet en-tête, vous limitez la demande aux données et aux ressources disponibles pour l'équipe spécifiée.

  Pour obtenir AUTH_TOKEN et GUID, voir En-têtes des jetons IAM.

• Vous pouvez transmettre des données pour créer l'alerte dans le fichier alert.json à l'aide de l'indicateur -d.

  Lorsque vous créez une alerte, incluez les paramètres suivant : type, name, severity, timespan, condition, segmentby, segmentConditionn, filter, notificationChannelIds, enabled

  Pour plus d'informations, voir Schéma des alertes.

L'exemple suivant illustre les paramètres de corps de demande que vous pouvez définir pour créer une alerte :

{
  "alert": {
    "version": null,
    "name": "My Alert!",
    "description": null,
    "teamId": null,
    "enabled": false,
    "filter": null,
    "type": "MANUAL",
    "condition": "avg(timeAvg(uptime)) <= 0",
    "timespan": 600000000,
    "notificationChannelIds": [],
    "reNotify": false,
    "reNotifyMinutes": 30,
    "segmentBy": [
      "host.hostName"
    ],
    "segmentCondition": {
      "type": "ANY"
    },
    "severityLabel": "LOW"
  }
}

Mise à jour d'une alerte

Pour mettre à jour une alerte existante, vous avez besoin de l'ID de cette alerte.

Vous pouvez utiliser la commande cURL suivante pour mettre à jour une alerte :

curl -X PUT <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json" -d @alert.json

Où

• <REST_API_ENDPOINT> indique le point de terminaison visé par l'appel à l'API REST. Pour plus d'informations, voir Noeuds finaux d'API REST Monitoring. Par exemple, le noeud final public d'une instance disponible dans la région us-south est le suivant : https://us-south.monitoring.cloud.ibm.com/api

• Vous pouvez transmettre plusieurs en-têtes à l'aide de l'indicateur -H.

  Authorization et IBMInstanceID sont les en-têtes requis pour l'authentification.

  TeamID est facultatif. Lorsque vous spécifiez cet en-tête, vous limitez la demande aux données et aux ressources disponibles pour l'équipe spécifiée.

  Pour obtenir AUTH_TOKEN et GUID, voir En-têtes des jetons IAM.

• <ALERT_ID> définit l'identifiant de l'alerte que vous souhaitez modifier.

• Vous pouvez transmettre des données pour créer l'alerte dans le fichier alert.json à l'aide de l'indicateur -d.

  Pour plus d'informations, voir Schéma des alertes.

L'exemple suivant illustre les paramètres de corps de demande que vous pouvez définir pour mettre à jour une alerte :

{
  "alert": {
      "type": "MANUAL",
      "id": 23212,
      "version": 10,
      "name": "CheckNginxConnections",
      "description": "Active connections of nginx server",
      "enabled": false,
      "severity": 2,
      "timespan": 1000000,
      "condition": "avg(avg(nginx.net.connections)) > 1000",
      "segmentBy": [
          "host.hostName"
      ],
      "segmentCondition": {
          "type": "ANY"
      },
      "notificationChannelIds": [
          2
      ]
    }
}

Supprimer une alerte

Pour supprimer une alerte existante, vous avez besoin de l'ID de cette alerte.

Vous pouvez utiliser la commande cURL suivante pour supprimer une alerte :

curl -X DELETE <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json"

Où

• <REST_API_ENDPOINT> indique le point de terminaison visé par l'appel à l'API REST. Pour plus d'informations, voir Noeuds finaux d'API REST Monitoring. Par exemple, le noeud final public d'une instance disponible dans la région us-south est le suivant : https://us-south.monitoring.cloud.ibm.com/api

• Vous pouvez transmettre plusieurs en-têtes à l'aide de l'indicateur -H.

  Authorization et IBMInstanceID sont les en-têtes requis pour l'authentification.

  TeamID est facultatif. Lorsque vous spécifiez cet en-tête, vous limitez la demande aux données et aux ressources disponibles pour l'équipe spécifiée.

  Pour obtenir AUTH_TOKEN et GUID, voir En-têtes des jetons IAM.

• <ALERT_ID> définit l'ID de l'alerte que vous souhaitez supprimer.

Obtention de toutes les alertes utilisateur

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur toutes les alertes :

curl -X GET <REST_API_ENDPOINT>/api/alerts?from=<START_TIMESTAMP>&to=<END_TIMESTAMP> -H "Authorization: Bearer $AUTH_TOKEN" -H "IBMInstanceID: $GUID"

Où

• <REST_API_ENDPOINT> indique le point de terminaison visé par l'appel à l'API REST. Pour plus d'informations, voir Noeuds finaux d'API REST Monitoring. Par exemple, le noeud final public d'une instance disponible dans la région us-south est le suivant : https://us-south.monitoring.cloud.ibm.com/api

• Vous pouvez transmettre plusieurs en-têtes à l'aide de l'indicateur -H.

  Authorization et IBMInstanceID sont les en-têtes requis pour l'authentification. Pour obtenir AUTH_TOKEN et GUID, voir En-têtes des jetons IAM.

• to et from représentent les paramètres de requête que vous devez définir pour configure la période pendant laquelle vous souhaitez des informations sur les alertes.

Pour plus d'informations sur le format de réponse, voir Schéma des alertes.

Schéma des alertes : corps de demande

{
  "alerts": [
    {
      "alert": {
        "version": null,
        "name": "",
        "description": null,
        "teamId": null,
        "enabled": false,
        "filter": null,
        "type": "",
        "condition": "",
        "timespan": 600000000,
        "notificationChannelIds": [],
        "reNotify": false,
        "reNotifyMinutes": 30,
        "segmentBy": [],
        "segmentCondition": {
          "type": ""
        },
        "severityLabel": ""
      }
    }
  ]
}

Schéma des alertes : corps de réponse

{
  "alerts": [
    {
    "alert": {
      "autoCreated": false,
      "condition": "",
      "createdOn": 1551358413000,
      "enabled": false,
      "id": 23211,
      "modifiedOn": 1551634372000,
      "name": "",
      "filter": "",
      "notificationChannelIds": [],
      "segmentBy": [],
      "segmentCondition": {
        "type": "ANY"
      },
      "notificationCount": 60,
      "rateOfChange": false,
      "reNotify": false,
      "severity": 0,
      "severityLabel": "",
      "teamId": 493,
      "timespan": 60000000,
      "type": "",
      "version": 9
      }
    }
  ]
}

Codes de réponse des erreurs

Le tableau suivant récapitule les codes de réponse des erreurs courantes :

Paramètres du corps

kubernetes.namespace.name='production'

container.image='nginx'*.

kubernetes.namespace.name='production' and container.image='nginx'*.

"notificationChannelIds": [
      "EMAIL",
      "WEBHOOK"
    ]

Paramètres de requête