通知类型

消息网关发送的每条通知都具有通用格式，具体取决于通知类型。通知消息结构也在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 将为每条消息发送一个唯一值。
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 通知：

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": "Global Service Desk:mailto:cs@equinix.com",  
    "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 - 表示维护组织者的姓名和电子邮件地址。全球服务台：cs@equinix.com。
- Assets - Object - 此值将填充类型为“DataCenter.Maintenance”和“DataCenter.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": "Global Service Desk:mailto:cs@equinix.com",  
    "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.Maintenance”的资源，此值始终为真。对于类型为 Network.Incident 的资源，此值仅在状态为 COMPLETED 时为真。
- AccountNumber - String - 表示与维护活动相关的客户账号。
- Impact - String - 表示维护活动或事件对客户造成的影响程度/严重性。支持的值：
  - SERVICE_IMPACTING - 表示影响您服务的活动或事件。
  - NON_SERVICE_IMPACTING - 表示不会中断服务的活动或事件，例如备份服务器在修复期间仍能保持服务运行。
- ProdID - String - 表示指向有关维护活动的更多信息的链接。
- Organizer - String - 表示维护组织者的姓名和电子邮件地址。全球服务台：cs@equinix.com。
- Assets - Object - 此值将填充类型为“Network.Maintenance”和“Network.Incident”的资源。该对象包含受影响客户资产的详细信息，其属性如下：
  - IBX
  - Cage
  - Cabinet
  - Serial Number
  - Circuit Type

订单通知

订单通知是指通过客户门户、API 或 EMG 系统下单后，可收到的近乎实时的订单状态通知。这些通知会提供订单状态的更新信息，涵盖创建、排程、更新和完成等各个阶段。

以下类型的订单可接收订单通知：

交叉连接订单
智能手部指令
工作访问令
发货订单
故障单订单

样品订单通知：

{  
"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：工作范围、开始日期时间、结束日期时间、设备详情
  - 交叉连接：配线架信息、电路详情、连接器类型
  - 工作访问：访客信息、访问目的、访问时长
  - 发货信息：承运商信息、追踪号码、送货说明
  - 故障单信息：问题描述、严重程度、受影响的服务
- Attachments - Array - 与订购相关的附件数组。每个附件包含：
  - Id - 附件的唯一标识符
  - Name - 附件文件名
  - Url - 附件的下载链接（如有）

账单通知​

结构通知​

IBX 通知​

网络通知​

订单通知​

账单通知

结构通知

IBX 通知

网络通知

订单通知