# Tipos de eventos e objetos Estes são os eventos e objetos digitados oferecidos pelas APIs de streaming. As informações sobre formatos específicos do coletor de dados estão na página[Integração com um coletor](https://docs.equinix.com/pt-BR/smart-view/sv-api/integrating-with-collector.md#object-formats-for-collectors). ## Tipos de evento[​](#tipos-de-evento "Link direto para Tipos de evento") ### Alarme atualizado[​](#alarme-atualizado "Link direto para Alarme atualizado") O `alarm_updated` evento indica que um alarme foi atualizado. O `alarm_active` evento é enviado quando um alarme é ativado. Ele é enviado para todas as contas de usuário conectadas ao alarme. A `alarm` propriedade é um [objeto de alarme](#alarm) que contém informações sobre o alarme. ``` { "name": "alarm_active", "alarm": { ... } } ``` ### Notificações de pulsação[​](#notificações-de-pulsação "Link direto para Notificações de pulsação") Os eventos do Heartbeat são enviados semanalmente e oferecem detalhes das notificações do Heartbeat em todos os alertas inscritos. Eles criam consciência da comunicação eficaz entre o cliente de streaming e o provedor de eventos de streaming da Equinix. Exemplo de notificação de pulsação - alerta do sistema ``` ‌‌"@type" : "Alarm", "data" : { "sysAlertDefinitionId" : "PA4.Generator-C:summary:Multi-State:Alarm:3", "assetid" : "PA4.Generator-C", "ibx" : "PA4", "tagdisplayname" : "Summary", "sysAlertTriggerRule" : "STOPPED, NOT IN AUTO, ALARM", "heartbeat" : "true" }, "name" : "alarm_updated" } ``` Exemplo de notificação de Heartbeat - alerta personalizado ``` "@type" : "Alert", "data" : { "alertid" : "513709-15960581055100.6171420183265794", "timetriggered" : "1596058401201", "alerttype" : "electrical", "customerid" : "1000006198", "ibx" : "PA4", "heartbeat" : "true", "thresholdvalue" : "0" } ``` ### Atualizações de ambiente[​](#atualizações-de-ambiente "Link direto para Atualizações de ambiente") Dados ambientais foram atualizados ou recebidos. O `environment_updated` evento é enviado quando os dados do ambiente são atualizados ou calculados. Ele é visível para todas as contas que têm gaiola ou gabinete no local relacionado às informações do ambiente. A `environmentData` propriedade é um [objeto EnvironmentData](#environmentdata) que contém as informações do ambiente. ``` { "name": "environment_updated", "data": { ... } } ``` ### Sensores ambientais[​](#sensores-ambientais "Link direto para Sensores ambientais") Isso fornece atualizações para eventos de temperatura e umidade disponíveis para sensores ambientais por meio de sua classificação relevante para uma gaiola em um IBX, como visto na `tag_id`. Essas leituras do sensor (valor, u/m) para contas de dentro de zonas específicas do IBX podem ser adquiridas com um carimbo de data/hora. Exemplo: ``` Received message 1410591350247580: Data: {"@type":"Tagpoint","data":{"value":"45","tagId":"PA4.Environmental.DH-10:humidity","tagDisplayName":"Humidity","uom":"%","readingTime":1596831714128,"oid":"1.3.6.1.2.1.299.37.7.1191.24"},"name":"tagpoint_updated"} Attributes: [object Object] ``` ### Poder atualizado[​](#poder-atualizado "Link direto para Poder atualizado") Dados de consumo de energia foram atualizados ou recebidos. O `power_updated` evento é enviado quando os dados de consumo de energia são recebidos ou calculados. Ele é visível para o usuário que tem acesso a contas que possuem os circuitos aos quais os dados de consumo de energia estão relacionados. A `powerData` propriedade é um [objeto PowerData](#powerdata) que contém as informações de consumo de energia ``` { "name": "power_updated", "data": { ... } } ``` ### Tagpoint atualizado[​](#tagpoint-atualizado "Link direto para Tagpoint atualizado") Um valor de tagpoint foi atualizado. Um `tagpoint_updated` evento é enviado quando os dados de um ponto de etiqueta são atualizados. Ele é enviado a todos os usuários que têm visibilidade do tagpoint. A `tagPointData` propriedade é um [objeto TagPointData](#tagpointdata) que contém as informações mais recentes sobre o tagPoint. ``` { "name": "tagpoint_updated", "data": { ... } } ``` ## Tipos de Objetos[​](#tipos-de-objetos "Link direto para Tipos de Objetos") ### Alarme[​](#alarme "Link direto para Alarme") ``` { "type": "object", "description": "alarm object - properties of the alarm", "properties": { "timetriggered": { "type": "string", "description": "time when the criteria for the alarm was met, in epoch (ms)" }, "valuetype": { "type": "string", "description": "data type for the alarm data point value", "enum": [ "Float", "Bool", "Int" ] }, "severity": { "type": "integer", "description": "integer value which describes the severity of the alarm. higher values indicate higher severity\n• 800-899 – Urgent\n• 600-699 – High \n• 400-499 – Low \n• 200-299 – Informational\n" }, "timenormalprocessed": { "type": "string", "description": "time alarm was cleared in the system. \n" }, "circuit": { "type": "string", "description": "circuit number applicable to power alarms" }, "alarmtype": { "type": "string", "description": "alarm type indicates the type of alarm", "enum": [ "digital", "absolute", "deviation", "multi-state" ] }, "tagid": { "type": "string", "description": "tag id linked to the alarm. available for alarms on infra assets. unique identifier for the tag\n" }, "uom": { "type": "string", "description": "unit of measure for the alarm value" }, "cage": { "type": "string", "description": "cage us id linked to the alarm. available with power alarms or environmental alarms\n" }, "timeprocessed": { "type": "string", "description": "time when the alarm was created in the system." }, "assetid": { "type": "string", "description": "asset id linked to the alarm" }, "metro": { "type": "string", "description": "metro id linked to the alarm" }, "accountno": { "type": "string", "description": "customer account number" }, "conditionname": { "type": "string", "description": "condition name for the alarm" }, "region": { "type": "string", "description": "region linked to the alarm" }, "value": { "type": "string", "description": "data point value at which the alarm was triggered" }, "cabinet": { "type": "string", "description": "cabinet us id. applicable for power alarms" }, "assettype": { "type": "string", "description": "Will contain\n• template name for alarms linked to infra assets.\n• \"environmental\" for environmental alarms.\n• \"CIRCUIT\" for power alarms \n" }, "ibx": { "type": "string", "description": "ibx code" }, "status": { "type": "boolean", "description": "indicator whether an alarm is active" }, "assetclassification": { "type": "string", "description": "asset classification", "enum": [ "Electrical", "Mechanical", "Environmental", "Power" ] } } } ``` ### Alerta[​](#alerta "Link direto para Alerta") ``` "AlertCondition": { "type": "object", "properties": { "affectedCustomerAsset": { "type": "null" }, "alertType": { "type": "null" }, "asset": { "type": "string" }, "assetname": { "type": "string" }, "assettype": { "type": "string" }, "condalerttypeid": { "type": "string" }, "condassetclassification": { "type": "string" }, "condassetid": { "type": "string" }, "condcurrentvalue": { "type": "string" }, "condeventtype": { "type": "string" }, "condtagid": { "type": "string" }, "customerAssets": { "type": "null" }, "ibx": { "type": "string" }, "infraAssets": { "type": "null" }, "measurementType": { "type": "null" }, "region": { "type": "null" }, "section": { "type": "string" }, "thresholdUnit": { "type": "string" }, "thresholdValue": { "type": "string" }, "thresholdValueMax": { "type": "string" }, "thresholdValueMin": { "type": "string" }, "uom": { "type": "string" } } }, "AlertType": { "type": "object", "properties": { "defaultValue": { "type": "null" }, "eventType": { "type": "string" }, "id": { "type": "string" }, "tagId": { "type": "null" }, "type": { "type": "string" }, "unit": { "type": "string" }, "value": { "type": "string" } } }, "Alert": { "type": "object", "properties": { "accountNo": { "type": "string" }, "acknowledge": { "type": "boolean" }, "affectedCustomerAsset": { "type": "null" }, "alertType": { "": "#/definitions/AlertType" }, "alertTypeName": { "type": "string" }, "asset": { "type": "string" }, "assetclassification": { "type": "string" }, "assetname": { "type": "string" }, "assettype": { "type": "string" }, "conditionalAlert": { "$ref": "#/definitions/AlertCondition" }, "country": { "type": "string" }, "createdOn": { "type": "null" }, "currentvalue": { "type": "string" }, "eventtype": { "type": "string" }, "ibx": { "type": "string" }, "id": { "type": "string" }, "lastmaintenance": { "type": "string" }, "metro": { "type": "string" }, "modifiedOn": { "type": "null" }, "notificationType": { "type": "string" }, "region": { "type": "string" }, "relatedincidents": { "type": "string" }, "resiliency": { "type": "string" }, "section": { "type": "string" }, "severity": { "type": "string" }, "tagid": { "type": "string" }, "thresholdUnit": { "type": "string" }, "thresholdValue": { "type": "string" }, "thresholdValueMax": { "type": "string" }, "thresholdValueMin": { "type": "string" }, "timeZone": { "type": "string" }, "timeacknowledged": { "type": "string" }, "timeprocessed": { "type": "string" }, "timetriggeredMilisec": { "type": "string" }, "triggeredOn": { "type": "integer" }, "type": { "type": "string" }, "uom": { "type": "string" }, "year": { "type": "string" } } } ``` ### Dados Ambientais[​](#dados-ambientais "Link direto para Dados Ambientais") ``` "EnvironmentData": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code" }, "accountNo": { "type": "string", "description": "account number" }, "zone": { "type": "string", "description": "zone unique space id" }, "cage": { "type": "string", "description": "cage unique space id" }, "cabinet": { "type": "string", "description": "cabinet unique space id" }, "sensor": { "type": "string", "description": "sensor id" }, "temperature": { "type": "string", "description": "current temperature" }, "humidity": { "type": "string", "description": "current humidity" }, "timestamp": { "type": "string", "description": "epoch timestamp when the current reading was read" }, "temperatureUom": { "type": "string", "description": "unit of measure for temperature values" }, "humidityUom": { "type": "string", "description": "unit of measure for humidity" }, "minTemperature": { "type": "string", "description": "minimum temperature for last x(?) hours" }, "maxTemperature": { "type": "string", "description": "maximum temperature for last x(?) hours" }, "minHumidity": { "type": "string", "description": "minimum humidity for last x(?) hours" }, "maxHumidity": { "type": "string", "description": "maximum humidity for last x(?) hours" } } } ``` ### Dados de energia[​](#dados-de-energia "Link direto para Dados de energia") ``` "PowerData": { "type": "object", "properties": { "ibx": { "type": "string", "description": "ibx code" }, "accountNo": { "type": "string", "description": "customer account number" }, "levelType": { "type": "string", "description": "power hierarchy node levelType linked to the power data", "enum": [ "ibx", "cage", "cabinet", "circuit" ] }, "levelValue": { "type": "string", "description": "power hierarchy node levelValue linked to the power data. ibx code, \ncage unique space id, cabinet unique space id and circuit id for \nlevelType ibx, cage, cabinet, circuit resp.\n" }, "isAlarm": { "type": "string" }, "kva": { "type": "number", "description": "power consumption in kva" }, "amps": { "type": "number", "description": "instantaneous current amp reading on circuits" }, "cage": { "type": "string", "description": "cage unique space id" }, "cabinet": { "type": "string", "description": "cabinet unique space id" }, "soldKva": { "type": "number", "description": "maximum amp draw allowable on a circuit" }, "cabinetRating": { "type": "number", "description": "maximum kVA draw allowed for the cabinet" }, "contractualKva": { "type": "number", "description": "The maximum power draw contractually allowable in a \nprivate cage. \n" }, "percentageKva": { "type": "number", "description": "calculated field kva / contractualKva" }, "peakKvaLastSevenDays": { "type": "number" }, "peakKvaLastSevenDaysPercentage": { "type": "number" }, "peakKvaLastSevenDaysContractualKva": { "type": "number" }, "peakKvaLastSevenDaysTime": { "type": "integer" }, "type": { "type": "string", "description": "value to be IBX, CAGE, CABINET, primary or redundant for levelType\nibx, cage, cabinet, circuit resp.\n", "enum": [ "IBX", "CAGE", "CABINET", "primary", "redundant" ] }, "description": { "type": "string", "description": "circuit description when the levelType is circuit. null otherwise. \n" }, "soldAmps": { "type": "integer" }, "primaryKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the primary \ncircuits within the levelType.\n" }, "redundantKva": { "type": "number", "description": "the sum of instantaneous power draw reading on all the redundant \ncircuits within the levelType.\n" }, "kw": { "type": "string", "description": "measure of real power expressed in kilowatt applicable for ibxs\nthat have capability of energy meter reading\n" }, "powerFactor": { "type": "string", "description": "The ratio between real power and apparent power in a circuit.(kW/kVA)\n" }, "readingTime": { "type": "string", "description": "date-time when the latest value was read in (epoc - milliseconds). \n" }, "lastUpdatedTime": { "type": "string", "description": "date-time when the latest value was updated (epoc - milliseconds).\n" }, "customerName": { "type": "string" } } } ``` ### Energia medida[​](#energia-medida "Link direto para Energia medida") ``` "MeteredPower": { "type": "object", "properties": { "ibx": { "type": "string" }, "assetId": { "type": "string" }, "assetSerialNumber": { "type": "string" }, "assetType": { "type": "string" }, "cage": { "type": "string" }, "cageSerialNo": { "type": "string" }, "accountNumber": { "type": "string" }, "customerName": { "type": "string" }, "readingTime": { "type": "string" }, "dataQuality": { "type": "integer" }, "ucid": { "type": "string" }, "kilowattHour": { "type": "number" }, "realPower": { "type": "number" }, "apparentPower": { "type": "number" }, "powerFactor": { "type": "number" }, "current": { "type": "number" } } } ``` ### Dados do ponto de tag[​](#dados-do-ponto-de-tag "Link direto para Dados do ponto de tag") ``` "TagPointData": { "type": "object", "description": "Tag Point is a property of the Asset it is linked to.\n", "properties": { "value": { "type": "string", "description": "Current data value for the tag point\n" }, "tagId": { "type": "string", "description": "ID for the tagPoint - Unique Identifier for the Tag Point\n" }, "tagDisplayName": { "type": "string", "description": "Generic label for the tag point\n" }, "uom": { "type": "string", "description": "Unit of measure for the data value for the tag point\n" }, "alarmStatus": { "type": "string", "description": "Indicates whether there are any alarms currently active for the tag\npoint\n" }, "readingTime": { "type": "string", "format": "date-time", "description": "date time when the tag point value was read from the device. \n" } } } ```