Tutoriel NerdGraph : Destinations des alertes

En plus de gérer vos destinations d'alerte dans l'UI, vous pouvez utiliser notre API NerdGraph.

Conseil

Pour obtenir de l’aide pour démarrer avec NerdGraph, consultez Introduction à NerdGraph.

Lister et filtrer les destinations

La requête destinations vous permet de parcourir toutes vos destinations par compte. Il permet également certaines fonctionnalités de filtrage.

Voici un exemple :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations {
          entities {
            id
            name
          }
          error {
            details
          }
        }
      }
    }
  }
}

Afin de parcourir vos destinations, vous devez demander le champ nextCursor lors de votre requête initiale.

Avec la pagination du curseur, vous continuez à effectuer une requête via l'ensemble de résultats jusqu'à ce que le nextCursor renvoyé par la réponse revienne vide. Cela signifie que vous avez atteint la fin de vos résultats.

Voici un exemple :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

Le code ci-dessus renvoie un ensemble de résultats comme celui-ci :

{
  "data": {
    "actor": {
      "account": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name"
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name"
              }
              // ... more destinations here in reality
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

Ainsi, dans votre requête suivante, fournissez le curseur comme ceci, jusqu'à ce que le curseur soit vide :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
          }
          totalCount
        }
      }
    }
  }
}

L'API permet d'interroger la destination par nom. Le filtre name renvoie des correspondances exactes et des correspondances partielles. Il n'est pas sensible à la casse. Cela renverra uniquement les informations pour les destinations correspondant au nom fourni.

Dans cet exemple, nous souhaitons trouver des destinations avec "DevOps" dans le nom :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { name: "DevOps" }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

L'API vous permet d'effectuer une requête par ID de destination :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { id: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

L'API vous permet d'effectuer des requêtes par type de destination. La requête suivante renverra toutes les destinations de courrier électronique sur le compte choisi :

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(filters: { type: EMAIL }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

Créer une destination

Afin de créer une destination, différentes entrées doivent être fournies pour chaque type de destination. Une propriété two_way_integration facultative est disponible pour l'intégration qui permet une intégration bidirectionnelle.

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: JIRA
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: "https://YOUR_INSTANCE.atlassian.net" }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: SERVICE_NOW
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: "https://YOUR_INSTANCE.service-now.com" }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
    }
  }
}

Dans cet exemple, auth est facultatif, selon le service intégré.

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: WEBHOOK
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_EMAIL, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "url", value: YOUR_WEBHOOK }
        { key: "two_way_integration", value: "true" }
      ]
    }
  ) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EVENT_BRIDGE
      name: "Destination Name"
      auth: {
        type: BASIC
        basic: { user: YOUR_IAM_USER, password: YOUR_PASSWORD }
      }
      properties: [
        { key: "AWSAccountId", value: YOUR_AWS_ACCOUNT_ID }
        { key: "AWSRegion", value: YOUR_AWS_REGION }
      ]
    }
  ) {
    destination {
      id
      name
    }
  }
}

PagerDuty a deux types d'intégration, niveau de service et niveau de compte. Pour plus d'informations, consultez la documentation d'intégration de PagerDuty.

Niveau de service:

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_SERVICE_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_INTEGRATION_TOKEN, prefix: "Token token=" }
      }
      properties: []
    }
  ) {
    destination {
      id
      name
    }
  }
}

Niveau du compte :

mutation {
  aiNotificationsCreateDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Destination Name"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
    }
  }
}

Mettre à jour une destination

Lorsque vous mettez à jour une destination, notez que vous n'avez pas besoin de fournir tous les attributs de la destination. Par exemple, vous n'avez besoin de fournir le nom que si vous avez l'intention de le mettre à jour :

mutation {
  aiNotificationsUpdateDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_destination_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
    }
  }
}

Tester une destination

Vous pouvez tester des destinations via l'API NerdGraph. Cela peut être fait avant ou après la création de la destination.

mutation {
  aiNotificationsTestDestination(
    accountId: YOUR_ACCOUNT_ID
    destination: {
      type: EMAIL
      name: "Destination Name"
      properties: [{ key: "email", value: YOUR_EMAIL }]
    }
  ) {
    error {
      details
    }
    details
    result
  }
}

mutation {
  aiNotificationsTestDestinationById(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

Supprimer une destination

Vous pouvez supprimer des destinations via l'API NerdGraph.

mutation {
  aiNotificationsDeleteDestination(
    accountId: YOUR_ACCOUNT_ID
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

Important

Si vous recevez un message d'échec indiquant Entity type channel is in use, vous devrez identifier les canaux utilisés par la destination et les supprimer avant de continuer. Pour ce faire, recherchez d’abord tous les canaux associés à la destination, puis supprimez chaque canal individuellement.

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        channels(filters: { destinationId: YOUR_DESTINATION_ID }) {
          entities {
            id
            name
          }
        }
      }
    }
  }
}

mutation {
  aiNotificationsDeleteChannel(
    accountId: YOUR_ACCOUNT_ID
    channelId: YOUR_CHANNEL_ID
  ) {
    ids
    error {
      details
    }
  }
}

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : Destinations des alertes

Conseil

Lister et filtrer les destinations

Liste de toutes les destinations pour un compte

Pagination par destinations avec pagination du curseur

Trouver toutes les destinations par nom

Rechercher une destination par identifiant

Trouver toutes les destinations par type

Créer une destination

Atlassian Jira

ServiceNow (gestion des incidents)

Mou

Webhook

E-mail

AWS EventBridge

PagerDuty

Mettre à jour une destination

Tester une destination

Supprimer une destination

Important

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : Destinations des alertes

Conseil

Lister et filtrer les destinations .css-21sua1{background:none;border:none;width:0;padding:0;}

Pagination par destinations avec pagination du curseur

Trouver toutes les destinations par nom

Rechercher une destination par identifiant

Trouver toutes les destinations par type

Créer une destination

Atlassian Jira

ServiceNow (gestion des incidents)

Mou

Webhook

E-mail

AWS EventBridge

PagerDuty

Mettre à jour une destination

Tester une destination

Supprimer une destination

Important

Lister et filtrer les destinations