通知类型

Messaging Gateway发送的每个通知都有一个通用格式，具体取决于通知类型。AsyncAPI文档中也介绍了通知消息结构。

所有来自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将为每条消息发送一个唯一的值。
ssource-String``(GUID)-标识消息发件人的唯一值。此值将在建立客户关系过程中与客户共享。
动词-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=="  
}

帐单通知具有以下正文属性：

正文-对象-包含通知详细信息的对象。对象中的属性将因资源和动词而异。
- RequestorId-String-维护的客户参考号(如果有)。
- servicerId-String-表示Equinix为提交的订单提供的唯一ID。
- state-String-表示订单的当前状态。支持的值-"已关闭"。
- d说明-对象-帐单系统中的TT摘要。
- LineDetails-Array-包含计费行项目和数据中心详细信息的对象数组：
  - ID-唯一的帐单行ID。
  - Ibx-数据中心/IBX的名称。
  - status-支持的值"Billed"。
  - BilledLines-Array[String]计费行项目列表

结构通知

Messaging Gateway支持以下工作流的结构通知：

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通知具有以下正文属性：

正文-对象-包含通知详细信息的对象。对象中的属性将因资源和动词而异。
- type-String-表示通知的类型。PORT_OPSTATUS_NOTITION表示Fabric Port当前正在维护中。CONNECTION_OPSTATUS_NOTITION表示Fabric虚拟连接当前正在维护中。
- uuid-String-表示Equinix为维护提供的唯一ID。
- d说明-String- Equinix技术人员的TT摘要。
- data-Object-包含客户端口详细信息的对象。
  - type-String-表示端口类型。xf_port表示Equinix光纤端口。EVPL_VC表示Equinix Fabric虚拟连接。
  - uuid-String-表示客户端口的唯一ID。
  - name-String-表示客户端口的名称。
  - href-String-链接以获取客户端口的更多详细信息。
  - 操作-对象-包含与客户端口状态相关的详细信息的对象。
    - operationalStatus-String-表示客户端口的当前状态。
    - opStatusChangedAt-String-指示上次监控客户端口状态的日期和时间。
    - maintenanceMode-布尔值-指示其是计划维护还是计划外维护。
  - 嵌入式-对象-包含此客户端口上活动虚拟连接的详细信息的对象。
    - Connections (连接)-Object (对象)-包含此客户端口上活动的虚拟连接列表的对象。
      - href-Array[String]-包含此客户端口上活动虚拟连接列表的阵列。

IBX 通知

IBX通知是几乎实时的通知，适用于任何计划外的Equinix IBX数据中心维护。对于任何Equinix IBX数据中心事故和建议，也会触发这些通知。

Messaging Gateway支持以下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通知具有以下正文属性：

正文-对象-包含通知详细信息的对象。对象中的属性将因资源和动词而异。
- RequestorId-String-维护的客户参考号(如果有)。
- servicerId-String-表示Equinix为数据中心维护/事件提供的唯一ID。
- s时间-String-票证的当前状态支持值：
  - 已确认-数据中心维护/事件已确认。
  - 进行中-数据中心维护/事件当前正在进行中。
  - 已完成-数据中心维护/事件已完成。
  - 已取消-数据中心维护/事件已取消。
- d说明-对象- Equinix技术人员提供的TT摘要。
- s序列-编号-相关通知的递增编号。数字从0开始。
- startDateTime-String-表示维护的开始日期和时间。
- EndDateTime-String-表示维护的结束日期和时间。此值将始终为类型为"DataCenter"的资源填充。维护"对于资源类型-DataCenter.Incident，DataCenter.SecurityIncident和DataCenter.Advisory，此值只会为状态填充为Completed。
- AccountNumber-String-表示与维护活动相关的客户帐号。
- Impact-String-表示维护活动或事件对客户造成的影响的级别/严重性。支持的值：
  - service_Impact-表示影响您服务的活动或事件。
  - non_service_Impact-表示不会中断服务的活动或事件，例如备份服务器在修复后仍保持运行。
- ProdID-String-表示参考有关维护活动的更多信息的链接。
- Organizer-String-表示维护组织者的名称。Equinix客户支持。
- Assets-Object-将为类型为"DataCenter.Maintenance"和"DataCenter.Incident"的资源填充此值。包含受影响客户资产的详细信息的对象，其属性如下：
  - IBX
  - Cage
  - Cabinet
  - Serial Number
  - Circuit Type

