通知の種類

Messaging Gateway から送信されるすべての通知には、通知の種類に応じて共通のフォーマットがあります。通知メッセージ構造はAsyncAPI documentationにも記載されています。

エクイニクスからの送信メッセージには、以下のコンポーネントが含まれています：

{  
"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) - The unique identifier of the message. Equinix will send a unique value for each message.
Source - String (Guid) - A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
Verb - String - Update. This indicates there is an update from Equinix.
Resource - String - Equinix Product Name for which the notification is being sent.
ContentType - String - "application/json"
CreateTimeUTC - String - Indicates the date and time at which the notification is sent by Equinix.
Version - String - The version of the notification schema.

ボディの属性は、通知タイプごとに異なります。

請求通知

課金通知は、お客様の注文が完了し、エクイニクスから課金が開始されると、ほぼリアルタイムで通知されます。この通知は、オフラインとオンラインの両方のチャネルから送信されたすべてのお客様の注文に対してトリガーされます。

また、顧客からの注文に対して請求が開始されると、再販業者に請求通知が届きます。

通知のサンプル

{  
"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 - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
- RequestorId - String - Customer reference number for the maintenance (if any).
- ServicerId - String - Indicates the unique id supplied by Equinix for the submitted order.
- State - String - Indicates the current state of Order. Supported Value - 'Closed'.
- Description - Object - Summary of the ticket from Billing System.
- LineDetails - Array - An array of object containing the details of the Billed Line Items and data center:
  - Id - Unique Billing Line ID.
  - Ibx - Name of the DataCenter/IBX.
  - Status - Supported value "Billed".
  - BilledLines - Array[String] List of Billed Line Items

Fabric通知

Messaging Gateway は、以下のワークフローの 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=="  
}

Equinix Fabric通知は、以下のボディ属性を持つ：

Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
- type - String - Indicates type of notification. PORT_OPSTATUS_NOTIFICATION indicates Fabric Port is currently under maintenance. CONNECTION_OPSTATUS_NOTIFICATION indicated Fabric Virtual Connection is currently under maintenance.
- uuid - String - Indicates the unique id supplied by Equinix for the maintenance.
- description - String - Summary of the ticket from an Equinix Technician.
- data - Object - An object containing the details of the customer port.
  - type - String - Indicates port type. XF_PORT indicates Equinix Fabric Port. EVPL_VC indicates Equinix Fabric Virtual Connection.
  - uuid - String - Indicates the unique id of the customer port.
  - name - String - Indicates name of the customer port.
  - href - String - Link to get more details of the customer port.
  - operation - Object - An object containing the details related to the status of the customer port.
    - operationalStatus - String - Indicates the current status of the customer port.
    - opStatusChangedAt - String - Indicates the date and time at which the status of the customer port last monitored.
    - maintenanceMode - Boolean - Indicates if its a planned or unplanned maintenance.
  - embedded - Object - An object containing the details of the virtual connections active on this customer port.
    - connections - Object - An object containing the list of the virtual connections active on this customer port.
      - href - Array[String] - An array containing the list of the virtual connections active on this customer port.

IBXからのお知らせ

IBX通知は、エクイニクスのIBXデータセンターの計画的および非計画的なメンテナンスに関するほぼリアルタイムの通知です。これらの通知は、エクイニクス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": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ==  
"  
}

IBX通知には以下のボディ属性があります：

Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
- RequestorId - String - Customer reference number for the maintenance (if any).
- ServicerId - String - Indicates the unique id supplied by Equinix for the datacenter maintenance/incident.
- State - String - Current State of the ticket Supported Values:
  - CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
  - IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
  - COMPLETED - DataCenter Maintenance/Incident is Completed.
  - CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
- Description - Object - Summary of the ticket from an Equinix Technician.
- Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
- StartDateTime - String - Indicates the Start Date and Time of maintenance.
- EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type"DataCenter. Maintenance" This value will only be populated for State as COMPLETED for the Resource Types - DataCenter.Incident, DataCenter.SecurityIncident and DataCenter.Advisory.
- AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
- Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
  - SERVICE_IMPACTING - indicates the activity or incident that affects your services.
  - NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services, like when backup servers keep things running despite repairs.
