Tutorial do NerdGraph: Criar, atualizar e revogar URLs dashboard de compartilhamento público

Com o gerenciamento de acesso configurado necessário, você pode criar, gerenciar e revogar URLs de dashboard em tempo real acessíveis publicamente usando consultas e mutações no NerdGraph. Você também pode fazer isso a partir da interface do New Relic.

Cuidado

Se um dashboard compartilhado não for protegido por senha, qualquer pessoa com o URL ativo poderá acessar e visualizar todas as informações que ele contém. Para evitar acesso indesejado, crie URLs protegidas por senha ou habilite a proteção por senha para URLs compartilhadas existentes.

Para criar, atualizar ou revogar uma URL dashboard ativo acessível publicamente do NerdGraph, você precisa do GUID do dashboard que deseja compartilhar.

Vá para one.newrelic.com > Dashboards.
Abra o dashboard que você deseja compartilhar.
Navegue até > Metadata e copie o GUID da entidade do dashboard.

Acesse o explorador da API do NerdGraph.
Construa um gráfico chamado de API usando a mutação dashboardCreateLiveUrl com o seguinte parâmetro:

GUID: Insira o GUID da entidade do dashboard.
Options(opcional) > ttl: Insira o período de tempo em segundos para que o URL fique ativo.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 anos)
- Valor padrão: 2592000 segundos (30 dias)
url: Selecione esta opção para obter o URL dashboard ao vivo na resposta.
Selecione quaisquer outros campos que você deseja na resposta.
Mutação de amostra
```
mutation {
  dashboardCreateLiveUrl(
    options: { ttl: TIME_IN_SECONDS }
    guid: "YOUR_DASHBOARD_GUID"
  ) {
    url
  }
}
```
O URL dashboard ativo aparece na resposta. Este é um URL público, então você pode compartilhá-lo com qualquer pessoa.
Resposta de amostra
```
{
  "data": {
    "dashboardCreateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```
PUBLIC_LINK_ID é o ID do dashboard compartilhado. Você pode usá-lo para atualizar ou revogar o URL dashboard compartilhado através do NerdGraph.
Importante
Qualquer atualização de conteúdo no dashboard da plataforma New Relic é refletida na página dashboard compartilhado.

Para evitar acesso indesejado ao dashboard compartilhado, você pode criar uma URL dashboard ativo com proteção por senha.

Acesse o explorador da API do NerdGraph.
Construa um gráfico chamado de API usando a mutação dashboardCreateLiveUrl com o seguinte parâmetro:

auth > factors > type: Selecione PASSWORD para habilitar a proteção por senha para o URL dashboard ativo.
GUID: Insira o GUID da entidade do dashboard.
Options(opcional) > ttl: Insira o período de tempo em segundos para que o URL fique ativo.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 anos)
- Valor padrão: 2592000 segundos (30 dias)
auth > factors > password > value: Selecione esta opção para obter a senha dashboard ao vivo na resposta.
url: Selecione esta opção para obter o URL dashboard ao vivo na resposta.

Selecione quaisquer outros campos que você deseja na resposta.

Mutação de amostra

mutation {
  dashboardCreateLiveUrl(
    guid: "YOUR_DASHBOARD_GUID"
    options: { ttl: 3600 } # Optional: Set a time-to-live for the URL
    auth: { factors: [{ type: PASSWORD }] }
  ) {
    url
    uuid
    auth {
      factors {
        type
        password {
          value # REQUEST THE PASSWORD VALUE HERE
        }
      }
    }
  }
}

O URL e a senha dashboard ao vivo aparecem na resposta.

Resposta de amostra

{
  "data": {
    "dashboardCreateLiveUrl": {
      "auth": {
        "factors": [
          {
            "password": {
              "value": "pfd-3ZZ46#3a4On5p%&¿"
            },
            "type": "PASSWORD"
          }
        ]
      },
      "url": "https://one.newrelic.com/dashboard/f6c730bf-fced-4890-ad6e-86ab6a6e8159",
      "uuid": "f6c730bf-fced-4890-ad6e-86ab6a6e8159"
    }
  }
}

