Gerenciar destinos entre contas

visualização

Ainda estamos trabalhando nesse recurso, mas adoraríamos que você experimentasse!

Atualmente, esse recurso é fornecido como parte de um programa de visualização de acordo com nossas políticas de pré-lançamento.

Use o NerdGraph API para criar, testar, listar, atualizar e excluir cross account destinations. Cross account destinations permitem centralizar o gerenciamento de notificações no nível da organização.

Crie um destino

Para criar um destino, diferentes entradas devem ser fornecidas para cada tipo de destino.

Importante

Você deve fornecer um objeto de escopo identificando onde o destino será criado. O objeto de escopo requer:

id: O ID da Conta ou Organização.
type: O tipo de escopo (Conta ou Organização).
Uma propriedade opcional two_way_integration está disponível para integrações que permitem integração bidirecional.

Use a mutação aiNotificationsCreateDestination para criar um destino Jira que se integre à sua instância do Atlassian Jira para criar e gerenciar problemas a partir de alertas do New Relic.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `JIRA` para destinos do Atlassian Jira.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino do Jira.
`destination.auth`	Objeto	(Obrigatório) Configuração de autenticação para conectar à sua instância do Jira.
`destination.auth.type`	Enum	(Obrigatório) Deve ser `BASIC` para integrações do Jira usando autenticação por nome de usuário e senha/token de API.
`destination.auth.basic`	Objeto	(Obrigatório) Contém as credenciais de autenticação do Jira (e-mail e senha/token de API).
`destination.auth.basic.user`	Corda	(Obrigatório) O endereço de e-mail da sua conta do Jira.
`destination.auth.basic.password`	Corda	(Obrigatório) Sua senha da conta do Jira ou token de API. Por segurança, use um token de API em vez da senha da sua conta.
`destination.properties`	matriz de objetos	(Obrigatório) Propriedades de configuração, incluindo a URL da instância do Jira e opções de integração.
`destination.properties[].key: "url"`	Corda	(Obrigatório) Deve incluir uma propriedade com a chave "url" e valor definido como a URL da sua instância do Jira (por exemplo, "https://yourcompany.atlassian.net").
`destination.properties[].key: "two_way_integration"`	Corda	(Opcional) Defina como "true" para habilitar a integração bidirecional entre o New Relic e o Jira.

Exemplo de consulta para uma conta e organização:

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

Exemplo de consulta para uma organização:

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

Use a mutação aiNotificationsCreateDestination para criar um destino de e-mail para enviar alertas de notificação para endereços de e-mail.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `EMAIL` para destinos de e-mail.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino de e-mail.
`destination.properties`	matriz de objetos	(Obrigatório) Pares chave-valor contendo a configuração de e-mail. Deve incluir uma chave `email` com o endereço de e-mail de destino como valor.

Consulta de exemplo:

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

Use a mutação aiNotificationsCreateDestination para criar um destino de webhook para enviar requisições HTTP POST para endpoints externos quando alertas forem acionados.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `WEBHOOK` para destinos de webhook.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino do webhook.
`destination.auth`	Objeto	(Opcional) Configuração de autenticação. Necessário apenas quando o endpoint do webhook requer autenticação.
`destination.auth.type`	Enum	(Obrigatório quando a autenticação é fornecida) Método de autenticação. Opções: `BASIC`, `TOKEN`.
`destination.auth.basic`	Objeto	(Obrigatório para autenticação BASIC e TOKEN) Contém credenciais de autenticação, como nome de usuário/senha ou informações de token.
`destination.properties`	matriz de objetos	(Obrigatório) Pares chave-valor contendo a configuração do webhook. Deve incluir a chave `url` com a URL do endpoint do webhook. `two_way_integration` opcional para comunicação bidirecional.

Consulta de exemplo:

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 a mutação aiNotificationsCreateDestination para criar um destino de nível de serviço do PagerDuty que se integra a um serviço específico do PagerDuty usando uma chave de integração.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `PAGERDUTY_SERVICE_INTEGRATION` para destinos de nível de serviço do PagerDuty.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino de serviço do PagerDuty.
`destination.auth`	Objeto	(Obrigatório) Configuração de autenticação contendo a chave de integração do PagerDuty.
`destination.auth.type`	Enum	(Obrigatório) Deve ser `TOKEN` para integrações de serviço do PagerDuty.
`destination.auth.basic`	Objeto	(Obrigatório) Contém o token de integração e o prefixo para autenticação do PagerDuty.
`destination.auth.basic.token`	Corda	(Obrigatório) A chave de integração do PagerDuty obtida na configuração do seu serviço PagerDuty.
`destination.auth.basic.prefix`	Corda	(Obrigatório) Deve ser `"Token token="` para integrações de serviço do PagerDuty.
`destination.properties`	matriz de objetos	(Opcional) Propriedades de configuração adicionais. Pode ser um array vazio para integração básica de serviço.

