Tutorial de NerdGraph: crear, actualizar y revocar URL dashboard de uso compartido públicos

Con la gestión de acceso configurada necesaria, puedes crear, administrar y revocar URL de dashboard en vivo de acceso público usando consultas y mutaciones en NerdGraph. También puedes hacerlo desde la UI de New Relic.

Advertencia

Si un dashboard compartido no está protegido con contraseña, cualquier persona con la URL activa puede acceder y ver toda la información que contiene. Para evitar acceso no deseado, cerciorar de crear URL protegidas con contraseña o habilitar la protección con contraseña para las URL compartidas existentes.

Para crear, actualizar o revocar una URL dashboard en tiempo real de acceso público desde NerdGraph, necesita el GUID del dashboard que desea compartir.

Vaya a one.newrelic.com > Dashboards.
Abra el dashboard que desea compartir.
Navegue hasta > Metadata y copie el GUID de la entidad del dashboard.

Vaya al explorador de API de NerdGraph.
Construya un gráfico llamado API usando la mutación dashboardCreateLiveUrl con los siguientes parámetros:

GUID: Ingrese el GUID de la entidad del dashboard.
Options(opcional) > ttl: Ingrese el periodo de tiempo en segundos que la URL permanecerá activa.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 años)
- Valor predeterminado: 2592000 segundos (30 días)
url: Seleccione esta opción para obtener la URL dashboard en tiempo real en la respuesta.
Seleccione cualquier otro campo que desee en la respuesta.
Mutación de muestra
```
mutation {
  dashboardCreateLiveUrl(
    options: { ttl: TIME_IN_SECONDS }
    guid: "YOUR_DASHBOARD_GUID"
  ) {
    url
  }
}
```
La URL dashboard en tiempo real aparece en la respuesta. Esta es una URL pública, por lo que puedes compartirla con cualquiera.
Ejemplo de respuesta
```
{
  "data": {
    "dashboardCreateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```
El PUBLIC_LINK_ID es el ID del dashboard compartido. Puede usarlo para actualizar o revocar la URL dashboard compartido a través de NerdGraph.
Importante
Cualquier actualización de contenido en el dashboard de la plataforma New Relic se refleja en la página dashboard compartido.

Para evitar acceso no deseado al dashboard compartido, puede crear una URL dashboard en tiempo real con protección con contraseña.

Vaya al explorador de API de NerdGraph.
Construya un gráfico llamado API usando la mutación dashboardCreateLiveUrl con los siguientes parámetros:

auth > factors > type: Seleccione PASSWORD para habilitar la protección con contraseña para la URL dashboard en tiempo real.
GUID: Ingrese el GUID de la entidad del dashboard.
Options(opcional) > ttl: Ingrese el periodo de tiempo en segundos que la URL permanecerá activa.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 años)
- Valor predeterminado: 2592000 segundos (30 días)
auth > factors > password > value: Seleccione esto para obtener la contraseña dashboard en tiempo real en la respuesta.
url: Seleccione esta opción para obtener la URL dashboard en tiempo real en la respuesta.

Seleccione cualquier otro campo que desee en la respuesta.

Mutación de muestra

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

La URL y la contraseña dashboard en tiempo real aparecen en la respuesta.

Ejemplo de respuesta

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

El uuid es el ID del dashboard compartido. Puedes usarlo para actualizar o revocar la URL del dashboard compartido a través de NerdGraph. Para compartir el dashboard con usuarios externos, copie la URL y la contraseña de la respuesta. Las contraseñas no se pueden recuperar posteriormente. Si lo pierdes, solo tienes que restablecer la contraseña y compartirla de nuevo con los usuarios. Sigue nuestras mejores prácticas de gestión de contraseñas para administrar la contraseña de forma segura.

Asegúrese de tener los permisos para modificar la configuración del dashboard compartido.

Para actualizar el periodo de tiempo durante el cual la URL estará activa:

Vaya al explorador de API de NerdGraph.
Construya un gráfico llamado API usando la mutación dashboardUpdateLiveUrl con los siguientes parámetros:

id:Copie el ID de la URL dashboard compartido e ingréselo.
options (opcional) > ttl: Ingrese el periodo de tiempo en segundos que la URL permanecerá activa.
- Valor mínimo: 300 segundos (5 minutos)
- Valor máximo: 631152000 segundos (20 años)
- Valor predeterminado: 2592000 segundos (30 días)
Mutación de muestra
```
mutation {
  dashboardUpdateLiveUrl(id: "PUBLIC_URL_ID", options: { ttl: TIME_IN_SECONDS })
}
```
La URL aparece en la respuesta de la siguiente manera. Ahora la URL permanecerá activa durante el periodo de tiempo actualizado.
Ejemplo de respuesta
```
{
  "data": {
    "dashboardUpdateLiveUrl": {
      "url": "https://share.newrelic.com/dashboard/PUBLIC_LINK_ID"
    }
  }
}
```

Asegúrate de tener los permisos para modificar la configuración del dashboard compartido. Para habilitar la protección con contraseña para una URL de dashboard en vivo:

Vaya al explorador de API de NerdGraph.
Construya un gráfico llamado API usando la mutación dashboardUpdateLiveUrlAuth con los siguientes parámetros:

auth > factors > type: Seleccione PASSWORD para habilitar la protección con contraseña para la URL dashboard en tiempo real.
id:Copie el ID de la URL dashboard compartido e ingréselo.
auth > factors > password > value: Seleccione esto para obtener la contraseña dashboard en tiempo real en la respuesta.

