与收集器集成
订购API允许为与选定资产的环境和运行状态有关的事件建立通信信道目的地。它支持AWS物联网核心，Azure事件中心和Webhook通信通道。
您还可以创建订阅并在Equinix API中访问您的数据。有关说明，请参阅Equinix API中的Colocation数据流。
Equinix mTLS 证书
MTLS证书用作TLS (以前的SSL)证书的扩展，以供服务器和客户端相互验证。Equinix要求客户端提供此受信任的签名证书，类似于我们的服务提供的证书。我们的订阅服务为您提供额外的连接验证选项。每次通信尝试发送新一批事件时，我们的订阅服务会使用客户端提供的证书来验证我们发送数据的服务是否正确。
要检索证书，请向终结点发送GET请求/smartview/v2/streaming/subscriptions/certificate。将通道目标指定为查询参数，AWS_IOT_CORE或WEBHOOK。
cURL 请求示例：
curl -X 'GET' 'https://api.equinix.com/smartview/v2/streaming/subscriptions/certificate?channelType=WEBHOOK' \
-H 'Authorization: Bearer <Bearer Token>'
订阅API不接受自签名证书。使用CA证书进行相互身份验证。
AWS IoT
通过在创建订阅时提供HTTP端点, 将数据发送到AWS物联网核心。
要授权Equinix将事件发送到AWS物联网核心目标，您必须下载Equinix证书并在物联网核心控制台中注册。有关说明，请参阅AWS物联网核心文档。
Azure 事件中心
将数据发送到Azure事件中心的自助服务配置不可用。要启用向Azure发送数据, 请联系支持部门。
网络钩子
如果您不希望将AWS或Azure用作收集器, 但您可以提供可将流数据发送到的目标URL, 则Equinix提供创建订阅以将数据发送到通用webhook目标。
收藏夹对象格式
AWS物联网核心和Azure事件中心通道的消息格式使消息更易于阅读。下面是一些通过API Plus订阅发送的消息示例。
环境温度
{
"type": "environmental",
"data": {
"ibx": "CH2",
"asset": {
"id": "asset1",
"level": "ZONE"
},
"reading": {
"value": "23.300",
"unit": "CELSIUS"
},
"tag": {
"id": "temperature",
"displayName": "Temperature"
},
"readingTime": "2020-08-24T09:21:00.000Z"
}
}
环境湿度
{
"type": "environmental",
"data": {
"ibx": "CH1",
"asset": {
"id": "asset1",
"level": "ZONE"
},
"reading": {
"value": "66.120",
"unit": "PERCENT"
},
"tag": {
"id": "humidity",
"displayName": "Humidity"
},
"readingTime": "2020-07-28T12:35:14.615Z"
}
}
电源
{
"type": "power",
"data": {
"ibx": "SP2",
"asset": {
"id": "0210:469593",
"type": "CIRCUIT"
},
"cage": "ssxxxxsss",
"cabinet": "SP2:01:021470:0210",
"accountNumber": "1000659151",
"realPower": {
"value": "0.522",
"unit": "kW"
},
"apparentPower": {
"value": "1.070",
"unit": "kVA"
},
"contractualPower": {
"value": "60.000",
"unit": "kVA"
},
"current": {
"value": "1.500",
"unit": "A"
},
"powerFactor": {
"value": "0.48",
"unit": "pf"
},
"soldCurrent": {
"value": "15.000",
"unit": "A"
},
"soldPower": {
"value": "2.880",
"unit": "kVA"
},
"powerConsumptionToContractual": {
"value": "32.151",
"unit": "PERCENT"
},
"cabinetRating": {
"value": "123.300",
"unit": "kVA"
},
"peakLastSevenDays": {
"value": "1.146",
"unit": "kVA"
},
"peakLastSevenDaysRatio": {
"value": "34.424",
"unit": "PERCENT"
},
"peakLastSevenDaysContractualPower": {
"value": "3.329",
"unit": "kVA"
},
"peakLastSevenDaysTime": "2020-07-29T07:00:00.000Z",
"lastUpdated": "2020-07-24T11:46:00.000Z",
"readingTime": "2020-07-24T11:45:00.000Z",
"description": "test description",
"oid": "1.3.6.1.2.1.299.2.10.6846",
"circuitType": "primary",
"customerName": "test customer"
}
}
计量功率 - 千瓦时
{
"type": "metered-power",
"data": {
"ibx": "LD9",
"asset": {
"id": "LD9.CBM-PDU-17-99",
"type": "Customer Billing Meter"
},
"cage": "LD9:0G:00Z13Z",
"cageSerialNo": "00Z13B-21010567",
"accountNumber": "1000006212",
"customerName": "ABC Company",
"kilowattHour": {
"value": "304574.323",
"unit": "kWh"
},
"readingTime": "2023-04-24T11:45:00.000Z",
"dataQuality": "Good"
}
}
注意：计量功率读数以kWh，kW，kVA，a和pf (功率因数)为单位提供。
标签点
{
"type": "tag-point",
"data": {
"ibx": "LA1",
"reading": {
"value": "33406.6",
"unit": "l/s"
},
"tag": {
"id": "LA1.Air-Handler-7-4-4:totalsupplyairflow",
"displayName": "Total Supply Air Flow"
},
"readingTime": "2020-08-24T09:21:00.000Z"
}
}
自定义警报
{
"type": "alert",
"data": {
"ibx": "SG2",
"region": "APAC",
"asset": {
"id": "CH1.Colo.CH1_05_000550_0105",
"type": "ENVIRONMENTAL",
"classification": "Environmental"
},
"tag": {
"id": "temperature"
},
"threshold": {
"unit": "CELSIUS",
"maxValue": "-6.67",
"minValue": "-12.22"
},
"id": "zhe-15603221441540.3171591127612322145",
"triggeredTime": "2019-09-23T23:01:30.655Z",
"type": "environmental",
"typeId": "Absolute",
"conditional": "N",
"eventType": "Out of Range",
"heartbeat": false
}
}
系统警报
{
"type": "system-alert",
"data": {
"ibx": "SG2",
"region": "APAC",
"metro": "SG",
"country": "SG",
"currentValue": {
"unit": "kWh",
"value": "2.650479E7",
"type": "float"
},
"asset": {
"id": "9SG2.ELEC4AUPSR-A10ASBF0",
"type": "Circuit Breaker with Metering",
"classification": "Electrical"
},
"tag": {
"id": "SG2.ELEC5BUPSR-B14UAH2Q:breaker",
"displayName": "Bypass Not Available"
},
"conditionName": "Low",
"status": {
"acknowledged": true,
"acknowledgementTime": "2020-07-28T12:35:14.615Z",
"cleared": false,
"active": false
},
"threshold": {
"unit": "kWh",
"stateLimit": "80",
"message": "Drive not in Auto"
},
"severity": 820,
"triggeredTime": "2020-07-28T12:35:14.615Z",
"processedTime": "2020-07-28T12:35:14.615Z",
"normalProcessedTime": "2020-07-28T12:35:14.615Z",
"normalTriggeredTime": "2020-07-28T12:35:14.615Z",
"type": "Digital",
"heartbeat": false
}
}
数据质量指标
该字段dataQuality提供数据点和警报(系统和自定义)的数据质量指标(DQI)，作为数据本身的一部分。这用于确保并通知API客户端DCIM资产的数据有效且可靠地收集。增加DQI可提高所收到数据质量的透明度。
存储转发指示器
存储和转发指示器(SNFI)字段messageRetried用于通信DCIM数据实际上接近实时或延迟，并且由于通过NRT通道的连接中断而在稍后发送。如果订阅客户端和发布者之间的连接出现问题，发布者将使用存储和转发(SNF)机制将邮件存储在发布者一侧。重新建立连接后，这些存储的消息和NRT事件将在建立连接时间后发送到客户端。由于SNFI方法而稍后发送的数据会被标记，因为与其他正常数据相比，它们不再是NRT数据。
您的 API 应用程序可以根据这两个指标制定业务规则和决策，从而提高数据透明度和解决方案效率。
{
"messageRetried": true,
"type": "tag-point",
"data": {
"ibx": "SG2",
"reading": {
"value": "54.0",
"unit": "s"
},
"tag": {
"id": "SG2.UPS-5-RM A22-04:batterytimeremaining",
"displayName": "Battery Time Remaining"
},
"readingTime": "2021-03-25T03:48:00.510Z",
"dataQuality": "Good"
}
}
解释枚举值和布尔值
可以提供一个 Excel 表格，其中包含类似于以下列：
| IBX | 资产类型 | 资产分类 | 资产ID | 标签后缀 | 标签 ID | 标签数据类型 | 标签单位 | 标签显示名称 | 状态表名称 |
|---|---|---|---|---|---|---|---|---|---|
| TR5 | 火灾，烟雾检测 | 机械 | TR5.火警_001 | 警报 | TR5.火警_001：警报 | 布尔值 | 警报 | 正常警报 | |
| TR5 | 泄漏检测 | 机械 | TR5.LD_TR5_CABLE1 | 检测到泄漏 | TR5.LD_TR5_CABLE1：检测到泄漏 | 布尔值 | 检测到泄漏 | 正常警报 | |
| TR5 | UPS | 电气 | TR5.UPS_2110 | 弹性 | TR5.UPS_2110：弹性 | 布尔值 | 有弹性的 | REDUCEDRESIL_RESILASDESIGNED |
对于布尔值和枚举值，当第一个值(, ) REDUCEDRESIL对应0，而第二个值(, )ALARM RESILASDESIGNED对应时，NORMAL请参考STATE_TABLE_NAME``1。
API 调用频率
对于Power API，对于亚太地区的数据中心，每隔5分钟呼叫一次，对于其他地区，每隔15分钟呼叫一次。限制为每个用户每天100,000次呼叫。
对于Subscriptions API (REST收集方法)，每个订阅ID大约每隔30秒调用一次。每5分钟拨打一次就足够了。