O uuid é o ID do dashboard compartilhado. Você pode usá-lo para atualizar ou revogar a URL do dashboard compartilhado pelo NerdGraph. Para compartilhar o dashboard com usuários externos, copie a URL e a senha da resposta. As senhas não podem ser recuperadas posteriormente. Se você perdê-la, basta redefinir a senha e compartilhá-la novamente com os usuários. Siga nossas práticas recomendadas de gerenciamento de senhas para gerenciar a senha com segurança.

Certifique-se de ter as permissões para modificar a configuração do dashboard compartilhado.

Para atualizar o período de tempo em que o URL estará ativo:

Acesse o explorador da API do NerdGraph.
Construa um gráfico chamado de API usando a mutação dashboardUpdateLiveUrl com o seguinte parâmetro:

id: Copie o ID do URL dashboard compartilhado e insira-o.
options (opcional) > ttl: Insira o período de tempo em segundos para que o URL fique ativo.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 anos)
- Valor padrão: 2592000 segundos (30 dias)
Mutação de amostra
```
mutation {
  dashboardUpdateLiveUrl(id: "PUBLIC_URL_ID", options: { ttl: TIME_IN_SECONDS })
}
```
A URL aparece na resposta da seguinte maneira. Agora a URL permanecerá ativa pelo período de tempo atualizado.
Resposta de amostra
```
{
  "data": {
    "dashboardUpdateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```

Certifique-se de ter as permissões para modificar a configuração do dashboard compartilhado. Para habilitar a proteção por senha para uma URL de dashboard ao vivo:

Acesse o explorador da API do NerdGraph.
Construa um gráfico chamado de API usando a mutação dashboardUpdateLiveUrlAuth com o seguinte parâmetro:

auth > factors > type: Selecione PASSWORD para habilitar a proteção por senha para o URL dashboard ativo.
id: Copie o ID do URL dashboard compartilhado e insira-o.
auth > factors > password > value: Selecione esta opção para obter a senha dashboard ao vivo na resposta.

Selecione quaisquer outros campos que você deseja na resposta.

Mutação de amostra

mutation {
  dashboardUpdateLiveUrlAuth(
    id: "YOUR_PUBLIC_LINK_UUID"
    auth: { factors: [{ type: PASSWORD }] }
  ) {
    factors {
      password {
        value # A NEW PASSWORD WILL BE GENERATED AND RETURNED
      }
      type
    }
  }
}

Resposta de amostra

A senha aparece na resposta da seguinte maneira.

{
  "data": {
    "dashboardUpdateLiveUrlAuth": {
      "factors": [
        {
          "password": {
            "value": "system generated password"
          },
          "type": "PASSWORD"
        }
      ]
    }
  }
}

Após habilitar a senha para os dashboards compartilhados, você precisa compartilhar a senha com os usuários. Copie e salve a senha, pois você não poderá recuperá-la mais tarde. Se você perdê-la, basta redefinir a senha e compartilhá-la novamente com os usuários. Siga nossas práticas recomendadas de gerenciamento de senhas para gerenciar a senha com segurança.

Certifique-se de ter as permissões para modificar a configuração do dashboard compartilhado. Para desativar a proteção por senha de um URL de dashboard ao vivo:

Acesse o explorador da API do NerdGraph.
Crie uma chamada de API de gráfico usando a mutação dashboardUpdateLiveUrlAuth com os seguintes valores de atributo:

auth > factors > type: Selecione PASSWORD para habilitar a proteção por senha para o URL dashboard ativo.
id: Copie o ID do URL dashboard compartilhado e insira-o.
auth > factors: Mantenha isto vazio.

factors > type: Selecione esta opção para obter a confirmação em resposta de que o valor da senha foi removido.

Mutação de amostra

mutation {
  dashboardUpdateLiveUrlAuth(
    id: "YOUR_PUBLIC_LINK_UUID"
    auth: { factors: [] } # Send an empty array to remove all authentication
  ) {
    factors {
      # This will be empty
      type
    }
  }
}

Resposta de amostra

Verifique se a resposta aparece da seguinte maneira. A senha é removida e o URL dashboard ao vivo não é mais protegido por senha.

{
  "data": {
    "dashboardUpdateLiveUrlAuth": {
      "factors": []
    }
  }
}

