# 与收集器集成 订阅API可为选定资产的环境和运营状态相关事件建立通信通道目标。它支持AWS物联网核心,Azure事件中心和Webhook通信渠道。 > **注意** > > 您还可以创建订阅并在Equinix API中访问您的数据。有关说明,请参阅[来自Equinix API的Colocation数据流](https://docs.equinix.com/zh-Hans/smart-view/sv-api/getoperatinginformation.md)。 ## Equinix mTLS 证书[​](#equinix-mtls-证书 "直接链接至Equinix mTLS 证书") MTLS证书用作TLS (前SSL)证书的扩展,供服务器和客户端进行相互验证。Equinix要求客户提供此受信任签名证书,类似于我们的服务提供的证书。我们的订阅服务为您提供额外的连接验证选项。每次通信尝试发送新一批事件时,我们的订阅服务将使用客户端提供的证书来验证我们要发送数据的服务是否正确无误。 要检索证书,请向端点发送`GET`请求[`/smartview/v2/streaming/subscriptions/certificate`](https://docs.equinix.com/zh-Hans/api-catalog/smartviewv2/streaming-subscription-api/getcertificate.md)。将通道目标指定为查询参数,`AWS_IOT_CORE`或`WEBHOOK`。 cURL 请求示例: ``` curl -X 'GET' 'https://api.equinix.com/smartview/v2/streaming/subscriptions/certificate?channelType=WEBHOOK' \ -H 'Authorization: Bearer ' ``` > **重要提示** > > 订阅API不接受自签名证书。使用CA证书进行相互验证。 ## AWS IoT[​](#aws-iot "直接链接至AWS IoT") 在[创建订阅](https://docs.aws.amazon.com/iot/latest/developerguide/http.html)时提供[HTTP端点](https://docs.equinix.com/zh-Hans/smart-view/sv-api/create-subscription.md#aws-iot-core),将数据发送至AWS物联网核心。 > **注意** > > 要授权Equinix将事件发送至AWS物联网核心目标,您必须下载[Equinix证书](#equinix-mtls-certificate)并在物联网核心控制台中注册。有关说明,请参阅[AWS物联网核心文档](https://docs.aws.amazon.com/iot/latest/developerguide/manual-cert-registration.html)。 ## Azure 事件中心[​](#azure-事件中心 "直接链接至Azure 事件中心") 将数据发送至Azure事件中心的自助配置不可用。向Azure发送数据, 请[联系支持人员](https://docs.equinix.com/zh-Hans/customer-support/opening-support-case.md)。 ## 网络钩子[​](#网络钩子 "直接链接至网络钩子") 如果您不希望使用AWS或Azure作为收集器,但可以提供一个可将流式数据发送到的目标网址,Equinix建议[创建订阅以将数据发送到通用webhook目标](https://docs.equinix.com/zh-Hans/smart-view/sv-api/create-subscription.md#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 | 对于布尔值和枚举值,请参阅`STATE_TABLE_NAME`当第一个值(, `REDUCEDRESIL`)对应时,`0`第二个值(`ALARM`, `RESILASDESIGNED`)对应时`NORMAL``1`。 ## API 调用频率[​](#api-调用频率 "直接链接至API 调用频率") 对于Power API,亚太地区数据中心每隔5分钟致电一次,其他地区每隔15分钟致电一次。限制为每个用户每天100,000个呼叫。 对于订阅API (REST收集方法),每个订阅ID大约每隔30秒调用一次。每5分钟拨打一次就足够了。