API aberta de gestão de alarmes
A API Aberta de gestão de alarmes fornece endpoints para criar, atualizar e recuperar dados das tabelas Eventos [em_event] e Alerta [em_alert].
A API aberta de gestão de alarmes de telecomunicações (sn_ind_tmf642) é uma implementação ServiceNow® da especificação da API aberta do TM Fórum. Esta API se baseia na especificação REST da API de gestão de alarmes TMF642 versão 20, abril de 2020.
O usuário de chamada deve ter para acessar o endpoint sn_ind_tmf642.alarm_mgmt_integration.
Esta API é fornecida no namespace sn_ind_tmf642.
A especificação da TM Fórum Open API requer uma resposta síncrona para cada solicitação de entrada que recebe. Aplique correlação e desduplicação no sistema de suporte operacional (OSS) de origem antes de encaminhar cargas para o sistema.
Esta API pode ser estendida para fazer personalizações em torno dos parâmetros necessários, validação do corpo da solicitação, operações REST adicionais e mapeamentos de campo. Para obter mais informações, consulte o Guia do desenvolvedor da API aberta de gestão de alarmes.
A API aberta de gestão de alarmes tem conformidade certificada pelo TM Fórum.
API aberta de gestão de alarmes – GET /sn_ind_tmf642/alarm_mgmt/alarm
Recupera uma lista de todos os registros de alarme das tabelas Eventos [em_event] e Alerta [em_alert].
Formato da URL
URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| AlarmRaisedTime | Data em que o alarme foi acionado. Somente alarmes com uma data correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres |
| campos | Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos:
Padrão: todos os campos Tipo de dados: cadeia de caracteres |
| ID | ID do alarme. Somente alarmes com um ID correspondente ao valor deste parâmetro são retornados na resposta. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres |
| limite | Número máximo de registros a serem retornados. Para solicitações que excedem esse número de registros, use o parâmetro offset para paginar a recuperação do registro. Padrão: 1000 Máximo: 2000 Tipo de dados: número |
| deslocamento | Índice inicial no qual os registros serão recuperados. Use este valor para paginar a recuperação do registro. Essa funcionalidade permite a recuperação de todos os registros, independentemente do número de registros, em pequenos blocos gerenciáveis. Padrão: 0 Tipo de dados: número |
| provávelCausa | Causa provável do alarme. Somente alarmes com uma causa provável correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres |
| estado | Estado do alarme. Somente alarmes com um estado correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres |
| sourceSystemId | ID do sistema de origem do alarme. Somente alarmes com um ID de sistema de origem correspondente ao valor deste parâmetro são retornados na resposta. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
| Cabeçalho | Descrição |
|---|---|
| Intervalo de conteúdo | Especifica o intervalo de conteúdo retornado em uma chamada paginada. Por exemplo, se |
| Tipo de conteúdo | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Link | Contém os links a seguir para navegar pelos resultados da consulta.
|
| X-Total-Contagem | Para consultas paginadas, este cabeçalho especifica o número total de registros disponíveis no servidor. |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Solicitação processada com sucesso. Recurso completo retornado na resposta (sem paginação). |
| 206 | Recurso parcial retornado em resposta (com paginação). |
| 400 | Solicitação incorreta. Possíveis motivos:
|
| 404 | Registro não encontrado. Nenhum registro correspondente aos parâmetros de consulta foi encontrado na tabela. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| Serviçoafetado | Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz |
| Serviçoafetado.href | Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: cadeia de caracteres |
| affectedService.id | Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: cadeia de caracteres |
| detalhesdoalarme | Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObject | Detalhes do objeto de alarme. Tipo de dados: objeto |
| alarmedObject.id | Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: cadeia de caracteres |
| AlarmedObject.href | Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObjectType | Tipo ou classe de objeto associado ao evento. Tipo de dados: cadeia de caracteres |
| AlarmRaisedTime | Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres |
| AlarmReportingTime | Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elementos (EMS) mantiver a lista de alarmes:
Tipo de dados: cadeia de caracteres |
| tipo de alarme | Categoria de alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformações sobre limite | Detalhes sobre o limite ultrapassado.Tipo de dados: objeto |
| CrossThresholdInformation.direction | Direção de cruzamento do limite. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.granularidade | Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, 5MINUTES.Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.IndicatorName | Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.indicadorUnidade | Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.observadoValue | Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdCrossingDescription | Mais detalhes do limite do alarme de ultrapassagem de limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdId | Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdRef | URL do objeto de limite. Tipo de dados: cadeia de caracteres |
| externalAlarmId | Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: cadeia de caracteres |
| href | URL do recurso. Tipo de dados: cadeia de caracteres |
| ID | Identificador exclusivo para o sistema para identificar e processar a carga do alarme como um evento. Tipo de dados : cadeia de caracteres |
| Severidade percebida | Gravidade do alarme. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| planejadoIndicaçãoDeIndisponibilidade | Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: cadeia de caracteres |
| provávelCausa | Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| AçõesDeReparopropostas | Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: cadeia de caracteres |
| serviçoAfeta | Sinalizador que indica se o alarme afeta o serviço. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| sourceSystemId | ID da instância do alarme de origem. Tipo de dados: cadeia de caracteres |
| Problema específico | Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| estado | Estado do alarme. Valores válidos:
Pronto.Se o estado for Valor padrão: Pronto Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Este exemplo recupera todos os alarmes.
curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'Corpo da resposta.
[
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "sdfgds",
"indicatorUnit": "asdfdsaf",
"observedValue": "adsfds",
"thresholdId": "12fasdfasdfasd",
"thresholdCrossingDescription": "S23rtring",
"thresholdRef": "asdfasf"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
"id": "001a0ca629078d10f87759e2f69e4c64_2212331"
},
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "sdfgds",
"indicatorUnit": "asdfdsaf",
"observedValue": "adsfds",
"thresholdId": "12fasdfasdfasd",
"thresholdCrossingDescription": "S23rtring",
"thresholdRef": "asdfasf"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001c84aa29078d10f87759e2f69e4cfa_2212331",
"id": "001c84aa29078d10f87759e2f69e4cfa_2212331"
}
]API aberta de gestão de alarmes – GET /sn_ind_tmf642/alarm_mgmt/alarm/{id}
Recupera um registro de alarme especificado da tabela Eventos [em_event] ou Alerta [em_alert].
Formato da URL
URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| ID | Identificador exclusivo do registro a ser recuperado. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| campos | Lista de campos a serem retornados na resposta. Campos inválidos são ignorados. Campos válidos:
Valor padrão: todos os campos Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 200 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação Incorreta. Um tipo de solicitação incorreto ou solicitação malformada foi detectado por um ou mais dos motivos a seguir.
|
| 404 | Registro não encontrado. Um registro associado ao ID especificado não foi encontrado na tabela Evento [em_event] ou Alerta [em_alert]. |
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| Serviçoafetado | Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz |
| Serviçoafetado.href | Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: cadeia de caracteres |
| affectedService.id | Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: cadeia de caracteres |
| detalhesdoalarme | Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObject | Detalhes do objeto de alarme. Tipo de dados: objeto |
| alarmedObject.id | Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: cadeia de caracteres |
| AlarmedObject.href | Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObjectType | Tipo ou classe de objeto associado ao evento. Tipo de dados: cadeia de caracteres |
| AlarmRaisedTime | Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres |
| AlarmReportingTime | Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elementos (EMS) mantiver a lista de alarmes:
Tipo de dados: cadeia de caracteres |
| tipo de alarme | Categoria de alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformações sobre limite | Detalhes sobre o limite ultrapassado.Tipo de dados: objeto |
| CrossThresholdInformation.direction | Direção de cruzamento do limite. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.granularidade | Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, 5MINUTES.Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.IndicatorName | Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.indicadorUnidade | Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.observadoValue | Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdCrossingDescription | Mais detalhes do limite do alarme de ultrapassagem de limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdId | Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdRef | URL do objeto de limite. Tipo de dados: cadeia de caracteres |
| externalAlarmId | Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: cadeia de caracteres |
| href | URL do recurso. Tipo de dados: cadeia de caracteres |
| ID | Identificador exclusivo para o sistema para identificar e processar a carga do alarme como um evento. Tipo de dados: cadeia de caracteres |
| Severidade percebida | Gravidade do alarme. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| planejadoIndicaçãoDeIndisponibilidade | Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: cadeia de caracteres |
| provávelCausa | Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| AçõesDeReparopropostas | Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: cadeia de caracteres |
| serviçoAfeta | Sinalizador que indica se o alarme afeta o serviço. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| sourceSystemId | ID da instância do alarme de origem. Tipo de dados: cadeia de caracteres |
| Problema específico | Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| estado | Estado do alarme. Valores válidos:
Pronto.Se o estado for Valor padrão: Pronto Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Este exemplo recupera um alarme.
curl "https://instance.servicenow.com/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Corpo da resposta.
{
"externalAlarmId": "2212331",
"alarmType": "QualityOfServiceAlarm23",
"perceivedSeverity": "MAJOR",
"probableCause": "ProbB",
"sourceSystemId": "checkSB",
"alarmedObject": {
"id": "vManage_000000",
"href": " http://api/alarmedobject/000000"
},
"crossedThresholdInformation": {
"direction": "111",
"granularity": "1234",
"indicatorName": "ind_name",
"indicatorUnit": "ind_unit",
"observedValue": "232",
"thresholdId": "200",
"thresholdCrossingDescription": "sample_description",
"thresholdRef": "sample_ref"
},
"type": "QualityOfServiceAlarm",
"ackState": "acknowledged",
"specificProblem": "Inbound Traffic threshold crossed",
"alarmedObjectType": "ROUTER",
"alarmDetails": "Software Failure on SD-WAN Controller vManage_000000",
"state": "processed",
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"proposedRepairActions": "Switch in standby equipment",
"alarmReportingTime": "2017-06-15T07:04:15.666Z",
"alarmRaisedTime": "2020-09-15T14:04:15.000Z",
"plannedOutageIndication": "IN_SERVICE",
"serviceAffecting": true,
"affectedService": [
{
"id": "SD WAN Enterprise Solutions",
"href": "http://api/service/vlan_dot0_dot0"
},
{
"id": "Santa Clara SD WAN Application Service",
"href": "http://api/service/vlan_dot0_dot0"
}
],
"source": "Alarm Management Open API",
"href": "/api/sn_ind_tmf642/alarm_mgmt/alarm/001a0ca629078d10f87759e2f69e4c64_2212331",
"id": "001a0ca629078d10f87759e2f69e4c64_2212331"
}API aberta de gestão de alarmes – PATCH /sn_ind_tmf642/alarm_mgmt/alarm/{id}
Atualiza um alarme especificado e qualquer alerta associado.
Este endpoint grava o corpo da resposta no campo Informações adicionais do registro de evento na tabela Eventos [em_event].
Formato da URL
URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| ID | Identificador exclusivo do registro a ser atualizado. Localizado no campo Chave de mensagem na tabela Eventos [em_event]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Serviçoafetado | Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz |
| Serviçoafetado.href | Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: cadeia de caracteres |
| affectedService.id | Obrigatório. Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: cadeia de caracteres |
| AlarmChangedTime | Indica a última data e hora em que o alarme foi alterado no sistema proprietário do alarme. Qualquer mudança no alarme atualiza este valor, seja proveniente do recurso com alarme ou acionado por uma mudança do cliente. Tipo de dados: cadeia de caracteres |
| detalhesdoalarme | Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres |
| alarmeEscalação | Sinalizador que indica uma escalação na gravidade do alarme. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| cruzadoInformações sobre limite | Detalhes sobre o limite ultrapassado.Tipo de dados: objeto |
| CrossThresholdInformation.direction | Direção de cruzamento do limite. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.granularidade | Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, 5MINUTES.Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.IndicatorName | Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.indicadorUnidade | Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.observadoValue | Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdCrossingDescription | Mais detalhes do limite do alarme de ultrapassagem de limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdId | Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdRef | URL do objeto de limite. Tipo de dados: cadeia de caracteres |
| href | Referência de URL para o alarme. Tipo de dados: cadeia de caracteres |
| Severidade percebida | Obrigatório. Gravidade do alarme. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| planejadoIndicaçãoDeIndisponibilidade | Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: cadeia de caracteres |
| provávelCausa | Obrigatório. Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| AçõesDeReparopropostas | Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: cadeia de caracteres |
| serviçoAfeta | Sinalizador que indica se o alarme afeta o serviço. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| Problema específico | Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 201 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. Possíveis motivos:
|
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| AlarmChangedTime | Data e hora em que o alarme foi alterado em GMT no sistema proprietário do alarme. Este valor está no formato GlideDateTime e está no campo Time of event de um registro na tabela Eventos [em_events]. Este valor é atualizado quando ocorrem mudanças no alarme do recurso com alarme ou uma mudança de uma atualização do cliente aciona o alarme. Este valor é necessário na resposta. Tipo de dados: cadeia de caracteres |
| href | Referência de URL para o alarme. Tipo de dados: cadeia de caracteres |
| ID | Identificador exclusivo do alarme. Valor determinado pelo sistema proprietário do alarme. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Neste exemplo, a gravidade é reduzida para MINOR.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"href\":\"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00\",
\"externalAlarmId\":\"<external-alarm-id>\",
\"alarmType\":\"QualityOfServiceAlarm\",
\"type\":\"QualityOfServiceAlarm\",
\"ackState\":\"acknowledged\",
\"perceivedSeverity\":\"MINOR\",
\"probableCause\":\"Threshold crossed\",
\"specificProblem\":\"Inbound Traffic threshold crossed\",
\"alarmedObjectType\":\"ROUTER\",
\"alarmedObject\":{
\"id\":\"vManage_000000\",
\"href\":\" http://api/alarmedobject/000000\"
},
\"sourceSystemId\":\"SOURCE_SYSTEM_vManage_00000_000_00\",
\"alarmDetails\":\"Software Failure on SD-WAN Controller vManage_000000\",
\"alarmEscalation\": false,
\"state\":\"RAISED\",
\"alarmChangedTime\":\"2017-08-15T07:04:15.666Z\",
\"proposedRepairActions\":\"Switch in standby equipment\",
\"alarmReportingTime\":\"2017-06-15T07:04:15.666Z\",
\"alarmRaisedTime\":\"2020-09-15T07:04:15.666Z\",
\"plannedOutageIndication\":\"IN_SERVICE\",
\"serviceAffecting\":true,
\"affectedService\":[
{
\"id\":\"SD WAN Enterprise Solutions\",
\"href\":\"http://api/service/vlan_dot0_dot0\"
},
{
\"id\":\"Santa Clara SD WAN Application Service\",
\"href\":\"http://api/service/vlan_dot0_dot0\"
}
]
}" \
--user 'user:'password'Corpo da resposta.
{
"result": {
"alarmChangedTime": "2017-08-15T07:04:15.666Z",
"id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
}
}API aberta de gestão de alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm
Cria um registro de alarme na tabela Eventos [em_event].
Quando o registro do alarme é criado, um ID para o alarme é adicionado ao campo Message key.
Um registro de alerta também pode ser criado com base nas regras de gerenciamento de alertas.
Este endpoint grava o corpo da resposta no campo Informações adicionais do registro de evento na tabela Eventos [em_event].
Formato da URL
URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| Serviçoafetado | Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz |
| Serviçoafetado.href | Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: cadeia de caracteres |
| affectedService.id | Obrigatório. Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: cadeia de caracteres |
| detalhesdoalarme | Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObject | Obrigatório. Detalhes do objeto de alarme. Tipo de dados: objeto |
| alarmedObject.id | Obrigatório. Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: cadeia de caracteres |
| AlarmedObject.href | Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObjectType | Tipo ou classe de objeto associado ao evento. Tipo de dados: cadeia de caracteres |
| AlarmRaisedTime | Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres |
| AlarmReportingTime | Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elementos (EMS) mantiver a lista de alarmes:
Tipo de dados: cadeia de caracteres |
| tipo de alarme | Obrigatório. Categoria de alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformações sobre limite | Detalhes sobre o limite ultrapassado.Tipo de dados: objeto |
| CrossThresholdInformation.direction | Direção de cruzamento do limite. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.granularidade | Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, 5MINUTES.Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.IndicatorName | Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.indicadorUnidade | Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.observadoValue | Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdCrossingDescription | Mais detalhes do limite do alarme de ultrapassagem de limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdId | Obrigatório. Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdRef | URL do objeto de limite. Tipo de dados: cadeia de caracteres |
| externalAlarmId | Obrigatório. Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: cadeia de caracteres |
| ID | Identificador exclusivo para o sistema para identificar e processar a carga do alarme como um evento. Este valor deve estar vazio se for usado na carga útil. O sistema gera este ID exclusivo para o evento e o envia como parte da carga de resposta. Tipo de dados: cadeia de caracteres |
| Severidade percebida | Obrigatório. Gravidade do alarme. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| planejadoIndicaçãoDeIndisponibilidade | Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: cadeia de caracteres |
| provávelCausa | Obrigatório. Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| AçõesDeReparopropostas | Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: cadeia de caracteres |
| serviçoAfeta | Sinalizador que indica se o alarme afeta o serviço. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| sourceSystemId | Obrigatório. ID da instância do alarme de origem. Tipo de dados: cadeia de caracteres |
| Problema específico | Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| estado | Estado do alarme. Valores válidos:
Pronto.Se o estado for Valor padrão: Pronto Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Cabeçalho | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 201 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. Possíveis motivos:
|
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| Serviçoafetado | Lista de objetos que identificam um ou mais serviços afetados pelo alarme. Tipo de dados: matriz |
| Serviçoafetado.href | Referência de URL que fornece detalhes do serviço afetado. Tipo de dados: cadeia de caracteres |
| affectedService.id | Identificador do serviço afetado pelo alarme. Este valor é mapeado para o item de configuração (IC) afetado no alerta. Tipo de dados: cadeia de caracteres |
| detalhesdoalarme | Detalhes adicionais sobre o alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObject | Detalhes do objeto de alarme. Tipo de dados: objeto |
| AlarmedObject.id | Identificador exclusivo do objeto de alarme. Este valor é mapeado para um IC no sistema. Tipo de dados: cadeia de caracteres |
| AlarmedObject.href | Referência de URL para obter os detalhes do objeto de alarme. Tipo de dados: cadeia de caracteres |
| AlarmedObjectType | Tipo ou classe de objeto associado ao evento. Tipo de dados: cadeia de caracteres |
| AlarmRaisedTime | Data e hora em que o alarme ocorre em sua origem. Tipo de dados: cadeia de caracteres |
| AlarmReportingTime | Data e hora em que o OSS relata seu alarme. Este valor pode ser diferente do valor alarmRaisedTime. Por exemplo, se um sistema de gestão de elementos (EMS) mantiver a lista de alarmes:
Tipo de dados: cadeia de caracteres |
| tipo de alarme | Categoria de alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformações sobre limite | Detalhes sobre o limite ultrapassado.Tipo de dados: objeto |
| CrossThresholdInformation.direction | Direção de cruzamento do limite. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.granularidade | Granularidade na qual o indicador é avaliado para ultrapassar o limite. Por exemplo, 5MINUTES.Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.IndicatorName | Nome do indicador que ultrapassa o limite do alarme. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.indicadorUnidade | Unidade de medida do indicador correspondente ao limite ultrapassado. Tipo de dados: cadeia de caracteres |
| cruzadoInformaçõesDeLimite.observadoValue | Número que identifica o indicador que ultrapassou o limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdCrossingDescription | Mais detalhes do limite do alarme de ultrapassagem de limite. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdId | Identificador exclusivo do limite que causou o alarme. Tipo de dados: cadeia de caracteres |
| CrossThresholdInformation.thresholdRef | URL do objeto de limite. Tipo de dados: cadeia de caracteres |
| externalAlarmId | Identificador exclusivo do alarme do sistema de origem que publica o alarme. Tipo de dados: cadeia de caracteres |
| href | URL do recurso. Tipo de dados: cadeia de caracteres |
| ID | Identificador exclusivo para o sistema para identificar e processar a carga do alarme como um evento. Tipo de dados: cadeia de caracteres |
| Severidade percebida | Gravidade do alarme. Valores possíveis:
Tipo de dados: cadeia de caracteres |
| planejadoIndicaçãoDeIndisponibilidade | Indica que o objeto gerenciado para este alarme está em um estado de indisponibilidade planejada. Por exemplo, manutenção planejada ou fora de serviço. Tipo de dados: cadeia de caracteres |
| provávelCausa | Situação mais provável para acionar o alarme. Use com alarmType para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| AçõesDeReparopropostas | Se disponível para o sistema, fornece uma ação de reparo para resolver o problema que aciona o alarme. Tipo de dados: cadeia de caracteres |
| serviçoAfeta | Sinalizador que indica se o alarme afeta o serviço. Valores válidos:
Padrão: falso Tipo de dados: booliano |
| sourceSystemId | ID da instância do alarme de origem. Tipo de dados: cadeia de caracteres |
| Problema específico | Problema específico que aciona o alarme. Use com probableCause para qualificar o alarme. Tipo de dados: cadeia de caracteres |
| estado | Estado do alarme. Valores válidos:
Pronto.Se o estado for Valor padrão: Pronto Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Este exemplo cria um alarme.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
"href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
"externalAlarmId":"<external-alarm-id>",
"alarmType":"QualityOfServiceAlarm",
"type":"QualityOfServiceAlarm",
"ackState":"acknowledged",
"perceivedSeverity":"CRITICAL",
"probableCause":"Threshold crossed",
"specificProblem":"Inbound Traffic threshold crossed",
"alarmedObjectType":"ROUTER",
"alarmedObject":{
"id":"vManage_000000",
"href":" http://api/alarmedobject/000000"
},
"sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
"alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
"state":"RAISED",
"alarmChangedTime":"2017-08-15T07:04:15.666Z",
"proposedRepairActions":"Switch in standby equipment",
"alarmReportingTime":"2017-06-15T07:04:15.666Z",
"alarmRaisedTime":"2020-09-15T07:04:15.666Z",
"plannedOutageIndication":"IN_SERVICE",
"serviceAffecting":true,
"affectedService":[
{
"id":"SD WAN Enterprise Solutions",
"href":"http://api/service/vlan_dot0_dot0"
},
{
"id":"Santa Clara SD WAN Application Service",
"href":"http://api/service/vlan_dot0_dot0"
}
]
}" \
--user 'user':'password'Corpo da resposta.
{
"href":"http://api/alarm/ROUTER_IF@Cisco-0000-0-0-0-0-00-00-0-- Xz0/00@00",
"externalAlarmId":"<external-alarm-id>",
"alarmType":"QualityOfServiceAlarm",
"type":"QualityOfServiceAlarm",
"ackState":"acknowledged",
"perceivedSeverity":"CRITICAL",
"probableCause":"Threshold crossed",
"specificProblem":"Inbound Traffic threshold crossed",
"alarmedObjectType":"ROUTER",
"alarmedObject":{
"id":"vManage_000000",
"href":" http://api/alarmedobject/000000"
},
"sourceSystemId":"SOURCE_SYSTEM_vManage_00000_000_00",
"alarmDetails":"Software Failure on SD-WAN Controller vManage_000000",
"state":"RAISED",
"alarmChangedTime":"2017-08-15T07:04:15.666Z",
"proposedRepairActions":"Switch in standby equipment",
"alarmReportingTime":"2017-06-15T07:04:15.666Z",
"alarmRaisedTime":"2020-09-15T07:04:15.666Z",
"plannedOutageIndication":"IN_SERVICE",
"serviceAffecting":true,
"affectedService":[
{
"id":"SD WAN Enterprise Solutions",
"href":"http://api/service/vlan_dot0_dot0"
},
{
"id":"Santa Clara SD WAN Application Service",
"href":"http://api/service/vlan_dot0_dot0"
}
]
}API aberta de gestão de alarmes – POST /sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear
Limpa um alarme especificado e fecha qualquer alerta associado.
Formato da URL
URL padrão: /api/sn_ind_tmf642/alarm_mgmt/alarm/{id}/clear
Parâmetros de solicitação compatíveis
| Nome | Descrição |
|---|---|
| ID | Identificador exclusivo do alarme a ser limpo. Localizado no campo Chave de mensagem na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
| Nome | Descrição |
|---|---|
| alarmeClearedTime | Data e hora em que o alarme é apagado na origem. Este valor está no campo Time of event do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
| limparSystemId | Obrigatório. Nome da instância da qual a operação alarmCleared foi invocada. Tipo de dados: cadeia de caracteres |
| limparUsuárioId | Obrigatório. ID exclusivo do usuário que invocou a operação alarmCleared. Este valor está no campo Source do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
Cabeçalhos
Os cabeçalhos de solicitação e resposta a seguir se aplicam somente a esta ação HTTP ou se aplicam a esta ação de maneira distinta. Para obter uma lista de cabeçalhos gerais usados na REST API, consulte Cabeçalhos de REST API compatíveis.
| Cabeçalho | Descrição |
|---|---|
| Aceitar | Formato de dados do corpo da resposta. Oferece suporte somente a application/json. |
| Tipo de conteúdo | Formato de dados do corpo da solicitação. Oferece suporte somente a application/json. |
| Nome | Descrição |
|---|---|
| Nenhum(a) |
Códigos de status
Os seguintes códigos de status se aplicam a esta ação HTTP. Para obter uma lista de códigos de status possíveis usados na REST API, consulte Códigos de resposta HTTP de REST API.
| Código de status | Descrição |
|---|---|
| 201 | Bem-sucedido. A solicitação foi processada com sucesso. |
| 400 | Solicitação incorreta. Possíveis motivos:
|
Parâmetros do corpo da resposta (JSON)
| Nome | Descrição |
|---|---|
| alarmeClearedTime | Data e hora em que o alarme é apagado na origem. Este valor está no campo Time of event do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
| limparSystemId | Nome da instância da qual a operação alarmCleared foi invocada. Tipo de dados: cadeia de caracteres |
| limparUsuárioId | ID exclusivo do usuário que invocou a operação alarmCleared. Este valor está no campo Source do registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
| href | URL do alarme. Tipo de dados: cadeia de caracteres |
| ID | ID exclusivo no campo Message key de um registro na tabela Eventos [em_events]. Tipo de dados: cadeia de caracteres |
Solicitação de cURL
Este exemplo limpa um alarme.
curl "https://<instance>.service-now.com/api/sn_ind_tmf642/alarm_mgmt/alarm/6e116bb8db09201087b9a8394b961950_<external-alarm-id>/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"alarmClearedTime\": \"2017-08-15 06:04:15\",
\"clearSystemId\": \"<source_instance_name>\",
\"clearUserId\": \"SOURCE_SYSTEM_vManage_00000_000_00\"
}" \
--user 'user':'password'Corpo da resposta.
{
"result": {
"alarmClearedTime": "2017-08-15 06:04:15",
"clearSystemId": "<source_instance_name>",
"clearUserId": "SOURCE_SYSTEM_vManage_00000_000_00",
"id": "6e116bb8db09201087b9a8394b961950_<external-alarm-id>"
}
}