Administrar destinos entre cuentas

avance

Todavía estamos trabajando en esta característica, ¡pero nos encantaría que la probaras!

Esta característica se proporciona actualmente como parte de un programa de vista previa de conformidad con nuestras políticas de prelanzamiento.

Utilice el NerdGraph API para crear, probar, listar, actualizar y eliminar cross account destinations. Cross account destinations le permiten centralizar la gestión de notificaciones a nivel de la organización.

Crear un destino

Para crear un destino, se deben proporcionar diferentes entradas para cada tipo de destino.

Importante

Debe proporcionar un objeto de alcance que identifique dónde se creará el destino. El objeto de alcance requiere:

id: El ID de la cuenta u organización.
type: El tipo de alcance (Cuenta u Organización).
Una propiedad opcional two_way_integration está disponible para integraciones que permiten la integración bidireccional.

Usa la mutación aiNotificationsCreateDestination para crear un destino de Jira que se integra con tu instancia de Atlassian Jira para crear y gestionar incidencias desde las alertas de New Relic.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `JIRA` para destinos de Atlassian Jira.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de Jira.
`destination.auth`	Objeto	(Obligatorio) Configuración de autenticación para conectarse a su instancia de Jira.
`destination.auth.type`	Enumeración	(Obligatorio) Debe ser `BASIC` para las integraciones de Jira que usan autenticación de nombre de usuario y contraseña/token de API.
`destination.auth.basic`	Objeto	(Obligatorio) Contiene las credenciales de autenticación de Jira (correo electrónico y contraseña/token de API).
`destination.auth.basic.user`	Cadena	(Obligatorio) La dirección de correo electrónico de su cuenta de Jira.
`destination.auth.basic.password`	Cadena	(Obligatorio) Su contraseña de cuenta de Jira o token de API. Por seguridad, use un token de API en lugar de la contraseña de su cuenta.
`destination.properties`	matriz de objetos	(Obligatorio) Propiedades de configuración que incluyen la URL de la instancia de Jira y las opciones de integración.
`destination.properties[].key: "url"`	Cadena	(Obligatorio) Debe incluir una propiedad con la clave "url" y el valor establecido en la URL de su instancia de Jira (p. ej., "https://yourcompany.atlassian.net").
`destination.properties[].key: "two_way_integration"`	Cadena	(Opcional) Establecer en "true" para habilitar la integración bidireccional entre New Relic y Jira.

Consulta de ejemplo para una cuenta y organización:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

Ejemplo de consulta para una organización:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ORGANIZATION_ID, type: ORGANIZATION }
    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
      scope {
        id
        type
      }
    }
  }
}

Utilice la mutación aiNotificationsCreateDestination para crear un destino de correo electrónico para enviar alertas de notificación a direcciones de correo electrónico.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `EMAIL` para destinos de correo electrónico.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de correo electrónico.
`destination.properties`	matriz de objetos	(Obligatorio) Pares clave-valor que contienen la configuración de correo electrónico. Debe incluir una clave `email` con la dirección de correo electrónico de destino como valor.

Consulta de ejemplo:

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

Utilice la mutación aiNotificationsCreateDestination para crear un destino de webhook para enviar solicitudes HTTP POST a endpoints externos cuando se activen las alertas.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `WEBHOOK` para destinos de webhook.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino del webhook.
`destination.auth`	Objeto	(Opcional) Configuración de autenticación. Requerido solo cuando el endpoint del webhook requiere autenticación.
`destination.auth.type`	Enumeración	(Requerido cuando se proporciona autenticación) Método de autenticación. Opciones: `BASIC`, `TOKEN`.
`destination.auth.basic`	Objeto	(Requerido para la autenticación BASIC y TOKEN) Contiene credenciales de autenticación, como nombre de usuario/contraseña o información del token.
`destination.properties`	matriz de objetos	(Obligatorio) Pares clave-valor que contienen la configuración del webhook. Debe incluir la clave `url` con la URL del endpoint del webhook. `two_way_integration` opcional para comunicación bidireccional.

Consulta de ejemplo:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

