Tutorial NerdGraph: destinos de inteligencia aplicada

Además de administrar sus destinos de inteligencia aplicada en la UI, puede utilizar nuestra API NerdGraph.

Sugerencia

Para obtener ayuda para comenzar con NerdGraph, consulte Introducción a NerdGraph.

Listar y filtrar destinos

La consulta destinations le permite paginar todos sus destinos por cuenta. También permite algunas funciones de filtrado.

He aquí un ejemplo:

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

Para paginar sus destinos, debe solicitar el campo nextCursor en su consulta inicial.

Con la paginación del cursor, continúa realizando una solicitud a través del conjunto de resultados hasta que el nextCursor que se devuelve de la respuesta vuelve vacío. Esto significa que llegó al final de sus resultados.

He aquí un ejemplo:

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

El código anterior devuelve un conjunto de resultados como este:

{
  "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
          }
        }
      }
    }
  }
}

Entonces, en su solicitud posterior, proporcione el cursor así, hasta que el cursor esté vacío:

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

La API permite consultar el destino por su nombre. El filtro name devuelve coincidencias exactas y coincidencias parciales. No distingue entre mayúsculas y minúsculas. Esto solo devolverá la información de los destinos que coincidan con el nombre proporcionado.

En este ejemplo, queremos buscar destinos con "DevOps" en el nombre:

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

La API te permite consultar por ID de destino:

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

La API te permite consultar por tipo de destino. La siguiente consulta devolverá todos los destinos de correo electrónico en la cuenta elegida:

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

Crear un destino

Para crear un destino, se deben proporcionar diferentes entradas para cada tipo de destino. Una propiedad two_way_integration opcional está disponible para integraciones que permiten la integración bidireccional.

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
    }
  }
}

En este ejemplo, auth es opcional, según el servicio que se integre.

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 tiene dos tipos de integración, nivel de servicio y nivel de cuenta. Para obtener más información, consulte los documentos de integración de PagerDuty.

Nivel de servicio:

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
    }
  }
}

Nivel de cuenta:

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
    }
  }
}

Actualizar un destino

Cuando actualiza un destino, tenga en cuenta que no es necesario proporcionar todos los atributos del destino. Por ejemplo, solo necesita proporcionar el nombre si solo desea actualizarlo:

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

Probando un destino

Puede probar destinos a través de la API NerdGraph. Esto se puede hacer antes o después de crear el destino.

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
  }
}

Eliminar un destino

Puede eliminar destinos a través de la API NerdGraph.

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

Importante

Si recibe un mensaje de error que indica Entity type channel is in use, deberá identificar los canales utilizados por el destino y eliminarlos antes de continuar. Para lograr esto, primero busque todos los canales asociados con el destino y luego elimine cada canal individualmente.

{
  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
    }
  }
}

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial NerdGraph: destinos de inteligencia aplicada

Sugerencia

Listar y filtrar destinos

Listado de todos los destinos para una cuenta

Paginar a través de destinos con paginación del cursor

Encuentra todos los destinos por nombre

Buscar destino por ID

Encuentra todos los destinos por tipo

Crear un destino

Atlassian Jira

ServiceNow (Incident-Management)

Slack

Webhook

Correo electrónico

AWS EventBridge

PagerDuty

Actualizar un destino

Probando un destino

Eliminar un destino

Importante

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial NerdGraph: destinos de inteligencia aplicada

Sugerencia

Listar y filtrar destinos .css-21sua1{background:none;border:none;width:0;padding:0;}

Paginar a través de destinos con paginación del cursor

Encuentra todos los destinos por nombre

Buscar destino por ID

Encuentra todos los destinos por tipo

Crear un destino

Atlassian Jira

ServiceNow (Incident-Management)

Slack

Webhook

Correo electrónico

AWS EventBridge

PagerDuty

Actualizar un destino

Probando un destino

Eliminar un destino

Importante

Listar y filtrar destinos