Certifique-se de ter as permissões para modificar a configuração do dashboard compartilhado. Para redefinir a senha de uma URL de dashboard ao vivo:

Acesse o explorador da API do NerdGraph.
Crie uma chamada de API de gráfico usando a mutação dashboardResetLiveUrlPassword com os seguintes valores de atributo:

id: Copie o ID do URL dashboard compartilhado e insira-o.
password: Selecione esta opção para obter a nova senha dashboard ativo na resposta.
Mutação de amostra
```
mutation {
  dashboardResetLiveUrlPassword(id: "YOUR_PUBLIC_LINK_UUID") {
    password
  }
}
```
Resposta de amostra
A nova senha aparece na resposta da seguinte maneira.
```
{
  "data": {
    "dashboardResetLiveUrlPassword": {
      "password": "system generated password"
    }
  }
}
```
Após redefinir a senha dos dashboards compartilhados, você precisa compartilhar a nova senha com os usuários. Copie e salve a senha, pois você não poderá recuperá-la mais tarde. Se você o perder, basta redefini-lo novamente. Siga nossas práticas recomendadas de gerenciamento de senhas para gerenciar a senha com segurança.

Com base nas permissões que você tem, você pode revogar apenas as URLs que você criou, ou todas as URLs criadas por usuários na conta. Para revogar uma URL de dashboard compartilhado:

Acesse o explorador da API do NerdGraph.
Crie uma chamada de API de gráfico usando a mutação dashboardRevokeLiveUrl com o seguinte valor de atributo:

id: Copie o ID do URL dashboard compartilhado e insira-o.
Mutação de amostra
```
mutation {
  dashboardRevokeLiveUrl(id: "PUBLIC_LINK_ID") {
    id
  }
}
```
Resposta de amostra
O URL dashboard compartilhado foi revogado e não estará mais acessível. A resposta aparece da seguinte forma:
```
{
  "data": {
    "dashboardRevokeLiveUrl": {
      "id": "PUBLIC_LINK_ID" //the one you passed to the mutation
    }
  }
}
```

Com base nas permissões que você possui, você pode recuperar a lista de URLs que criou, ou todas as URLs criadas por usuários na conta. Para obter a lista de URLs de dashboards compartilhados:

Acesse o explorador da API do NerdGraph.
Crie uma chamada de API de gráfico usando os seguintes detalhes:

actor > dashboard > liveUrls: Use isto para recuperar a lista de URLs dashboard compartilhados.
filter > type: Selecione DASHBOARD para filtrar os resultados dos URLs dashboard .

Selecione quaisquer outros campos que você deseja na resposta.

Exemplo de consulta

{
  actor {
    user {
      name
    }
    dashboard {
      liveUrls(filter: { type: DASHBOARD }) {
        liveUrls {
          createdAt
          type
          uuid
        }
      }
    }
  }
}

A lista de URLs do dashboard compartilhado aparece em resposta.

Tópicos relacionados

Introdução ao compartilhamento público

Introdução ao compartilhamento público de dashboards e gráficos, com detalhes de disponibilidade e preços.

Compartilhar o dashboard publicamente

Compartilhe dashboards inteiros com visualizadores externos via URLs ativas, com proteção por senha e controles de expiração.

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

Tutorial do NerdGraph: Criar, atualizar e revogar URLs dashboard de compartilhamento público

Cuidado

Crie uma URL sem proteção por senha

Mutação de amostra

Resposta de amostra

Importante

Crie uma URL com proteção por senha

Mutação de amostra

Resposta de amostra

Atualizar duração de expiração dashboard ao vivo

Mutação de amostra

Resposta de amostra

Habilitar proteção por senha para o URL ativo

Mutação de amostra

Resposta de amostra

Desabilitar a proteção por senha para o URL ativo

Mutação de amostra

Resposta de amostra

Redefinir a senha para o URL ativo

Mutação de amostra

Resposta de amostra

Revogar uma URL ativa

Mutação de amostra

Resposta de amostra

Listar todos os URLs compartilhados

Exemplo de consulta

Tópicos relacionados

Introdução ao compartilhamento público

Compartilhar o dashboard publicamente