Extraction de toutes les notifications utilisateur

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur tous les canaux de notification :

curl -X GET <REST_API_ENDPOINT>/api/notificationChannels?from=<START_TIMESTAMP>&to=<END_TIMESTAMP> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "SysdigTeamID: $TEAM_ID" -H "content-type: application/json"

Où

• <REST_API_ENDPOINT>indique le noeud final ciblé par l'appel 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.

  SysdigTeamID 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.

• 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 notifications.

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

Extraction d'une notification utilisateur spécifique

Vous pouvez utiliser la commande cURL suivante pour obtenir des informations sur un canal de notification :

curl -X GET <REST_API_ENDPOINT>/api/notificationChannels/<NOTIFICATION_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "SysdigTeamID: $TEAM_ID" -H "content-type: application/json"

Où

• <REST_API_ENDPOINT>indique le noeud final ciblé par l'appel 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.

  SysdigTeamID 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.

• <NOTIFICATION_ID> définit l'ID de la notification que vous souhaitez modifier.

Par exemple, le corps de la réponse d'un canal de notification par courrier électronique se présente comme suit :

{
  "notificationChannel": {
    "id": 20,
    "version": 1,
    "createdOn": 1466023669000,
    "modifiedOn": 1466023669000,
    "type": "EMAIL",
    "enabled": true,
    "name": "emailChannel",
    "options": {
      "emailRecipients": [
        "abc@xyz.com"
      ],
      "notifyOnOk": false
    }
  }
}

Création d'une notification

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

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

Où

• <REST_API_ENDPOINT>indique le noeud final ciblé par l'appel 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.

  SysdigTeamID 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 la notification dans le fichier notification.json à l'aide de l'indicateur -d.

  Les types valables sont " EMAIL, " PAGER_DUTY, " SLACK et " VICTOROPS.

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

{
  "notificationChannel": {
      "type": "SLACK",
      "enabled": true,
      "name": "my-slack-channel",
      "options": {
        "notifyOnOk": true,
        "url": "https://hooks.slack.com/services/xxx",
        "channel": "myslack"
        "notifyOnResolve": true,
      }
    }
  }

Suppression d'une notification

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

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

curl -X DELETE <REST_API_ENDPOINT>/api/notificationChannels/<NOTIFICATION_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "SysdigTeamID: $TEAM_ID" -H "content-type: application/json"

Où

• <REST_API_ENDPOINT>indique le noeud final ciblé par l'appel 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.

  SysdigTeamID 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.

• <NOTIFICATION_ID> définit l'ID de la notification que vous souhaitez modifier.

Mise à jour d'une notification

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

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

curl -X PUT <REST_API_ENDPOINT>/api/notificationChannels/<NOTIFICATION_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "SysdigTeamID: $TEAM_ID" -H "content-type: application/json" -d @notification.json

Où

• <REST_API_ENDPOINT>indique le noeud final ciblé par l'appel 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.

  SysdigTeamID 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.

• <NOTIFICATION_ID> définit l'ID de la notification que vous souhaitez modifier.

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

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

{
  "notificationChannel": {
    "id": 9,
    "version": 2,
    "type": "WEBHOOK",
    "enabled": true,
    "name": "test-tip-webhook",
    "options": {
      "notifyOnOk": false,
      "url": "https://test-tip.endpoint.com",
      "notifyOnResolve": true
    }
  }
}

Paramètres de corps de demande : tous les paramètres de corps de réponse spécifiés dans le canal de notification GET, à l'exception des suivants :

• createdOn
• modifiedOn

Remarque : La version des notifications peut passer par le corps de réponse de l'API notificationChannels. L'utilisateur peut également ajouter des customHeaders et customData aux notifications en fonction de ses besoins.

Schéma des notifications : corps de demande

Reportez-vous au schéma permettant d'obtenir des informations sur un ou plusieurs canaux de notification :

{
  "notificationChannel": {
    "id": 20,
    "version": 1,
    "type": "",
    "enabled": true,
    "name": "",
    "options": {
      "notifyOnOk": false,
      "notifyOnResolve": true,
      "resolveOnOk": true,
      "channel": "",
      "emailRecipients": "",
      "url" : "",
      "apiKey": "",
      "routingKey": "",
      "account": "",
      "serviceKey": "",
      "serviceName": ""
    }
  }
}

Reportez-vous au schéma lorsque vous créez, mettez à jour ou supprimez un canal de notification :

{
  "notificationChannel": {
    "id": 20,
    "version": 1,
    "type": "",
    "enabled": true,
    "name": "",
    "options": {
      "notifyOnOk": false,
      "notifyOnResolve": true,
      "resolveOnOk": true,
      "channel": "",
      "emailRecipients": "",
      "url" : "",
      "apiKey": "",
      "routingKey": "",
      "account": "",
      "serviceKey": "",
      "serviceName": ""
    }
  }
}

Schéma des notifications : corps de réponse

{
  "notificationChannel": {
    "id": 20,
    "version": 1,
    "createdOn": 1466023669000,
    "modifiedOn": 1466023669000,
    "type": "",
    "enabled": true,
    "name": "",
    "options": {
      "notifyOnOk": false,
      "notifyOnResolve": true,
      "resolveOnOk": true,
      "channel": "",
      "emailRecipients": "",
      "url" : "",
      "apiKey": "",
      "routingKey": "",
      "account": "",
      "serviceKey": "",
      "serviceName": ""
    }
  }
}

Paramètres du corps

Options (json)

Les options sont différentes selon le type de canal de notification.

Le JSON suivant présente le modèle de schéma :

"options": {
      "notifyOnOk": false,
      "notifyOnResolve": true,
      "resolveOnOk": true,
      "channel": "",
      "emailRecipients": "",
      "url" : "",
      "apiKey": "",
      "routingKey": "",
      "account": "",
      "serviceKey": "",
      "serviceName": ""
    }

Types de canaux de notification

Option	EMAIL	PAGER_DUTY	SLACK	VICTOROPS	WEBHOOK	OPSGENIE
name
notifyOnOk
notifyOnResolve
resolveOnOk
emailRecipients
url
apiKey
routingKey
account
serviceKey
serviceName

apiKey (chaîne)

Clé d'API de VictorOps. Vous devez vous procurer cette clé à partir de votre page de paramètres d'intégration VictorOps.

channel (chaîne)

Nom du canal.

emailRecipients (chaîne)

Liste des adresses électroniques.

notifyOnOk (valeur booléenne)

Indicateur spécifiant le statut d'envoi d'une notification lorsque l'état de notification passe d'ACTIVE à OK et que la notification est reconnue manuellement par un utilisateur.

Spécifiez true pour envoyer une notification.

Paramètres de requête