Use la mutación aiNotificationsCreateDestination para crear un destino a nivel de servicio de PagerDuty que se integre con un servicio específico de PagerDuty usando una clave de integración.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `PAGERDUTY_SERVICE_INTEGRATION` para destinos de nivel de servicio de PagerDuty.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de servicio de PagerDuty.
`destination.auth`	Objeto	(Obligatorio) Configuración de autenticación que contiene la clave de integración de PagerDuty.
`destination.auth.type`	Enumeración	(Obligatorio) Debe ser `TOKEN` para las integraciones de servicios de PagerDuty.
`destination.auth.basic`	Objeto	(Obligatorio) Contiene el token de integración y el prefijo para la autenticación de PagerDuty.
`destination.auth.basic.token`	Cadena	(Obligatorio) La clave de integración de PagerDuty obtenida de la configuración de su servicio de PagerDuty.
`destination.auth.basic.prefix`	Cadena	(Obligatorio) Debe ser `"Token token="` para las integraciones de servicios de PagerDuty.
`destination.properties`	matriz de objetos	(Opcional) Propiedades de configuración adicionales. Puede ser un arreglo vacío para la integración básica de servicios.

Consulta de ejemplo:

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

Utilice la mutación aiNotificationsCreateDestination para crear un destino a nivel de cuenta de PagerDuty que se integre con toda su cuenta de PagerDuty mediante una clave de API, lo que permite capacidades de gestión de incidentes más amplias.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `PAGERDUTY_ACCOUNT_INTEGRATION` para destinos a nivel de cuenta de PagerDuty.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de la cuenta de PagerDuty.
`destination.auth`	Objeto	(Obligatorio) Configuración de autenticación que contiene la clave de API de la cuenta de PagerDuty.
`destination.auth.type`	Enumeración	(Obligatorio) Debe ser `TOKEN` para integraciones de cuentas de PagerDuty.
`destination.auth.basic`	Objeto	(Obligatorio) Contiene el token de API y el prefijo para la autenticación de la cuenta de PagerDuty.
`destination.auth.basic.token`	Cadena	(Obligatorio) La clave de API de la cuenta de PagerDuty obtenida de la configuración de su cuenta de PagerDuty.
`destination.auth.basic.prefix`	Cadena	(Obligatorio) Debe ser `"Token token="` para integraciones de cuentas de PagerDuty.
`destination.properties`	matriz de objetos	(Opcional) Propiedades de configuración para la integración de la cuenta. Propiedad común: `two_way_integration` establecida en "true" para la comunicación bidireccional.

Consulta de ejemplo:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destination: {
      type: PAGERDUTY_ACCOUNT_INTEGRATION
      name: "Global PagerDuty Account"
      auth: {
        type: TOKEN
        basic: { token: YOUR_API_KEY, prefix: "Token token=" }
      }
      properties: [{ key: "two_way_integration", value: "true" }]
    }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Crear un destino de Slack entre cuentas en New Relic requiere autenticación OAuth entre NerdGraph API y Slack. Los siguientes pasos muestran cómo generar la URL de autenticación y completar la configuración.

Generar la URL de OAuth

Abra el NerdGraph Explorer y pegue la siguiente consulta en el editor de consultas. Esta consulta genera una URL única de OAuth de Slack para su organización.

{
  actor {
    organization {
      aiNotifications {
        oAuthUrl(type: SLACK) {
          url
          transactionId
          error {
            description
            details
            type
          }
        }
      }
    }
  }
}

Haga clic en Play (Execute Query) en la parte superior del explorador.

Acceda al enlace de autenticación

Una vez que se ejecute la consulta, verá una respuesta JSON en el lado derecho de la pantalla que contiene una URL.
Localice el campo url en la respuesta.
Copie la cadena de URL completa (todo lo que está dentro de las comillas).
Abra una nueva pestaña en su navegador y pegue la URL.

Completar la autorización de Slack

El enlace lo lleva a una página de autorización de Slack.
Si se le solicita, inicie sesión en el espacio de trabajo de Slack que desea conectar.
Revise los permisos solicitados por New Relic.
Para autorizar la conexión, haga clic en Allow.
Debería ser redirigido a una página de "Éxito" de New Relic.

Verifique el destino

Después de una autenticación OAuth exitosa, el destino se crea automáticamente a nivel de organización, lo que lo hace disponible en todas las cuentas de su organización.

