Métodos Disponíveis

Amostra de conexão

Exemplo ServerView/BrowserView Dispositivo JSON Object
{
    "Avoid_Simultaneous_Checks": false,
    "Alert_Silence_Min": 28,
    "False_Positive_Check": false,
    "Locations": [
        1,
        4,
        6,
        14,
        15,
        17,
        19,
        23,
        43,
        71,
        73
    ],
    "Tags": [
        "my_device"
    ],
    "ContextParams": [],
    "Send_Uptime_Alert": false,
    "Status_Description": "POSTPONED",
    "Postpone": true,
    "Owner_Device_Id": 0,
    "Frequency": 10800,
    "Filter_Id": 7791,
    "Scheduler_Id": 0,
    "Notifications": {
        "E_Mail_Flag": false,
        "E_Mail_Address": null,
        "E_Mail_TimeInterval_Min": 0,
        "WL_Device_Flag": false,
        "WL_Device_Email_Address": null,
        "WL_Device_TimeInterval_Min": 0,
        "Pager_Flag": false,
        "Pager_Area_Code": null,
        "Pager_Phone": null,
        "Pager_Num_Code": null,
        "Pager_TimeInterval_Min": 0,
        "Phone_Flag": false,
        "Phone_Area_Code": null,
        "Phone_Phone": null,
        "Phone_TimeInterval_Min": 0,
        "SMS_Flag": false,
        "SMS_Phone": null,
        "SMS_TimeInterval_Min": 0,
        "Script_Flag": false,
        "Script_Batch_File_Name": null,
        "Script_TimeInterval_Min": 0,
        "SNMP_TimeInterval_Min": 0,
        "Teams_TimeInterval_Min": 0,
        "Slack_TimeInterval_Min": 0,
        "AlertOps_TimeInterval_Min": 0,
        "PagerDuty_TimeInterval_Min": 0,
        "Notification_Groups": []
    },
    "Id": 47432,
    "Number_Of_Tasks": 1,
    "WaitingForApproval": false,
    "Platform_Id": 1,
    "Package_Id": 52,
    "Name": "FullPageDomain.cs"
}

Descrição dos campos

Use esses campos para especificar informações sobre um dispositivo em suas solicitações de API.

campo

Type

 descrição

Avoid_Simultaneous_Checks

booleano

 Indica se a verificação simultânea dos vários locais de monitoramento é permitida. Disponível apenas para dispositivos ServerView.

exemplo:
"Avoid_Simultaneous_Checks": true

Alert_Silence_Min

int32

 SOMENTE LEITURA. Define o período de tempo em minutos quando todos os alertas são desabilitados. Para desativar os alertas, use API: Desabilitar alertas para dispositivos ou API: Desativar alertas para vários dispositivos.

exemplo:
"Alert_Silence_Min": 46

False_Positive_Check

booleano

 Quando um erro é detectado, executamos uma série de verificações para garantir que não seja um alerta falso. Essas verificações podem levar algum tempo, dependendo do tipo de erro e do número de tarefas no dispositivo. Isso pode causar algum atraso no alerta de tempo de inatividade. Você pode desativar a verificação de falso positivo (“estado verdadeiro”) para garantir um alerta de tempo de inatividade imediato, mas isso pode resultar em alguns alertas “falsos”. Recomendamos NÃO desativar a “Verificação de falso positivo”.

exemplo:
"False_Positive_Check": false

Locais

matriz de int32

 Uma matriz contendo IDs de localização atribuídos a um dispositivo especificado. Pelo menos um local deve ser especificado nas solicitações.

exemplo:
"Locations": [1, 2, 4, 5, 8]

Tags

matriz de string

 Uma matriz contendo nomes das tags atribuídas a um dispositivo especificado.

exemplo:
"Tags": ["green", "red", "black"]

Send_Uptime_Alert

booleano

 Quando esta opção estiver ativada, você receberá um alerta quando todos os erros detectados forem resolvidos.

exemplo:
"Send_Uptime_Alert": false

Status_Description

corda

 SOMENTE LEITURA. Descrevendo o estado atual do dispositivo.

exemplo:
"Status_Description": "POSTPONED"

adiar

booleano

 O monitoramento pode ser colocado em pausa adiando um dispositivo.

exemplo:
"Postpone": true,

Owner_Device_Id

int32

 Esse campo reflete a ID do dispositivo do proprietário.

exemplo:
"Owner_Device_Id": 8534

frequência

int32

 Este campo reflete a frequência de monitoramento em segundos.

exemplo:
"Frequency": 10800

Filter_Id

int32

 Este campo reflete a ID do filtro atribuída a um dispositivo.

exemplo:
"Filter_Id": 853

Scheduler_Id

int32

 Esse campo reflete a ID do Agendador atribuída a um dispositivo.

exemplo:
"Scheduler_Id": 534

Notificações

matriz de objetos

 Indica uma lista de configurações de alerta.