Consulta de exemplo:

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

Use a mutação aiNotificationsCreateDestination para criar um destino no nível da conta do PagerDuty que se integra com toda a sua conta do PagerDuty usando uma chave de API, permitindo recursos mais amplos de gerenciamento de incidentes.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `PAGERDUTY_ACCOUNT_INTEGRATION` para destinos de nível de conta do PagerDuty.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino da conta PagerDuty.
`destination.auth`	Objeto	(Obrigatório) Configuração de autenticação contendo a chave de API da conta PagerDuty.
`destination.auth.type`	Enum	(Obrigatório) Deve ser `TOKEN` para integrações de conta do PagerDuty.
`destination.auth.basic`	Objeto	(Obrigatório) Contém o token de API e o prefixo para autenticação da conta PagerDuty.
`destination.auth.basic.token`	Corda	(Obrigatório) A chave de API da conta PagerDuty obtida nas configurações da sua conta PagerDuty.
`destination.auth.basic.prefix`	Corda	(Obrigatório) Deve ser `"Token token="` para integrações de conta do PagerDuty.
`destination.properties`	matriz de objetos	(Opcional) Propriedades de configuração para a integração da conta. Propriedade comum: `two_way_integration` definida como "true" para comunicação bidirecional.

Consulta de exemplo:

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

Criar um destino do Slack entre contas no New Relic requer autenticação OAuth entre o NerdGraph API e o Slack. Os passos a seguir mostram como gerar a URL de autenticação e concluir a configuração.

Gerar a URL do OAuth

Abra o NerdGraph Explorer e cole a seguinte consulta no editor de consultas. Esta consulta gera uma URL OAuth do Slack exclusiva para sua organização.

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

Clique em Play (Execute Query) na parte superior do explorador.

Acesse o link de autenticação

Assim que a consulta for executada, você verá uma resposta JSON no lado direito da tela contendo uma URL.
Localize o campo url na resposta.
Copie toda a string da URL (tudo dentro das aspas).
Abra uma nova aba no seu navegador e cole a URL.

Concluir autorização do Slack

O link leva você para uma página de autorização do Slack.
Se solicitado, faça login no workspace do Slack que você deseja conectar.
Revise as permissões solicitadas pela New Relic.
Para autorizar a conexão, clique em Allow.
Você deve ser redirecionado de volta para uma página de "Sucesso" da New Relic.

Verifique o destino

Após a autenticação OAuth bem-sucedida, o destino é criado automaticamente no nível da organização, tornando-o disponível em todas as contas da sua organização.

Navegue até one.newrelic.com > Alerts > Destinations.
Na lista Destinations, agora você deve ver uma nova entrada para o workspace do Slack que você acabou de autenticar.

Use a mutação aiNotificationsCreateDestination para criar um destino do ServiceNow que se integra à sua instância do ServiceNow para criar e gerenciar incidentes a partir de alertas do New Relic.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `SERVICE_NOW` para destinos do ServiceNow.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino do ServiceNow.
`destination.auth`	Objeto	(Obrigatório) Configuração de autenticação para conectar à sua instância do ServiceNow.
`destination.auth.type`	Enum	(Obrigatório) Deve ser `BASIC` para integrações do ServiceNow usando autenticação de nome de usuário e senha.
`destination.auth.basic`	Objeto	(Obrigatório) Contém as credenciais de autenticação do ServiceNow (nome de usuário e senha).
`destination.auth.basic.user`	Corda	(Obrigatório) Seu nome de usuário ou endereço de e-mail da conta ServiceNow.
`destination.auth.basic.password`	Corda	(Obrigatório) Sua senha da conta ServiceNow. Considere usar uma conta de serviço para maior segurança.
`destination.properties`	matriz de objetos	(Obrigatório) Propriedades de configuração, incluindo a URL da instância do ServiceNow e opções de integração.
`destination.properties[].key: "url"`	Corda	(Obrigatório) Deve incluir uma propriedade com a chave "url" e valor definido como o URL da sua instância ServiceNow (por exemplo, "https://yourcompany.service-now.com").
`destination.properties[].key: "two_way_integration"`	Corda	(Opcional) Defina como "true" para habilitar a integração bidirecional entre New Relic e ServiceNow.