Navegue hasta one.newrelic.com > Alerts > Destinations.
En la lista Destinations, ahora debería ver una nueva entrada para el espacio de trabajo de Slack que acaba de autenticar.

Utilice la mutación aiNotificationsCreateDestination para crear un destino de ServiceNow que se integre con su instancia de ServiceNow para crear y gestionar incidentes desde las alertas de New Relic.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `SERVICE_NOW` para destinos de ServiceNow.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de ServiceNow.
`destination.auth`	Objeto	(Obligatorio) Configuración de autenticación para conectarse a su instancia de ServiceNow.
`destination.auth.type`	Enumeración	(Obligatorio) Debe ser `BASIC` para integraciones de ServiceNow que utilizan autenticación de nombre de usuario y contraseña.
`destination.auth.basic`	Objeto	(Obligatorio) Contiene las credenciales de autenticación de ServiceNow (nombre de usuario y contraseña).
`destination.auth.basic.user`	Cadena	(Obligatorio) Su nombre de usuario o dirección de correo electrónico de la cuenta de ServiceNow.
`destination.auth.basic.password`	Cadena	(Obligatorio) La contraseña de su cuenta de ServiceNow. Considere utilizar una cuenta de servicio para mayor seguridad.
`destination.properties`	matriz de objetos	(Obligatorio) Propiedades de configuración, incluidas la URL de la instancia de ServiceNow y las opciones de integración.
`destination.properties[].key: "url"`	Cadena	(Obligatorio) Debe incluir una propiedad con la clave "url" y el valor establecido en la URL de su instancia de ServiceNow (por ejemplo, "https://yourcompany.service-now.com").
`destination.properties[].key: "two_way_integration"`	Cadena	(Opcional) Establecer en "true" para habilitar la integración bidireccional entre New Relic y ServiceNow.

Consulta de ejemplo:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

Utilice la mutación aiNotificationsCreateDestination para crear un destino de AWS EventBridge que envíe eventos de alertas de New Relic a su AWS EventBridge para su posterior procesamiento y enrutamiento dentro de su ecosistema de AWS.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde se creará el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination.type`	Enumeración	(Obligatorio) Debe ser `EVENT_BRIDGE` para destinos de AWS EventBridge.
`destination.name`	Cadena	(Obligatorio) Un nombre descriptivo para el destino de AWS EventBridge.
`destination.auth`	Objeto	(Obligatorio) Configuración de autenticación para conectarse a AWS EventBridge mediante credenciales de IAM.
`destination.auth.type`	Enumeración	(Obligatorio) Debe ser `BASIC` para las integraciones de AWS EventBridge que utilizan credenciales de usuario de IAM.
`destination.auth.basic`	Objeto	(Obligatorio) Contiene las credenciales de autenticación de AWS IAM (ID de clave de acceso y clave de acceso secreta).
`destination.auth.basic.user`	Cadena	(Obligatorio) Su ID de clave de acceso de AWS IAM. Asegúrese de que el usuario de IAM tenga permisos de EventBridge.
`destination.auth.basic.password`	Cadena	(Obligatorio) Su clave de acceso secreta de AWS IAM. Almacene esto de forma segura y considere usar roles de IAM cuando sea posible.
`destination.properties`	matriz de objetos	(Obligatorio) Propiedades de configuración que incluyen el ID de la cuenta de AWS y la región para EventBridge.
`destination.properties[].key: "AWSAccountId"`	Cadena	(Obligatorio) Debe incluir una propiedad con la clave "AWSAccountId" y el valor establecido en su ID de cuenta de AWS (número de 12 dígitos).
`destination.properties[].key: "AWSRegion"`	Cadena	(Obligatorio) Debe incluir una propiedad con la clave "AWSRegion" y el valor establecido en su región de AWS (p. ej., "us-east-1", "eu-west-1").

Consulta de ejemplo:

mutation {
  aiNotificationsCreateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    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
      scope {
        id
        type
      }
    }
  }
}

Probar un destino entre cuentas

Puede probar cross account destinations antes o después de la creación. Debe proporcionar el objeto de alcance.

Use la mutación aiNotificationsTestDestination para probar una configuración de destino antes de crearla. Esto le permite validar la configuración y las credenciales sin crear realmente el destino.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance de la prueba. Use `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destination`	Objeto	(Obligatorio) El objeto de configuración de destino a probar, incluyendo tipo, nombre, autenticación y propiedades.
`destination.type`	Enumeración	(Obligatorio) El tipo de destino a probar. Opciones: `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.
`destination.name`	Cadena	(Obligatorio) Un nombre para la configuración de destino que se está probando.
`destination.auth`	Objeto	(Opcional) Configuración de autenticación para destinos que requieren credenciales. Requerido para los destinos WEBHOOK, PAGERDUTY, JIRA, SERVICE_NOW y EVENT_BRIDGE.
`destination.properties`	matriz de objetos	(Obligatorio) Pares clave-valor que configuran ajustes específicos del destino, como URLs, direcciones de correo electrónico u opciones de integración.

