Gérer le site privé

Les sites privés vous permettent de monitorer les applications derrière votre pare-feu ou dans des réseaux restreints. Lorsque vous créez un site privé, vous installez et configurez le sous-site privé pour exécuter le moniteur affecté à ce site privé. Ce tutoriel fournit des exemples d'utilisation de l'API NerdGraph pour gérer par programmation un site privé.

Créer un site privé

Vous pouvez créer un site privé en utilisant la mutation syntheticsCreatePrivateLocation. Cette mutation vous permet de configurer un nouveau site privé dans votre infrastructure monitoring où vous pouvez déployer des sous-secteurs privés ou des gestionnaires de tâches.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsCreatePrivateLocation(
    accountId: ACCOUNT_ID
    name: "PrivateLocationName"
    description: "Optional description"
    shared: true
    verifiedScriptExecution: false
  ) {
    guid
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie le GUID du site privé nouvellement créé :

{
  "data": {
    "syntheticsCreatePrivateLocation": {
      "guid": "PRIVATE_LOCATION_GUID",
      "errors": null
    }
  }
}

En cas de problème lors de la création du site privé, le éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.

Mettre à jour un site privé

Vous pouvez mettre à jour un site privé existant en utilisant la mutation syntheticsUpdatePrivateLocation. Cela vous permet de modifier la configuration d'un site privé déjà créé.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsUpdatePrivateLocation(
    guid: "ENTITY_GUID"
    description: "EnterYourDescription"
    shared: false
    verifiedScriptExecution: true
  ) {
    description
    verifiedScriptExecution
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie les champs mis à jour et null en cas d'erreur :

{
  "data": {
    "syntheticsUpdatePrivateLocation": {
      "description": "EnterYourDescription",
      "verifiedScriptExecution": true,
      "errors": null
    }
  }
}

En cas de problème lors de la mise à jour du site privé, le errors éventail contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.

Purger une file d'attente de travaux d'un site privé

Vous pouvez vider la file d'attente des tâches pour un site privé en utilisant la mutation syntheticsPurgePrivateLocationQueue. Ceci est utile lorsque vous devez supprimer un arriéré de tâches de monitoring Synthétique mises en file d'attente qui peuvent s'être accumulées en raison de problèmes de performance ou de problèmes de connectivité temporaires.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsPurgePrivateLocationQueue(guid: "PRIVATE_LOCATION_ENTITY_GUID") {
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie null en cas d'erreur :

{
  "data": {
    "syntheticsPurgePrivateLocationQueue": {
      "errors": null
    }
  }
}

En cas de problème lors de la purge de la file d'attente, l'éventail errors contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.

Supprimer un site privé

Lorsqu'un site privé n'est plus nécessaire, vous pouvez le supprimer définitivement en utilisant la mutation syntheticsDeletePrivateLocation.

Paramètres d'entrée

Demande d'échantillon

mutation {
  syntheticsDeletePrivateLocation(guid: "ENTITY_GUID") {
    errors {
      description
      type
    }
  }
}

Exemple de réponse

Une réponse positive renvoie null en cas d'erreur :

{
  "data": {
    "syntheticsDeletePrivateLocation": {
      "errors": null
    }
  }
}

En cas de problème lors de la suppression du site privé, le errors éventail contiendra des objets avec des champs description et type expliquant ce qui s'est mal passé.