网络通知

网络通知是对任何计划外Equinix产品或服务网络维护的近乎实时的通知。对于任何Equinix产品或服务网络事故，也会触发这些通知。

Messaging Gateway支持以下网络通知变体

网络维护通知
网络事件通知

示例通知：

{  
"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=="  
}

网络通知具有以下正文属性：

正文-对象-包含通知详细信息的对象。对象中的属性将因资源和动词而异。
- RequestorId-String-维护的客户参考号(如果有)。
- servicerId-String-表示Equinix为网络维护/事件提供的唯一ID。
- s时间-String-票证的当前状态支持值：
  - 已确认-数据中心维护/事件已确认。
  - 进行中-数据中心维护/事件当前正在进行中。
  - 已完成-数据中心维护/事件已完成。
  - 已取消-数据中心维护/事件已取消。
- d说明-对象- Equinix技术人员提供的TT摘要。
- s序列-编号-相关通知的递增编号。数字从0开始。
- startDateTime-String-表示维护的开始日期和时间。
- EndDateTime-String-表示维护的结束日期和时间。此值将始终为类型为"Network.Maintenance"的资源填充。对于类型为Network.Incident的资源，此值将仅为状态填充为Completed。
- AccountNumber-String-表示与维护活动相关的客户帐号。
- Impact-String-表示维护活动或事件对客户造成的影响的级别/严重性。支持的值：
  - service_Impact-表示影响您服务的活动或事件。
  - non_service_Impact-表示不会中断服务的活动或事件，例如备份服务器在修复后仍保持运行。
- ProdID-String-表示参考有关维护活动的更多信息的链接。
- Organizer-String-表示维护组织者的名称。Equinix客户支持。
- Assets (资产)-Object (对象)-将为类型为"Network.Maintenance"和"Network.Incident"的资源填充此值。包含受影响客户资产的详细信息的对象，其属性如下：
  - IBX
  - Cage
  - Cabinet
  - Serial Number
  - Circuit Type

订单通知

订单通知是通过客户门户网站，API或EMG发出的订单的近乎实时的通知。这些通知提供订单在各个阶段(包括创建，计划，更新和完成)进度时的状态更新。

订单通知适用于以下订单类型：

交叉连接订购
Smart Hands 订单
工作访问订单
货物订单编号
TT订单故障

订单通知示例：

{  
"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=="  
}

医嘱通知具有以下正文属性：

正文-对象-包含医嘱通知详细信息的对象。对象中的属性将因资源和状态而异。
- RequestorId-String-订单的客户参考号。这是您在下订单时可以提供的唯一编码。
- servicerId-String- Equinix为提交的订单提供的唯一订单号。也称为订单号。
- ActivityId-String-订单中特定行项目或子任务的唯一活动标识符。
- state-String-订单的当前状态。常见状态包括：
  - 打开-订单已收到并正在审核
  - InProgress-当前正在对订单执行工作
  - Completed-订单已成功完成
  - 已取消-订单已取消
  - 待定客户输入- Equinix需要客户提供额外信息或批准
  - On Hold-处方暂停
- d说明-String-当前订单状态或Equinix技术人员的任何消息的详细说明。
- CustomerContact-String-与订单关联的主要客户联系人电子邮件。
- Location-String-正在执行订单的IBX数据中心位置。
- serviceDetails-Object-特定于正在执行的医嘱类型的详细信息。内容因订单类型而异：
  - 对于智能手柄：scopeOfWork，startDateTime，endDateTime，设备详细信息
  - 对于交叉连接：配线板信息，电路详细信息，连接器类型
  - 工作访问：访客信息，目的，持续时间
  - 货件：承运人信息，追踪编码，配送说明
  - 对于故障单：问题描述，严重性，受影响的服务
- Attachments-Array-与订单相关的文件附件数组。每个附件包括：
  - ID-附件的唯一标识符
  - 名称-附件的文件名
  - URL-下载附件的URL (如果可用)

帐单通知​

结构通知​

IBX 通知​

网络通知​

订单通知​

帐单通知

结构通知

IBX 通知

网络通知

订单通知