La ubicación privada le permite monitorear la aplicación detrás de su firewall o en redes restringidas. Cuando creas una ubicación privada, instalas y configuras minion privado para ejecutar los monitores asignados a esa ubicación privada. Este tutorial proporciona ejemplos de cómo emplear la API de NerdGraph para gestionar mediante programación la ubicación privada.
Crear una ubicación privada
Puedes crear una ubicación privada usando la mutación syntheticsCreatePrivateLocation. Esta mutación le permite configurar una nueva ubicación privada en su infraestructura de monitoreo donde puede desplegar minion privado o administradores de trabajo.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Entero | Sí | El asociado con la ubicación privada. |
| Cadena | No | La descripción de la ubicación privada. |
| Cadena | Sí | El nombre de la ubicación privada. |
| Booleano | No | Especifica si la ubicación privada se comparte en toda la organización. |
| Booleano | Sí | Si el valor es verdadero, la ubicación privada requiere una contraseña para editar. |
Solicitud de muestra
mutation { syntheticsCreatePrivateLocation( accountId: ACCOUNT_ID name: "PrivateLocationName" description: "Optional description" shared: true verifiedScriptExecution: false ) { guid errors { description type } }}Ejemplo de respuesta
Una respuesta exitosa devuelve el GUID de la ubicación privada recién creada:
{ "data": { "syntheticsCreatePrivateLocation": { "guid": "PRIVATE_LOCATION_GUID", "errors": null } }}Si hay algún problema al crear la ubicación privada, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.
Actualizar una ubicación privada
Puede actualizar una ubicación privada existente empleando la mutación syntheticsUpdatePrivateLocation. Esto le permite modificar la configuración de una ubicación privada que ya fue creada.
Importante
Si una ubicación es compartida y empleada por otras cuentas de su organización para ejecutar monitores sintéticos, no podrá dejar de compartir esta ubicación privada hasta que esos monitores estén deshabilitados.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | El de entidad único de la ubicación privada que desea actualizar. |
| Cadena | No | La descripción de la ubicación privada. |
| Booleano | No | Especifica si la ubicación privada se comparte en toda la organización. |
| Booleano | Sí | Si el valor es verdadero, la ubicación privada requiere una contraseña para editar. |
Solicitud de muestra
mutation { syntheticsUpdatePrivateLocation( guid: "ENTITY_GUID" description: "EnterYourDescription" shared: false verifiedScriptExecution: true ) { description verifiedScriptExecution errors { description type } }}Ejemplo de respuesta
Una respuesta exitosa devuelve los campos actualizados y null para errores:
{ "data": { "syntheticsUpdatePrivateLocation": { "description": "EnterYourDescription", "verifiedScriptExecution": true, "errors": null } }}Si hay algún problema al actualizar la ubicación privada, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.
Limpiar una cola de trabajos de una ubicación privada
Puede borrar la cola de trabajos de una ubicación privada empleando la mutación syntheticsPurgePrivateLocationQueue. Esto es útil cuando necesita eliminar una acumulación de trabajos de monitorización de Sintético en cola que pueden haber acumulado debido a problemas de rendimiento o problemas de conectividad temporales.
Sugerencia
Emplee esta operación con cuidado, ya que eliminará de forma permanente todos los trabajos en cola. Los trabajos que se estén ejecutando actualmente no se verán afectados.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | El de la ubicación privada cuya cola de trabajos desea purgar. |
Solicitud de muestra
mutation { syntheticsPurgePrivateLocationQueue(guid: "PRIVATE_LOCATION_ENTITY_GUID") { errors { description type } }}Ejemplo de respuesta
Una respuesta exitosa devuelve null para los errores:
{ "data": { "syntheticsPurgePrivateLocationQueue": { "errors": null } }}Si hay algún problema al purgar la cola, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.
Eliminar una ubicación privada
Cuando ya no se necesita una ubicación privada, puedes eliminarla de forma permanente empleando la mutación syntheticsDeletePrivateLocation.
Importante
Antes de eliminar una ubicación privada, cerciorar de que no haya monitores asignados a ella. Eliminar una ubicación privada que tenga monitores activos asignados provocará que dichos monitores fallen.
parámetro de entrada
Parámetro | Tipo de datos | ¿Es obligatorio? | Descripción |
|---|---|---|---|
| Cadena | Sí | El de entidad única de la ubicación privada que desea eliminar. |
Solicitud de muestra
mutation { syntheticsDeletePrivateLocation(guid: "ENTITY_GUID") { errors { description type } }}Ejemplo de respuesta
Una respuesta exitosa devuelve null para los errores:
{ "data": { "syntheticsDeletePrivateLocation": { "errors": null } }}Si hay algún problema al eliminar la ubicación privada, la matriz errors contendrá objetos con campos description y type que explican qué salió mal.