Exemplo #1:
"Notifications":
{
"E_Mail_Flag": true,
"E_Mail_Address": "demo@at.com",
"E_Mail_TimeInterval_Min": 10
}
Exemplo #2:
"Notifications":
{
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}]
}

E_Mail_Flag

booleano

 Define se um alerta por e-mail será enviado.

exemplo:
"E_Mail_Flag": false

E_Mail_Address

corda

 Especifica um endereço de email para alertas de email.

exemplo:
"E_Mail_Address": "demo@company.com"

E_Mail_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre alertas de e-mail em minutos

exemplo:
"E_Mail_TimeInterval_Min": 15

WL_Device_Flag

booleano

 Define se um alerta de dispositivo sem fio será enviado.

exemplo:
"WL_Device_Flag": false

WL_Device_Email_Address

corda

 Este campo especifica um dispositivo sem fio, como um telefone ou pager, para alertas.

exemplo:
"WL_Device_Email_Address": "wireless@company.com"

WL_Device_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre alertas de dispositivo sem fio em minutos.

exemplo:
"WL_Device_TimeInterval_Min": 13

Pager_Flag

booleano

 Define se os alertas do pager serão enviados.

exemplo:
"Pager_Flag": true

Pager_Area_Code

corda

 Código de área pager.

exemplo:
"Pager_Area_Code": "917"

Pager_Phone

corda

 Telefone Pager.

exemplo:
"Pager_Phone": "3214564"

Pager_Num_Code

corda

 Código para pagers numéricos.

exemplo:
"Pager_Num_Code": "225"

Pager_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre os alertas do pager em minutos.

exemplo:
"Pager_TimeInterval_Min": 5

Phone_Flag

booleano

 Define se serão realizados alertas de chamadas telefônicas. Para receber alertas via telefone defina o valor como “true” e especifique o número de telefone. Os alertas do telefone são interativos, permitindo que você adie os alertas subsequentes assim que um alerta for recebido.

exemplo:
"Phone_Flag": true

Phone_Area_Code

corda

 Se o código do país for “1” (por exemplo, nos EUA, Canadá e Caribe), insira o código de área e o número (por exemplo, 952-5134349). Para todos os outros códigos de país, use o prefixo “011”, o código do país e o número de telefone (por exemplo, 011-44-95-2244392).

exemplo:
"Phone_Area_Cde": "952"

Phone_Phone

corda

 Número de telefone.

exemplo:
"Phone_Phone": "5134349"

Phone_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre chamadas telefônicas.

exemplo:
"Phone_TimeInterval_Min": 2

SMS_Flag

booleano

 Define se os alertas de SMS serão enviados.

exemplo:
"SMS_Flag": false

SMS_Phone

 corda Um número de telefone com um código de país (por exemplo: EUA – 1 952 513 4349; Reino Unido 449524 4392). NÃO use um prefixo de discagem internacional, como “011” no número.

exemplo:
"SMS_Phone": "19525134349"

SMS_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre alertas de SMS.

exemplo:
"SMS_TimeInterval_Min": 0

Script_Flag

booleano

 Este campo define se o alerta será executado por um script de alerta personalizado.

exemplo:
"Script_Flag": false

Script_Batch_File_Name

corda

 Nome de arquivo script personalizado. O script já deve estar instalado no servidor.

exemplo:
"Script_Batch_File_Name":"alerting.cs"

Script_TimeInterval_Min

int32

 Este campo permite definir um intervalo entre alertas de script personalizados.

exemplo:
"Script_TimeInterval_Min":5

Notification_Groups

matriz de objetos

 Indica grupos de alerta ativos com seu ID e mudança de tempo. Timeshift é uma opção que permite criar um processo de escalonamento de alerta que é baseado na duração da condição de erro, Por exemplo, o primeiro grupo de notificação pode ser notificado imediatamente, o segundo – após 10 minutos de tempo de inatividade, e o terceiro grupo – após 60 minutos de tempo de inatividade. Alerta Os intervalos de tempo de escalada variam de imediato a três horas.

exemplo:
"Notification_Groups":
[{
"Id": 608,
"Time_Shift_Min": 10
}, {
"Id": 609,
"Time_Shift_Min": 20
}]

Number_Of_Tasks

int32

 LEIA APENAS Field. Mostra o número de tarefas no dispositivo especificado.

exemplo:
"Number_Of_Tasks": 15

id

int32

 LEIA APENAS Field. O iD do dispositivo único. Atribuído automaticamente após uma nova criação de dispositivo. Use para especificar um dispositivo em solicitações.

exemplo:
"Id": 8533

Platform_Id

int32

 LEIA APENAS Field. Cada plataforma (ServerView, UserView, etc.) tem seu próprio ID. Veja como obter as IDs das plataformas aqui.

exemplo:
"Platform_Id": 1

nome

corda

 O nome do dispositivo.

exemplo:
"Name": "new name"