Consulta de ejemplo:

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

Use la mutación aiNotificationsTestDestinationById para probar un destino existente por su ID. Esto verifica que el destino está configurado correctamente y puede entregar notificaciones con éxito.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde existe el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destinationId`	Cadena	(Obligatorio) El identificador único del destino existente que desea probar. Este ID se devuelve al crear un destino o se puede encontrar al listar los destinos.

Consulta de ejemplo:

mutation {
  aiNotificationsTestDestinationById(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    error {
      details
    }
    details
    result
  }
}

Listar y filtrar destinos

La consulta destinations le permite paginar todos sus destinos tanto a nivel de cuenta como de organización. También permite la funcionalidad de filtrado para cross account destinations.

Use la consulta actor.organization.aiNotifications.destinations para recuperar todos los destinos a nivel de organización, incluidos cross account destinations que se pueden usar en todas las cuentas de la organización.

parámetro de entrada

Esta consulta utiliza el contexto actor.organization de GraphQL y no requiere parámetros de entrada explícitos. La consulta devuelve automáticamente todos los destinos accesibles a nivel de organización.

Campo de consulta	Tipo de datos	Descripción
`actor`	Objeto	Objeto de consulta raíz que representa el contexto del usuario autenticado.
`organization`	Objeto	Contexto de la organización que proporciona acceso a recursos a nivel de organización y cross account destinations.
`aiNotifications`	Objeto	Contexto del servicio de notificaciones de IA para acceder a recursos relacionados con las notificaciones.
`destinations`	Objeto	Campo de consulta que devuelve todos los destinos accesibles a nivel de organización, incluido cross account destinations.

Consulta de ejemplo:

{
  actor {
    organization {
      aiNotifications {
        destinations {
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          error {
            details
          }
        }
      }
    }
  }
}

Utilice la consulta actor.account.aiNotifications.destinations para recuperar todos los destinos accesibles para una cuenta específica, incluidos tanto los destinos a nivel de cuenta como los cross account destinations disponibles para esa cuenta.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para el cual recuperar destinos. Esta cuenta debe ser accesible para el usuario autenticado.

Campos de consulta

Campo de consulta	Tipo de datos	Descripción
`actor`	Objeto	Objeto de consulta raíz que representa el contexto del usuario autenticado.
`account`	Objeto	Contexto de la cuenta que proporciona acceso a recursos específicos de la cuenta y cross account destinations disponibles para esta cuenta.
`aiNotifications`	Objeto	Contexto del servicio de notificaciones de IA para acceder a recursos relacionados con las notificaciones.
`destinations`	Objeto	Campo de consulta que devuelve todos los destinos accesibles para la cuenta especificada (tanto a nivel de cuenta como a nivel de organización).

Consulta de ejemplo:

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

Utilice la paginación por cursor para navegar eficientemente por grandes conjuntos de destinos. Debe solicitar el campo nextCursor en su consulta para habilitar la paginación.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para el cual recuperar destinos. Esta cuenta debe ser accesible para el usuario autenticado.
`destinations.cursor`	Cadena	(Opcional) Cursor para paginación. Utilice la cadena vacía `""` para la primera solicitud, luego utilice el valor `nextCursor` de las respuestas anteriores para obtener las páginas siguientes.

Flujo de trabajo de paginación

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

Este es un ejemplo para una cuenta (la misma lógica se aplica a la organización):

{
  actor {
    account(id: YOUR_ACCOUNT_ID) {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          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",
                "scope": {
                  "type": "ACCOUNT",
                  "id": "312312"
                }
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name",
                "scope": {
                  "type": "ACCOUNT",
                  "id": "312312"
                }
              }
            ],
            "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: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Aquí hay otro ejemplo para una organización

{
  actor {
    organization {
      aiNotifications {
        destinations(cursor: "") {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

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

{
  "data": {
    "actor": {
      "organization": {
        "aiNotifications": {
          "destinations": {
            "nextCursor": "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM=",
            "entities": [
              {
                "id": "01c0cbe7-3d70-47c1-99e0-adf906eed6c2",
                "name": "Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              },
              {
                "id": "05db0207-c137-4985-8cb5-f21e7e57b8cc",
                "name": "Another Destination Name",
                "scope": {
                  "type": "ORGANIZATION",
                  "id": "01ddcbe7-3d70-47c1-99e0-adf906eed6c2"
                }
              }
            ],
            "totalCount": 807
          }
        }
      }
    }
  }
}

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

{
  actor {
    organization {
      aiNotifications {
        destinations(
          cursor: "/8o0y2qiR54m6thkdgHgwg==:jZTXDFKbTkhKwvMx+CtsPVM="
        ) {
          nextCursor
          entities {
            id
            name
            scope {
              id
              type
            }
          }
          totalCount
        }
      }
    }
  }
}

Utilice el filtrado por nombre para buscar destinos por sus nombres. El filtro de nombre admite tanto coincidencias exactas como parciales, y no distingue entre mayúsculas y minúsculas.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para el cual recuperar destinos. Esta cuenta debe ser accesible para el usuario autenticado.
`destinations.filters`	Objeto	(Obligatorio) Objeto de criterios de filtro para acotar los resultados.
`destinations.filters.name`	Cadena	(Obligatorio) Filtrar por nombre de destino. Admite coincidencias parciales y no distingue entre mayúsculas y minúsculas. Devuelve los destinos cuyos nombres contienen la cadena especificada.

Consulta de ejemplo:

Este ejemplo encuentra destinos con "DevOps" en el nombre:

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

Utilice el filtrado por ID para recuperar un destino específico mediante su identificador único. Este filtro devuelve únicamente coincidencias exactas.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para el cual recuperar destinos. Esta cuenta debe ser accesible para el usuario autenticado.
`destinations.filters`	Objeto	(Obligatorio) Objeto de criterios de filtro para especificar el destino exacto a recuperar.
`destinations.filters.id`	Cadena	(Obligatorio) Filtrar por ID de destino. Devuelve el destino con el ID que coincide exactamente, si existe y es accesible para la cuenta especificada.

Consulta de ejemplo:

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

Utilice el filtrado por tipo para recuperar destinos de un tipo específico. Este filtro devuelve todos los destinos que coinciden con el tipo de destino especificado.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para el cual recuperar destinos. Esta cuenta debe ser accesible para el usuario autenticado.
`destinations.filters`	Objeto	(Obligatorio) Objeto de criterios de filtro para acotar los resultados por tipo de destino.
`destinations.filters.type`	Enumeración	(Obligatorio) Filtrar por tipo de destino. Valores válidos: `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.