Consulta de exemplo:

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

Use a mutação aiNotificationsCreateDestination para criar um destino do AWS EventBridge que envia eventos de alerta do New Relic para o seu AWS EventBridge para processamento e roteamento posteriores em seu ecossistema AWS.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino será criado. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos de nível de conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination.type`	Enum	(Obrigatório) Deve ser `EVENT_BRIDGE` para destinos do AWS EventBridge.
`destination.name`	Corda	(Obrigatório) Um nome descritivo para o destino do AWS EventBridge.
`destination.auth`	Objeto	(Obrigatório) Configuração de autenticação para conectar ao AWS EventBridge usando credenciais do IAM.
`destination.auth.type`	Enum	(Obrigatório) Deve ser `BASIC` para integrações do AWS EventBridge usando credenciais de usuário do IAM.
`destination.auth.basic`	Objeto	(Obrigatório) Contém as credenciais de autenticação do AWS IAM (ID da chave de acesso e chave de acesso secreta).
`destination.auth.basic.user`	Corda	(Obrigatório) Seu ID da chave de acesso do AWS IAM. Certifique-se de que o usuário do IAM tenha permissões do EventBridge.
`destination.auth.basic.password`	Corda	(Obrigatório) Sua chave de acesso secreta do AWS IAM. Armazene isso de forma segura e considere usar funções do IAM quando possível.
`destination.properties`	matriz de objetos	(Obrigatório) Propriedades de configuração, incluindo o ID da conta da AWS e a região para o EventBridge.
`destination.properties[].key: "AWSAccountId"`	Corda	(Obrigatório) Deve incluir uma propriedade com a chave "AWSAccountId" e valor definido como o ID da sua conta AWS (número de 12 dígitos).
`destination.properties[].key: "AWSRegion"`	Corda	(Obrigatório) Deve incluir uma propriedade com a chave "AWSRegion" e valor definido como sua região da AWS (por exemplo, "us-east-1", "eu-west-1").

Consulta de exemplo:

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

Testar um destino entre contas

Você pode testar cross account destinations antes ou depois da criação. Você deve fornecer o objeto de escopo.

Use a mutação aiNotificationsTestDestination para testar uma configuração de destino antes de criá-la. Isso permite que você valide as configurações e credenciais sem realmente criar o destino.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo do teste. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos no nível da conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destination`	Objeto	(Obrigatório) O objeto de configuração de destino a ser testado, incluindo tipo, nome, autenticação e propriedades.
`destination.type`	Enum	(Obrigatório) O tipo de destino para testar. Opções: `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.
`destination.name`	Corda	(Obrigatório) Um nome para a configuração de destino sendo testada.
`destination.auth`	Objeto	(Opcional) Configuração de autenticação para destinos que requerem credenciais. Necessário para destinos WEBHOOK, PAGERDUTY, JIRA, SERVICE_NOW e EVENT_BRIDGE.
`destination.properties`	matriz de objetos	(Obrigatório) Pares chave-valor que definem configurações específicas do destino, como URLs, endereços de e-mail ou opções de integração.

Consulta de exemplo:

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 a mutação aiNotificationsTestDestinationById para testar um destino existente pelo seu ID. Isso verifica se o destino está configurado corretamente e pode entregar notificações com sucesso.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino existe. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos no nível da conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destinationId`	Corda	(Obrigatório) O identificador único do destino existente que você deseja testar. Este ID é retornado ao criar um destino ou pode ser encontrado ao listar destinos.

Consulta de exemplo:

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

Listar e filtrar destinos

A consulta destinations permite paginar por todos os seus destinos nos níveis de conta e organização. Também permite a funcionalidade de filtragem para cross account destinations.

Use a consulta actor.organization.aiNotifications.destinations para recuperar todos os destinos no nível da organização, incluindo cross account destinations que podem ser usados em todas as contas da organização.

Parâmetro de entrada

Esta consulta usa o contexto actor.organization do GraphQL e não requer parâmetros de entrada explícitos. A consulta retorna automaticamente todos os destinos acessíveis no nível da organização.

