# Tipos de eventos y objetos Estos son el evento y el objeto tipificado que ofrecen las API de streaming. La información sobre formatos específicos de recopiladores de datos se encuentra en la página[Integración con un recopilador](https://docs.equinix.com/es/smart-view/sv-api/integrating-with-collector.md#object-formats-for-collectors). ## Tipos de eventos[​](#tipos-de-eventos "Enlace directo a Tipos de eventos") ### Alarma actualizada[​](#alarma-actualizada "Enlace directo a Alarma actualizada") El `alarm_updated` evento indica que se actualizó una alarma. El `alarm_active` evento se envía cuando se activa una alarma. Se envía a todas las cuentas de usuario conectadas a la alarma. La `alarm` propiedad es un [objeto de alarma](#alarm) que contiene información sobre la alarma. ``` { "name": "alarm_active", "alarm": { ... } } ``` ### Notificaciones de latidos[​](#notificaciones-de-latidos "Enlace directo a Notificaciones de latidos") Los eventos de Heartbeat se envían semanalmente y ofrecen detalles de las notificaciones de Heartbeat en todas las alertas suscritas. Crean conciencia de la comunicación efectiva entre el cliente de streaming y el proveedor de eventos de streaming de Equinix. Ejemplo de notificación de latido - alerta del 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" } ``` Notificación Heartbeat de muestra - alerta personalizada ‌‌ ``` "@type" : "Alert", "data" : { "alertid" : "513709-15960581055100.6171420183265794", "timetriggered" : "1596058401201", "alerttype" : "electrical", "customerid" : "1000006198", "ibx" : "PA4", "heartbeat" : "true", "thresholdvalue" : "0" } ``` ### Actualizaciones medioambientales[​](#actualizaciones-medioambientales "Enlace directo a Actualizaciones medioambientales") Se actualizaron o recibieron datos medioambientales. El `environment_updated` evento se envía cuando se actualizan o calculan los datos del entorno. Es visible para todas las cuentas que tienen jaula o gabinete en la ubicación relacionada con la información del entorno. La `environmentData` propiedad es un [objeto EnvironmentData](#environmentdata) que contiene la información del entorno. ``` { "name": "environment_updated", "data": { ... } } ``` ### Sensores ambientales[​](#sensores-ambientales "Enlace directo a Sensores ambientales") Esto proporciona actualizaciones a los eventos de temperatura y humedad disponibles para los sensores ambientales a través de su clasificación relevante para una jaula en un IBX como se ve en `tag_id`. Estas lecturas de sensores (valor, uom) para cuentas dentro de zonas específicas del IBX se pueden adquirir con una marca de tiempo. Ejemplo: ``` 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] ``` ### Potencia actualizada[​](#potencia-actualizada "Enlace directo a Potencia actualizada") Se han actualizado o recibido datos sobre el consumo de energía. El `power_updated` evento se envía cuando se reciben o calculan los datos de consumo de energía. Es visible para el usuario que tiene acceso a las cuentas que poseen los circuitos a los que se relacionan los datos de consumo de energía. La `powerData` propiedad es un [objeto PowerData](#powerdata) que contiene la información de consumo de energía ``` { "name": "power_updated", "data": { ... } } ``` ### Tagpoint Actualizado[​](#tagpoint-actualizado "Enlace directo a Tagpoint Actualizado") Se ha actualizado un valor de tagpoint. Un `tagpoint_updated` evento se envía cuando se actualiza un dato de tagpoint. Se envía a todos los usuarios que tienen visibilidad al tagpoint. La `tagPointData` propiedad es un [objeto TagPointData](#tagpointdata) que contiene la información más reciente sobre el TagPoint. ``` { "name": "tagpoint_updated", "data": { ... } } ``` ## Tipos de objetos[​](#tipos-de-objetos "Enlace directo a Tipos de objetos") ### Alarma[​](#alarma "Enlace directo a Alarma") ``` { "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 "Enlace directo a 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" } } } ``` ### EnvironmentData[​](#environmentdata "Enlace directo a EnvironmentData") ``` "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" } } } ``` ### PowerData[​](#powerdata "Enlace directo a PowerData") ``` "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" } } } ``` ### MeteredPower[​](#meteredpower "Enlace directo a MeteredPower") ``` "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" } } } ``` ### TagPointData[​](#tagpointdata "Enlace directo a TagPointData") ``` "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" } } } ```