通知の種類

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) - メッセージの一意の識別子です。エクイニクスはメッセージごとに一意の値を送信します。
Source - String``(Guid) - メッセージ送信者を識別するための一意の値です。この値は、オンボーディングプロセス中に顧客と共有されます。
Verb - String- 更新。エクイニクスから更新があったことを示します。
Resource - String- 通知を送信するエクイニクスの製品名です。
ContentType - String- "application/json"
CreateTimeUTC - String- エクイニクスから通知が送信された日時を示します。
Version - String- 通知スキーマのバージョン。

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

請求通知

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

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

通知のサンプル

{  
"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- 送信されたオーダーに対してエクイニクスから提供された一意のIDを示します。
- State - String- 現在のオーダー状態を示します。サポートされる値 - 'クローズ'。
- Description - Object- 課金システムからのチケットの概要です。
- LineDetails - Array- Billed Line Items およびデータセンターの詳細を含むオブジェクトの配列：
  - Id - ユニーク請求ラインID。
  - Ibx - データセンター/IBXの名前。
  - Status - サポートされている値「Billed」。
  - BilledLines - Array[String]課金項目一覧

ファブリック通知

Messaging Gatewayは以下のワークフローでFabric Notificationをサポートしています：

エクイニクスファブリックポートのアップ/ダウン
エクイニクスファブリック仮想接続のアップ/ダウン

通知のサンプル

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

ファブリック通知は、以下のボディ属性を持つ：

Body - Object- 通知の詳細を含むオブジェクト。オブジェクト内の属性は、リソースと動詞によって異なります。
- type - String- 通知のタイプを示します。PORT_OPSTATUS_NOTIFICATIONはファブリックポートが現在メンテナンス中であることを示します。CONNECTION_OPSTATUS_NOTIFICATION は Fabric Virtual Connection が現在メンテナンス中であることを示します。
- uuid - String- エクイニクスがメンテナンスのために提供する固有のIDを示します。
- description - String- エクイニクスの技術者によるチケットの概要です。
- 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通知は、エクイニクスの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- 通知の詳細を含むオブジェクト。オブジェクト内の属性は、リソースと動詞によって異なります。
- RequestorId - String- メンテナンスの顧客参照番号（ある場合）。
- ServicerId - String- データセンターのメンテナンス／インシデントに関してエクイニクスから提供された固有のIDを示します。
- State - String- チケットの現状サポートされている値です：
  - CONFIRMED - データセンターのメンテナンス/インシデントが確認されました。
  - IN-PROCESS - データセンターのメンテナンス/インシデントが現在進行中です。
  - COMPLETED - データセンターのメンテナンス/インシデントが完了しました。
  - CANCELLED - データセンターのメンテナンス/インシデントがキャンセルされました。
- Description - Object- エクイニクスの技術者によるチケットの概要です。
- Sequence - Number- 関連通知の増加数。0 から始まります。
- StartDateTime - String- メンテナンスの開始日時を示します。
- EndDateTime - String- メンテナンスの終了日時を示します。この値は Type "DataCenter.Maintenance "の Resource には常に入力されます。メンテナンス」この値は、リソースタイプ DataCenter.Incident、DataCenter.SecurityIncident、DataCenter.Advisory の State に対してのみ COMPLETED として入力されます。
- AccountNumber - String- メンテナンスアクティビティに関連するお客様のアカウント番号を示します。
- Impact - String- Impact - String メンテナンス活動またはインシデントによる顧客への影響のレベル/深刻度を示します。サポートされる値：
  - SERVICE_IMPACTING - サービスに影響を与えるアクティビティまたはインシデントを示します。
  - NON_SERVICE_IMPACTING - 修理中にもかかわらずバックアップサーバーが稼動を維持している場合など、サービスに支障をきたさないアクティビティやインシデントを示します。
- ProdID - String- メンテナンス活動の詳細情報を参照するためのリンクを示します。
- Organizer - String- メンテナンス主催者の名前と電子メール ID を示します。グローバルサービスデスクcs@equinix.com。
- Assets - Object- この値は、タイプ「DataCenter.Maintenance」および「DataCenter.Incident」のリソースに入力されます。属性を持つ、影響を受けた顧客資産の詳細を含むオブジェクト：
  - IBX
  - Cage
  - Cabinet
  - Serial Number
  - Circuit Type

ネットワーク通知

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

メッセージングゲートウェイは以下のネットワーク通知をサポートしています。

ネットワーク・メンテナンスのお知らせ
ネットワークインシデントの通知

通知のサンプル

{  
"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- ネットワークのメンテナンス／インシデントに関してエクイニクスから提供された固有のIDを示します。
- State - String- チケットの現状サポートされている値です：
  - CONFIRMED - データセンターのメンテナンス/インシデントが確認されました。
  - IN-PROCESS - データセンターのメンテナンス/インシデントが現在進行中です。
  - COMPLETED - データセンターのメンテナンス/インシデントが完了しました。
  - CANCELLED - データセンターのメンテナンス/インシデントがキャンセルされました。
- Description - Object- エクイニクスの技術者によるチケットの概要です。
- Sequence - Number- 関連通知の増加数。0 から始まります。
- StartDateTime - String- メンテナンスの開始日時を示します。
- EndDateTime - String- メンテナンスの終了日時を示します。この値はタイプ「Network.Maintenance」の Resource には常に入力されます。この値はタイプ Network.Incident の Resource の State が COMPLETED の場合のみ入力されます。
- AccountNumber - String- メンテナンスアクティビティに関連するお客様のアカウント番号を示します。
- Impact - String- Impact - String メンテナンス活動またはインシデントによる顧客への影響のレベル/深刻度を示します。サポートされる値：
  - SERVICE_IMPACTING - サービスに影響を与えるアクティビティまたはインシデントを示します。
  - NON_SERVICE_IMPACTING - 修理中にもかかわらずバックアップサーバーが稼動を維持している場合など、サービスに支障をきたさないアクティビティやインシデントを示します。
- ProdID - String- メンテナンス活動の詳細情報を参照するためのリンクを示します。
- Organizer - String- メンテナンス主催者の名前と電子メール ID を示します。グローバルサービスデスク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- 提出された注文に対してエクイニクスが提供する固有の注文番号。注文番号とも呼ばれます。
- ActivityId - String- 注文内の特定のラインアイテムまたはサブタスクの一意のアクティビティ識別子。
- State - String- 注文の現在の状態。一般的な状態は以下のとおりです：
  - Open - 注文を受信しました。
  - InProgress - この注文は現在実行中です。
  - Completed - 注文は正常に完了しました
  - Cancelled - 注文はキャンセルされました
  - Pending Customer Input - 追加情報またはお客様の承認が必要です。
  - On Hold - 注文は一時停止されています。
- Description - String- 現在の注文状況やエクイニクスの技術者からのメッセージの詳細。
- CustomerContact - String- 注文に関連する主な顧客連絡先メール。
- Location - String- 注文が処理されるIBXデータセンターの場所です。
- ServiceDetails - Object- 実行される注文のタイプに固有の詳細。内容は注文タイプによって異なります：
  - Smart Hands の場合: scopeOfWork、startDateTime、endDateTime、機器の詳細。
  - Cross Connect用：パッチパネル情報、回路詳細、コネクタータイプ
  - 業務訪問の場合：訪問者情報、目的、期間
  - 出荷：輸送会社情報、追跡番号、配送指示
  - トラブルチケットの場合：問題の説明、深刻度、影響を受けるサービス
- Attachments - Array- 注文に関連する添付ファイルの配列です。各添付ファイルには以下が含まれます：
  - Id - 添付ファイルの一意識別子
  - Name - 添付ファイルのファイル名
  - Url - 添付ファイルのダウンロード URL（利用可能な場合）

請求通知​

ファブリック通知​

IBXからのお知らせ​

ネットワーク通知​

注文通知​

請求通知

ファブリック通知

IBXからのお知らせ

ネットワーク通知

注文通知