Gerenciar localização privada

localização privada permite monitorar aplicativos atrás de seu firewall ou em redes restritas. Ao criar uma localização privada, você instala e configura o minion privado para executar os monitores atribuídos a essa localização privada. Este tutorial fornece exemplos de como usar a API do NerdGraph para gerenciar programaticamente a localização privada.

Crie uma localização privada

Você pode criar uma localização privada usando a mutação syntheticsCreatePrivateLocation. Esta mutação permite configurar uma nova localização privada na sua infraestrutura de monitoramento onde você pode implantar minion privado ou gerentes de trabalho.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna o GUID da localização privada recém-criada:

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

Se houver algum problema ao criar a localização privada, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Atualizar uma localização privada

Você pode atualizar uma localização privada existente usando a mutação syntheticsUpdatePrivateLocation. Isto permite modificar a configuração de uma localização privada que já foi criada.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna os campos atualizados e null em caso de erros:

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

Se houver algum problema ao atualizar a localização privada, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Limpar uma fila de trabalhos de localização privada

Você pode limpar a fila de trabalhos para uma localização privada usando a mutação syntheticsPurgePrivateLocationQueue. Isso é útil quando você precisa remover um acúmulo de tarefas de monitoramento do Sintético que ficaram em fila devido a problemas de desempenho ou problemas temporários de conectividade.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

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

Se houver algum problema ao limpar a fila, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Excluir um local privado

Quando uma localização privada não for mais necessária, você poderá removê-la permanentemente usando a mutação syntheticsDeletePrivateLocation.

Parâmetro de entrada

Solicitação de amostra

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

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

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

Se houver algum problema ao excluir a localização privada, a matriz errors conterá objetos com campos description e type explicando o que deu errado.