- ProdID - String - Indicates the link to refer the more information on the maintenance activity.
- Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk: cs@equinix.com.
- Assets - Object - This value will be populated for Resource of Types "DataCenter.Maintenance" and "DataCenter.Incident". An object containing the details of the impacted customer assets with the attributes:
  - IBX
  - Cage
  - Cabinet
  - Serial Number
  - Circuit Type

ネットワーク通知

ネットワーク通知は、エクイニクスの製品・サービスネットワークの計画的および非計画的なメンテナンスに関するほぼリアルタイムの通知です。これらの通知は、エクイニクス製品やサービスネットワークのインシデントにも適用されます。

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": "Global Service Desk:mailto:cs@equinix.com",  
    "Assets": []  
    }  
},  
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="  
}

ネットワーク通知には以下のボディ属性がある：

Body - Object - An object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
- RequestorId - String - Customer reference number for the maintenance (if any).
- ServicerId - String - Indicates the unique id supplied by Equinix for the Network maintenance/incident.
- State - String - Current State of the ticket Supported Values:
  - CONFIRMED - DataCenter Maintenance/Incident is Confirmed.
  - IN-PROCESS - DataCenter Maintenance/Incident currently in progress.
  - COMPLETED - DataCenter Maintenance/Incident is Completed.
  - CANCELLED - DataCenter Maintenance/Incident has been Cancelled.
- Description - Object - Summary of the ticket from an Equinix Technician.
- Sequence - Number - Incrementing number for the related notifications. The number starts from 0.
- StartDateTime - String - Indicates the Start Date and Time of maintenance.
- EndDateTime - String - Indicates the End Date and Time of maintenance. This value will always be populated for Resource of Type "Network.Maintenance" This value will only be populated for State as COMPLETED for Resource of Type Network.Incident.
- AccountNumber - String - Indicates the Customer's Account Number related to the maintenance activity.
- Impact - String - Indicates the level/severity of impact to the customer due to the maintenance activity or incident. Supported Values:
  - SERVICE_IMPACTING - indicates the activity or incident that affects your services.
  - NON_SERVICE_IMPACTING - indicates the activity or incident that does not disrupt your services, like when backup servers keep things running despite repairs.
- ProdID - String - Indicates the link to refer the more information on the maintenance activity.
- Organizer - String - Indicates the name of maintenance organizer with Email Id. Global Service Desk: cs@equinix.com.
- Assets - Object - This value will be populated for Resource of Types "Network.Maintenance" and "Network.Incident". An object containing the details of the impacted customer assets with the attributes:
  - 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 - An object containing the details of the order notification. The attributes within the object will vary based on the resource and state.
- RequestorId - String - Customer reference number for the order. This is the unique identifier you can provide when placing orders.
- ServicerId - String - The unique order number supplied by Equinix for the submitted order. Also referred to as the Order Number.
- ActivityId - String - The unique activity identifier for specific line items or sub-tasks within an order.
- State - String - The current state of the order. Common states include:
  - Open - Order has been received and is being reviewed
  - InProgress - Work is currently being performed on the order
  - Completed - Order has been successfully completed
  - Cancelled - Order has been cancelled
  - Pending Customer Input - Equinix requires additional information or approval from the customer
  - On Hold - Order is temporarily paused
- Description - String - A detailed description of the current order status or any messages from Equinix technicians.
- CustomerContact - String - The primary customer contact email associated with the order.
- Location - String - The IBX data center location where the order is being fulfilled.
- ServiceDetails - Object - Details specific to the type of order being performed. Contents vary by order type:
  - Smart Hands の場合: scopeOfWork、startDateTime、endDateTime、機器の詳細。
  - Cross Connect用：パッチパネル情報、回路詳細、コネクタータイプ
  - 業務訪問の場合：訪問者情報、目的、期間
  - 出荷：輸送会社情報、追跡番号、配送指示
  - トラブルチケットの場合：問題の説明、深刻度、影響を受けるサービス
- Attachments - Array - An array of file attachments related to the order. Each attachment includes:
  - Id - Unique identifier for the attachment
  - Name - Filename of the attachment
  - Url - Download URL for the attachment (when available)

請求通知​

Fabric通知​

IBXからのお知らせ​

ネットワーク通知​

注文通知​

請求通知

Fabric通知

IBXからのお知らせ

ネットワーク通知

注文通知