Campo de consulta	Tipo de dados	Descrição
`actor`	Objeto	Objeto de consulta raiz representando o contexto do usuário autenticado.
`organization`	Objeto	Contexto da organização que fornece acesso a recursos no nível da organização e cross account destinations.
`aiNotifications`	Objeto	Contexto de serviço de Notificações de IA para acessar recursos relacionados a notificações.
`destinations`	Objeto	Campo de consulta que retorna todos os destinos acessíveis no nível da organização, incluindo cross account destinations.

Consulta de exemplo:

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

Use a consulta actor.account.aiNotifications.destinations para recuperar todos os destinos acessíveis a uma conta específica, incluindo tanto destinos com escopo de conta quanto cross account destinations disponíveis para essa conta.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para o qual recuperar destinos. Esta conta deve estar acessível ao usuário autenticado.

Campos de consulta

Campo de consulta	Tipo de dados	Descrição
`actor`	Objeto	Objeto de consulta raiz representando o contexto do usuário autenticado.
`account`	Objeto	Contexto da conta que fornece acesso a recursos específicos da conta e cross account destinations disponíveis para esta conta.
`aiNotifications`	Objeto	Contexto de serviço de Notificações de IA para acessar recursos relacionados a notificações.
`destinations`	Objeto	Campo de consulta que retorna todos os destinos acessíveis à conta especificada (tanto no escopo da conta quanto no escopo da organização).

Consulta de exemplo:

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

Use a paginação por cursor para navegar de forma eficiente por grandes conjuntos de destinos. Você deve solicitar o campo nextCursor em sua consulta para habilitar a paginação.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para o qual recuperar destinos. Esta conta deve estar acessível ao usuário autenticado.
`destinations.cursor`	Corda	(Opcional) Cursor para paginação. Use a string vazia `""` para a primeira requisição, depois use o valor `nextCursor` das respostas anteriores para obter as páginas subsequentes.

Fluxo de trabalho de paginação

Com a paginação por cursor, você continua fazendo requisições pelo conjunto de resultados até que o nextCursor retornado da resposta esteja vazio. Isso significa que você chegou ao final dos seus resultados.

Aqui está um exemplo para uma conta (a mesma lógica se aplica à organização):

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

O código acima retorna um 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
          }
        }
      }
    }
  }
}

Portanto, em sua solicitação subsequente, forneça o cursor assim, até que ele fique vazio:

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

Aqui está outro exemplo para uma organização

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

O código acima retorna um 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
          }
        }
      }
    }
  }
}

Portanto, em sua solicitação subsequente, forneça o cursor assim, até que ele fique vazio:

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

Use a filtragem por nome para pesquisar destinos pelos nomes. O filtro de nome suporta correspondências exatas e parciais, e não diferencia maiúsculas de minúsculas.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para o qual recuperar destinos. Esta conta deve estar acessível ao usuário autenticado.
`destinations.filters`	Objeto	(Obrigatório) Objeto de critérios de filtro para restringir os resultados.
`destinations.filters.name`	Corda	(Obrigatório) Filtrar por nome do destino. Suporta correspondências parciais e não diferencia maiúsculas de minúsculas. Retorna destinos cujos nomes contêm a string especificada.

Consulta de exemplo:

Este exemplo encontra destinos com "DevOps" no nome:

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

Use a filtragem por ID para recuperar um destino específico por seu identificador único. Este filtro retorna apenas correspondências exatas.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para o qual recuperar destinos. Esta conta deve estar acessível ao usuário autenticado.
`destinations.filters`	Objeto	(Obrigatório) Objeto de critérios de filtro para especificar o destino exato a ser recuperado.
`destinations.filters.id`	Corda	(Obrigatório) Filtrar por ID de destino. Retorna o destino com o ID de correspondência exata, se existir e for acessível à conta especificada.

Consulta de exemplo:

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

Use a filtragem por tipo para recuperar destinos de um tipo específico. Este filtro retorna todos os destinos que correspondem ao tipo de destino especificado.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para o qual recuperar destinos. Esta conta deve estar acessível ao usuário autenticado.
`destinations.filters`	Objeto	(Obrigatório) Objeto de critérios de filtro para restringir os resultados por tipo de destino.
`destinations.filters.type`	Enum	(Obrigatório) Filtrar por tipo de destino. Valores válidos: `EMAIL`, `WEBHOOK`, `PAGERDUTY_SERVICE_INTEGRATION`, `PAGERDUTY_ACCOUNT_INTEGRATION`, `SLACK`, `JIRA`, `SERVICE_NOW`, `EVENT_BRIDGE`.

Consulta de exemplo:

A consulta a seguir retornará todos os destinos de e-mail na conta escolhida:

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

Atualizar um destino entre contas

Para atualizar um cross-account destination existente, você deve fornecer o escopo da organização e o ID de destino.

Use a mutação aiNotificationsUpdateDestination para atualizar um cross-account destination existente.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino existe. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos no nível da conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destinationId`	Corda	(Obrigatório) O identificador exclusivo do destino que você deseja atualizar. Este ID é retornado ao criar um destino ou pode ser encontrado ao listar destinos.
`destination`	Objeto	(Obrigatório) O objeto de atualização de destino contendo os campos que você deseja modificar. Inclua apenas os campos que você deseja alterar.
`destination.name`	Corda	(Opcional) Nome atualizado para o destino.
`destination.auth`	Objeto	(Opcional) Configuração de autenticação atualizada para destinos que requerem credenciais.
`destination.properties`	matriz de objetos	(Opcional) Pares de chave-valor atualizados para configurações específicas de destino, como URLs, endereços de e-mail ou opções de integração.

Consulta de exemplo:

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

Excluir um destino entre contas

Exclua cross account destinations fornecendo o scope e o destination ID.

Importante

Antes de excluir: Se você receber um erro informando "O tipo de entidade canal está em uso", você deve primeiro excluir todos os canais associados ao destino. Encontre os canais associados e exclua-os individualmente antes de prosseguir com a exclusão do destino.

Use a mutação aiNotificationsDeleteDestination para excluir permanentemente um cross account destination.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`scope`	Objeto	(Obrigatório) Define o escopo onde o destino existe. Use `type: ORGANIZATION` para cross account destinations ou `type: ACCOUNT` para destinos no nível da conta.
`scope.id`	Corda	(Obrigatório) O ID da organização para cross account destinations ou o ID da conta para destinos de nível de conta.
`scope.type`	Enum	(Obrigatório) Deve ser `ORGANIZATION` para cross account destinations ou `ACCOUNT` para destinos no nível da conta.
`destinationId`	Corda	(Obrigatório) O identificador exclusivo do destino que você deseja excluir. Este ID é retornado ao criar um destino ou pode ser encontrado ao listar destinos.

Consulta de exemplo:

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

Use esta consulta para encontrar todos os canais que estão usando um destino específico. Isso é útil antes de excluir um destino para garantir que nenhum canal ativo seja afetado.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`account.id`	String/ID	(Obrigatório) O ID da conta específica para pesquisar canais. Esta conta deve estar acessível ao usuário autenticado.
`channels.filters`	Objeto	(Obrigatório) Objeto de critérios de filtro para encontrar canais usando um destino específico.
`channels.filters.destinationId`	Corda	(Obrigatório) O identificador exclusivo do destino a ser pesquisado. Retorna todos os canais que estão configurados para usar este destino.

Consulta de exemplo:

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

Use a mutação aiNotificationsDeleteChannel para excluir canais que utilizam um destino. Você deve excluir todos os canais associados antes de poder excluir o próprio destino.

Parâmetro de entrada

Nome do parâmetro	Tipo de dados	Descrição
`accountId`	String/ID	(Obrigatório) O ID da conta onde o canal existe. Esta conta deve estar acessível ao usuário autenticado.
`channelId`	Corda	(Obrigatório) O identificador exclusivo do canal que você deseja excluir. Este ID pode ser encontrado consultando canais usando o ID de destino.

Consulta de exemplo:

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

Próximos passos

Visão geral dos destinos entre contas

Saiba mais sobre os conceitos e principais recursos do cross account destinations.

Esta tradução de máquina é fornecida para sua comodidade.

visualização

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

Importante

Criar destino de e-mail

Criar destino de webhook

Criar destino de nível de serviço do PagerDuty

Criar destino de nível de conta do PagerDuty

Criar destino do Slack

Criar destino ServiceNow

Criar destino do AWS EventBridge

Testar um destino entre contas

Testar configuração de destino

Testar destino existente por ID

Listar e filtrar destinos

Listar todos os destinos entre contas para uma organização

Listar destinos para uma conta específica

Paginando destinos com paginação de cursor

Filtrar destinos por nome

Filtrar destinos por ID

Filtrar destinos por tipo

Atualizar um destino entre contas

Atualizar um destino entre contas

Excluir um destino entre contas

Importante

Excluir um destino entre contas

Encontrar canais usando um destino

Excluir canais associados

Próximos passos

Visão geral dos destinos entre contas

Crie um destino