# 通知类型 信息传递网关发送的每个通知都有一个通用格式，具体取决于通知类型。通知消息结构在[AsyncAPI文档](https://docs.equinix.com/zh-Hans/api-catalog/emgv1.md)中也有介绍。 Equinix发出的所有消息均包含以下组件： ``` { "Task": {     "Header attribute 1": "",     "Header attribute 2": "",     "Header attribute 3": "",     ...     "Body": {     "Body attribute 1": "",     "Body attribute 2": "",     "Body attribute 3": "",     ...     } }, "Signature": "Base 64 encrypted signature" } ``` 这些标题属性适用于所有订购类型。 * `ID``String``(Guid)`消息的唯一标识符。Equinix将为每条消息发送唯一的值。 * `Source`-`String` `(Guid)`标识消息发件人的唯一值。此值将在上线流程中与客户共享。 * `Verb`-`String`-更新。这表示存在来自Equinix的更新。 * `Resource``String`发送通知的Equinix产品名称。 * `ContentType`-`String`-“application/json” * `CreateTimeUTC`-`String`-表示Equinix发送通知的日期和时间。 * `Version``String`通知架构的版本。 每种通知类型的正文属性都不同。 ## 账单通知 开票通知是在客户订单关闭且 Equinix开始开票时触发的近乎实时的通知。所有 通过线下渠道和在线渠道提交的客户订单，将触发这些通知。 当客户下达的订单开始计费时，经销商也将收到账单通知。 通知示例： ``` { "Task": {     "Id": "la83ef18-5e36-4a2d-9d80-490ee217d004",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "CrossConnnect",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-16T19:57:21.326Z",     "Version": "1.0",     "Body": {     "RequestorId": "",     "ServicerId": "1-205346710865",     "State": "Closed",     "Description": "Order Number:1-205346710865 billing notification",     "LineDetails": [         {         "Id": "1-3N5W5LYZ",         "Ibx": "DC1",         "Status": "Billed",         "BilledLines": [             "1-2N5W4JAS",             "1-2N5W4K87",             "1-2N5W3M21",             "1-2N5235N2"         ]         }     ]     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` 账单通知具有以下正文属性： * `Body`-`Object`包含通知详细信息的对象。对象内的属性将因资源和动词而异。 * `RequestorId`-`String`维护的客户参考编号(如有)。 * `ServicerId`-`String`-表示Equinix为提交订单提供的唯一ID。 * `State`-`String`-表示订单当前状态。支持的值-"已关闭"。 * `Description`-`Object`-来自开票系统的工单概要。 * `LineDetails`-`Array`-包含开票行项目和数据中心详细信息的对象数组： * `Id`-唯一的开票行ID。 * `Ibx`-数据中心/ IBX的名称。 * `Status`-支持的值“已开票”。 * `BilledLines`-`Array[String]`开票行项目列表 ## Fabric通知 信息传递网关支持以下工作流程的 Fabric 通知： * Equinix Fabric端口启动/关闭 * Equinix Fabric虚拟连接启动/关闭 通知示例： ``` { "Task": {     "Id": "bf9f2707-d612-4d63-9958-4c8b1fcf3cc0",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "DataCenter.Network.Port",     "ContentType": "application/json",     "Version": "1.0",     "Body": {      "timestamp":"2020-05-21T10:20:00Z",     "type":"PORT_OPSTATUS_NOTIFICATION",     "uuid":"11c954fb-8e8b-4515-97d7-cc80129a0985",     "description":"Port is not operational. Connections on this port might be affected.",     "data":{         "type":"XF_PORT",         "uuid":"a867f685-41b0-1b07-6de0-320a5c00abdd",         "name":"L2-DEV-USER01-DC5-CX-10G-SECONDARY-NOKIA-02",         "href":"https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",         "operation":{             "operationalStatus":"DOWN",             "opStatusChangedAt":"2020-05-21T10:20:00Z",             "maintenanceMode":false         },         "embedded":{             "connections":{                 "href":[                 "https://api.equinix.com/fabric/v4/connections/8822de74-805f-4f63-b52d-93bcbf2a1d1b",                 "https://api.equinix.com/fabric/v4/connections/8f20bea9-a5b9-47e5-88e6-a899584ebb90"                 ]             }         }     }     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` Fabric 通知具有以下主体属性： * `Body`-`Object`包含通知详细信息的对象。对象内的属性将因资源和动词而异。 * `type`-`String`-表示通知类型。`PORT_OPSTATUS_NOTIFICATION`表示Fabric端口当前处于维护中。`CONNECTION_OPSTATUS_NOTIFICATION`Fabric虚拟连接当前正在维护中。 * `uuid`-`String`-表示Equinix为维护提供的唯一ID。 * `description`-`String`- Equinix技术人员的工单概要。 * `data`-`Object`包含客户端口详细信息的对象。 * `type`-`String`-表示端口类型。`XF_PORT`表示Equinix Fabric端口。`EVPL_VC`表示Equinix Fabric虚拟连接。 * `uuid`-`String`-表示客户端口的唯一ID。 * `name`-`String`-表示客户端口的名称。 * `href`-`String`-链接以获取客户端口的更多详细信息。 * `operation`-`Object`包含与客户端口状态相关的详细信息的对象。 * `operationalStatus`-`String`-表示客户端口的当前状态。 * `opStatusChangedAt`-`String`-表示上次监控客户端口状态的日期和时间。 * `maintenanceMode`-`Boolean`-表示其是计划维护还是计划外维护。 * `embedded`-`Object`包含该客户端口上活动的虚拟连接详情的对象。 * `connections`-`Object`包含该客户端口上活跃的虚拟连接列表的对象。 * `href`-`Array[String]`包含该客户端口上活动的虚拟连接列表的阵列。 ## IBX 通知 IBX通知是任何计划外Equinix IBX数据中心 维护的近乎实时的通知。任何Equinix IBX数据中心事件和 咨询时，也会触发这些通知。 信息传递网关支持以下IBX通知变体： * IBX维护通知 * IBX 事件通知 * IBX 咨询通知 * IBX 安全事件通知 通知示例： ``` { "Task": {     "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "DataCenter.Maintenance",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-09T07:42:45.396Z",     "Version": "1.0",     "Body": {     "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",     "ServicerId": "5-204454471282",     "State": "CONFIRMED",     "Description": "Equinix Test Maintenance",     "Sequence": "2",     "StartDateTime": "2021-03-29T17:33:00",     "EndDateTime": "2021-03-31T18:00:00",     "AccountNumber": "123456",     "Impact": "NON_SERVICE_IMPACTING",     "ProdID": "DataCenter Notification https://developer.equinix.com",     "Organizer": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",     "Assets": []     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ== " } ``` IBX通知具有以下正文属性： * `Body`-`Object`包含通知详细信息的对象。对象内的属性将因资源和动词而异。 * `RequestorId`-`String`维护的客户参考编号(如有)。 * `ServicerId`-`String`-表示Equinix为数据中心维护/事件提供的唯一ID。 * `State``String`工单的当前状态支持值： * `CONFIRMED`-数据中心维护/事件已确认。 * `IN-PROCESS`-数据中心维护/事件当前正在进行中。 * `COMPLETED`-数据中心维护/事件已完成。 * `CANCELLED`-数据中心维护/事件已取消。 * `Description`-`Object`- Equinix技术人员的工单概要。 * `Sequence``Number`递增相关通知的编号。数字从0开始。 * `StartDateTime`-`String`-表示维护的开始日期和时间。 * `EndDateTime`-`String`-表示维护的结束日期和时间。类型为“数据中心”的资源填充此值。“维护”此值将仅为“资源类型-`DataCenter.Incident` `DataCenter.SecurityIncident`”和`DataCenter.Advisory`“州”填充`COMPLETED`。 * `AccountNumber`-`String`-表示与维护活动相关的客户账号。 * `Impact`-`String`-表示由于维护活动或事件而对客户造成影响的级别/严重性。支持的值： * `SERVICE_IMPACTING`-表示影响您服务的活动或事件。 * `NON_SERVICE_IMPACTING`-表示不会中断您的服务的活动或事件, 例如备份服务器在修复后仍能继续运行。 * `ProdID`-`String`-表示参考有关维护活动的更多信息的链接。 * `Organizer`-`String`-表示维护组织者的名称。[Equinix客户支持](https://www.equinix.com/contact-us/customer-support)。 * `Assets`-`Object`-对于类型为“DataCentre.Maintenance.DataCentre.Incident”和“DataCentre.Incident”的资源，将填充此值。包含受影响客户资产详情的对象，其属性包括： * `IBX` * `Cage` * `Cabinet` * `Serial Number` * `Circuit Type` ## 网络通知 网络通知是任何计划外Equinix产品或 服务网络维护的接近实时通知。Equinix产品或服务 网络事件也会触发这些通知。 信息传递网关支持以下网络通知变体 * 网络维护通知 * 网络事件通知 通知示例： ``` { "Task": {     "Id": "370da978-b9bd-4030-b012-9dc97e2fdf98",     "Source": "3e095d30-40ff-11e9-8959-5be078353003",     "Verb": "Update",     "Resource": "Network.Maintenance",     "ContentType": "application/json",     "CreationTimeUTC": "2021-06-09T07:42:45.396Z",     "Version": "1.0",     "Body": {     "RequestorId": "97ae4427-70cb-4162-bf52-c3c7f9d7b2d8",     "ServicerId": "5-204454471282",     "State": "CONFIRMED",     "Description": "Equinix Test Maintenance",     "Sequence": "2",     "StartDateTime": "2021-03-29T17:33:00",     "EndDateTime": "2021-03-31T18:00:00",     "AccountNumber": "123456",     "Impact": "NON_SERVICE_IMPACTING",     "ProdID": "Network Notification https://developer.equinix.com",     "Organizer": "Equinix Customer Support https://www.equinix.com/contact-us/customer-support",     "Assets": []     } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` 网络通知具有以下主体属性： * `Body`-`Object`包含通知详细信息的对象。对象内的属性将因资源和动词而异。 * `RequestorId`-`String`维护的客户参考编号(如有)。 * `ServicerId`-`String`-表示Equinix为网络维护/事件提供的唯一ID。 * `State``String`工单的当前状态支持值： * `CONFIRMED`-数据中心维护/事件已确认。 * `IN-PROCESS`-数据中心维护/事件当前正在进行中。 * `COMPLETED`-数据中心维护/事件已完成。 * `CANCELLED`-数据中心维护/事件已取消。 * `Description`-`Object`- Equinix技术人员的工单概要。 * `Sequence``Number`递增相关通知的编号。数字从0开始。 * `StartDateTime`-`String`-表示维护的开始日期和时间。 * `EndDateTime`-`String`-表示维护的结束日期和时间。类型为“网络.维护”的资源总是填充此值。对于“资源类型”，此值将仅填充为“州`Network.Incident`”。`COMPLETED` * `AccountNumber`-`String`-表示与维护活动相关的客户账号。 * `Impact`-`String`-表示由于维护活动或事件而对客户造成影响的级别/严重性。支持的值： * `SERVICE_IMPACTING`-表示影响您服务的活动或事件。 * `NON_SERVICE_IMPACTING`-表示不会中断您的服务的活动或事件, 例如备份服务器在修复后仍能继续运行。 * `ProdID`-`String`-表示参考有关维护活动的更多信息的链接。 * `Organizer`-`String`-表示维护组织者的名称。[Equinix客户支持](https://www.equinix.com/contact-us/customer-support)。 * `Assets`-`Object`-对于类型为“网络.维护”和“网络.事件”的“资源”，将填充此值。包含受影响客户资产详情的对象，其属性包括： * `IBX` * `Cage` * `Cabinet` * `Serial Number` * `Circuit Type` ## 订单通知 订单通知是通过客户门户网站，API或EMG下达订单的接近实时通知。这些通知提供订单状态的更新，包括创建，排程，更新和完成等各个阶段。 以下类型的订单可接收订单通知： * Cross Connect订单 * 智能手部指令 * 工作访问令 * 发货订单 * 故障单订单 样品订单通知： ``` { "Task": { "Id": "a4f3d7e2-1a6c-4b8d-9e2f-3c5a8b7d9e1f", "Source": "3e095d30-40ff-11e9-8959-5be078353003", "Verb": "Update", "Resource": "SmartHands", "ContentType": "application/json", "CreationTimeUTC": "2021-06-16T19:57:21.326Z", "Version": "1.0", "Body": { "RequestorId": "CUSTOMER-REF-001", "ServicerId": "1-205346710865", "ActivityId": "1-3N5W5LYZ", "State": "InProgress", "Description": "Smart Hands order in progress - technician assigned", "CustomerContact": "customer.contact@example.com", "Location": "DC1", "ServiceDetails": { "scopeOfWork": "Equipment installation and cable management", "startDateTime": "2021-06-17T09:00:00Z", "endDateTime": "2021-06-17T11:00:00Z" }, "Attachments": [] } }, "Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==" } ``` 订单通知包含以下正文属性： * `Body`-`Object`包含订单通知详情的对象。对象内的属性将因资源和状态而异。 * `RequestorId`-`String`-订单的客户参考编号。这是您在下订单时可以提供的唯一标识符。 * `ServicerId`-`String`-由Equinix为提交订单提供的唯一订单编号。也称为订单号。 * `ActivityId``String`订单中特定行项目或子任务的唯一活动标识符。 * `State``String`订单的当前状态。常见状态包括： * `Open`订单已收到，正在审核中 * `InProgress`-当前正在对订单执行工作 * `Completed`-订单已成功完成 * `Cancelled`订单已取消 * `Pending Customer Input`- Equinix需要客户提供额外信息或批准 * `On Hold`-订单暂时暂停 * `Description`-`String`当前订单状态的详细描述或Equinix技术人员发送的任何消息。 * `CustomerContact`-`String`-与订单关联的主要客户联系人电子邮件。 * `Location`-`String`正在履行订单的IBX数据中心网点。 * `ServiceDetails`-`Object`-特定于所执行订单类型的详细信息。订单类型各不相同： * 对于 Smart Hands：工作范围、开始日期时间、结束日期时间、设备详情 * Cross Connect：配线架信息、电路详情、连接器类型 * 工作访问：访客信息、访问目的、访问时长 * 发货信息：承运商信息、追踪号码、送货说明 * 故障单信息：问题描述、严重程度、受影响的服务 * `Attachments`-`Array`-与订单相关的文件附件数组。每个附件包括： * `Id`附件的唯一标识符 * `Name`附件的文件名 * `Url`-下载附件的URL (如果可用)