Seleccione cualquier otro campo que desee en la respuesta.

Mutación de muestra

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

Ejemplo de respuesta

La contraseña aparece en la respuesta de la siguiente manera.

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

Después de habilitar la contraseña para los dashboards compartidos, debe compartir la contraseña con los usuarios. Copie y guarde la contraseña, ya que no podrá recuperarla más adelante. Si la pierdes, solo tienes que restablecer la contraseña y compartirla de nuevo con los usuarios. Sigue nuestras mejores prácticas de gestión de contraseñas para administrar la contraseña de forma segura.

Asegúrate de tener los permisos para modificar la configuración del dashboard compartido. Para desactivar la protección con contraseña de la URL de un dashboard en vivo:

Vaya al explorador de API de NerdGraph.
Construya una llamada API de gráfico empleando la mutación dashboardUpdateLiveUrlAuth con los siguientes valores de atributo:

auth > factors > type: Seleccione PASSWORD para habilitar la protección con contraseña para la URL dashboard en tiempo real.
id:Copie el ID de la URL dashboard compartido e ingréselo.
auth > factors: Manténgalo vacío.

factors > type: Seleccione esto para obtener la confirmación en respuesta de que se eliminó el valor de la contraseña.

Mutación de muestra

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

Ejemplo de respuesta

Verifique que la respuesta aparezca de la siguiente manera. Se elimina la contraseña y la URL dashboard en tiempo real ya no está protegida con contraseña.

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

Asegúrate de tener los permisos para modificar la configuración del dashboard compartido. Para restablecer la contraseña de la URL de un dashboard en vivo:

Vaya al explorador de API de NerdGraph.
Construya una llamada API de gráfico empleando la mutación dashboardResetLiveUrlPassword con los siguientes valores de atributo:

id:Copie el ID de la URL dashboard compartido e ingréselo.
password: Seleccione esta opción para obtener la nueva contraseña dashboard en tiempo real en la respuesta.
Mutación de muestra
```
mutation {
  dashboardResetLiveUrlPassword(id: "YOUR_PUBLIC_LINK_UUID") {
    password
  }
}
```
Ejemplo de respuesta
La nueva contraseña aparece en la respuesta de la siguiente manera.
```
{
  "data": {
    "dashboardResetLiveUrlPassword": {
      "password": "system generated password"
    }
  }
}
```
Después de restablecer la contraseña de los dashboards compartidos, debe compartir la nueva contraseña con los usuarios. Copie y guarde la contraseña, ya que no podrá recuperarla más adelante. Si lo pierdes, solo tienes que restablecerlo de nuevo. Siga nuestras mejores prácticas de gestión de contraseñas para gestionar la contraseña de forma segura.

Según los permisos que tengas, puedes revocar solo las URL que hayas creado, o todas las URL creadas por los usuarios en la cuenta. Para revocar una URL de dashboard compartido:

Vaya al explorador de API de NerdGraph.
Construya una llamada API de gráfico empleando la mutación dashboardRevokeLiveUrl con el siguiente valor de atributo:

id:Copie el ID de la URL dashboard compartido e ingréselo.

Mutación de muestra

mutation {
  dashboardRevokeLiveUrl(id: "PUBLIC_LINK_ID") {
    id
  }
}

Ejemplo de respuesta

La URL dashboard compartido ahora está revocada y ya no será accesible. La respuesta aparece como sigue:

{
  "data": {
    "dashboardRevokeLiveUrl": {
      "id": "PUBLIC_LINK_ID" //the one you passed to the mutation
    }
  }
}

Según los permisos que tengas, puedes obtener la lista de URL que has creado, o todas las URL creadas por los usuarios en la cuenta. Para obtener la lista de URL de dashboards compartidos:

Vaya al explorador de API de NerdGraph.
Construya una llamada API de gráfico empleando los siguientes detalles:

actor > dashboard > liveUrls: Use esto para recuperar la lista de URL dashboard compartido.
filter > type: seleccione DASHBOARD para filtrar los resultados de las URL dashboard .

Seleccione cualquier otro campo que desee en la respuesta.

Consulta de muestra

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

En respuesta aparece la lista de URL del dashboard compartido.

Temas relacionados

Introducción al uso compartido público

Introducción al uso compartido público de dashboard y gráficos, con detalles de disponibilidad y precios.

Compartir el dashboard públicamente

Comparta dashboards completos con espectadores externos mediante URL en vivo, con protección por contraseña y controles de expiración.

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

Tutorial de NerdGraph: crear, actualizar y revocar URL dashboard de uso compartido públicos

Advertencia

Crear una URL sin protección de contraseña

Mutación de muestra

Ejemplo de respuesta

Importante

Crear una URL con protección de contraseña

Mutación de muestra

Ejemplo de respuesta

Actualizar la duración de expiración dashboard en tiempo real

Mutación de muestra

Ejemplo de respuesta

Habilitar la protección con contraseña para la URL en tiempo real

Mutación de muestra

Ejemplo de respuesta

Deshabilitar la protección con contraseña para la URL activa

Mutación de muestra

Ejemplo de respuesta

Restablecer la contraseña para la URL en tiempo real

Mutación de muestra

Ejemplo de respuesta

Revocar una URL activa

Mutación de muestra

Ejemplo de respuesta

Listar todas las URL compartidas

Consulta de muestra

Temas relacionados

Introducción al uso compartido público

Compartir el dashboard públicamente