Consulta de ejemplo:

La siguiente consulta devolverá todos los destinos de correo electrónico en la cuenta seleccionada:

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

Actualizar un destino entre cuentas

Para actualizar un cross-account destination existente, debe proporcionar el alcance de la organización y el ID de destino.

Utilice la mutación aiNotificationsUpdateDestination para actualizar un cross-account destination existente.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde existe el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destinationId`	Cadena	(Obligatorio) El identificador único del destino que desea actualizar. Este ID se devuelve al crear un destino o se puede encontrar al listar los destinos.
`destination`	Objeto	(Obligatorio) El objeto de actualización de destino que contiene los campos que desea modificar. Incluya solo los campos que desea cambiar.
`destination.name`	Cadena	(Opcional) Nombre actualizado para el destino.
`destination.auth`	Objeto	(Opcional) Configuración de autenticación actualizada para destinos que requieren credenciales.
`destination.properties`	matriz de objetos	(Opcional) Pares clave-valor actualizados para configuraciones específicas del destino, como URL, direcciones de correo electrónico u opciones de integración.

Consulta de ejemplo:

mutation {
  aiNotificationsUpdateDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
    destination: { name: "Updated destination Name" }
  ) {
    destination {
      id
      name
      scope {
        id
        type
      }
    }
  }
}

Eliminar un destino entre cuentas

Elimine cross account destinations proporcionando el scope y el destination ID.

Importante

Antes de eliminar: Si recibe un error que indica "El tipo de entidad canal está en uso", primero debe eliminar todos los canales asociados con el destino. Busque los canales asociados y elimínelos individualmente antes de proceder con la eliminación del destino.

Utilice la mutación aiNotificationsDeleteDestination para eliminar permanentemente un cross account destination.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`scope`	Objeto	(Obligatorio) Define el alcance donde existe el destino. Utilice `type: ORGANIZATION` para cross account destinations o `type: ACCOUNT` para destinos a nivel de cuenta.
`scope.id`	Cadena	(Obligatorio) El ID de la organización para cross account destinations o el ID de la cuenta para destinos a nivel de cuenta.
`scope.type`	Enumeración	(Obligatorio) Debe ser `ORGANIZATION` para cross account destinations o `ACCOUNT` para destinos a nivel de cuenta.
`destinationId`	Cadena	(Obligatorio) El identificador único del destino que desea eliminar. Este ID se devuelve al crear un destino o se puede encontrar al listar destinos.

Consulta de ejemplo:

mutation {
  aiNotificationsDeleteDestination(
    scope: { id: YOUR_ACCOUNT_ID, type: ACCOUNT }
    destinationId: YOUR_DESTINATION_ID
  ) {
    ids
    error {
      details
    }
  }
}

Utilice esta consulta para encontrar todos los canales que utilizan actualmente un destino específico. Esto es útil antes de eliminar un destino para garantizar que ningún canal activo se vea afectado.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`account.id`	Cadena/ID	(Obligatorio) El ID de cuenta específico para buscar canales. Esta cuenta debe ser accesible para el usuario autenticado.
`channels.filters`	Objeto	(Obligatorio) Objeto de criterios de filtro para encontrar canales que utilizan un destino específico.
`channels.filters.destinationId`	Cadena	(Obligatorio) El identificador único del destino a buscar. Devuelve todos los canales que están configurados para usar este destino.

Consulta de ejemplo:

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

Utilice la mutación aiNotificationsDeleteChannel para eliminar canales que utilizan un destino. Debe eliminar todos los canales asociados antes de poder eliminar el destino en sí.

parámetro de entrada

Nombre del parámetro	Tipo de datos	Descripción
`accountId`	Cadena/ID	(Obligatorio) El ID de la cuenta donde existe el canal. Esta cuenta debe ser accesible para el usuario autenticado.
`channelId`	Cadena	(Obligatorio) El identificador único del canal que desea eliminar. Este ID se puede encontrar consultando los canales usando el ID de destino.

Consulta de ejemplo:

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

Próximos pasos

Descripción general de los destinos entre cuentas

Aprenda sobre los conceptos y características clave de cross account destinations.

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

avance

Crear un destino .css-21sua1{background:none;border:none;width:0;padding:0;}

Importante

Crear destino de correo electrónico

Crear destino de webhook

Crear destino de nivel de servicio de PagerDuty

Crear destino de PagerDuty a nivel de cuenta

Crear destino de Slack

Crear destino de ServiceNow

Crear destino de AWS EventBridge

Probar un destino entre cuentas

Probar la configuración del destino

Probar destino existente por ID

Listar y filtrar destinos

Listar todos los destinos entre cuentas para una organización

Listar destinos para una cuenta específica

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

Filtrar destinos por nombre

Filtrar destinos por ID

Filtrar destinos por tipo

Actualizar un destino entre cuentas

Actualizar un destino entre cuentas

Eliminar un destino entre cuentas

Importante

Eliminar un destino entre cuentas

Buscar canales usando un destino

Eliminar canales asociados

Próximos pasos

Descripción general de los destinos entre cuentas

Crear un destino