メインコンテンツに移動

通知タイプ

Messaging Gateway から送信されるすべての通知は、通知の種類に応じて共通のフォーマットで送信されます。通知メッセージの構造については、AsyncAPIのドキュメントでも説明されています。

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

{  
"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--メンテナンス用のお客様用参照ID (ある場合)。
    • ServicerId``String--送信されたオーダーに対してEquinixから提供された一意のIDを示します。
    • State``String--オーダーの現在の状態を示します。サポートされている値-「クローズ」です。
    • Description``Object--請求システムからのチケットの概要。
    • LineDetails``Array--請求対象アイテムとデータセンターの詳細を含むオブジェクトの配列。
      • Id-一意の請求ラインID。
      • Ibx-データセンター/ IBXの名前。
      • Status-サポートされている値「請求済み」です。
      • BilledLines-Array[String]請求対象アイテムのリスト

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--通知の詳細を含むオブジェクト。オブジェクト内の属性は、リソースと動詞によって異なります。
    • type``String--通知のタイプを示します。PORT_OPSTATUS_NOTIFICATIONファブリックポートが現在メンテナンス中であることを示します。CONNECTION_OPSTATUS_NOTIFICATION示されたFabric Virtual Connectionは現在メンテナンス中です。
    • uuid``String--メンテナンスのためにEquinixから提供された一意のIDを示します。
    • description``String-- Equinix技術者からのチケットの概要。
    • data``Object--顧客ポートの詳細を含むオブジェクト。
      • type``String--ポートタイプを示します。XF_PORTEquinix Fabricポートを示します。EVPL_VCEquinix 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データセンターのインシデントやアドバイザリに対してもトリガーされます。

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通知には以下のボディ属性があります：

  • Body``Object--通知の詳細を含むオブジェクト。オブジェクト内の属性は、リソースと動詞によって異なります。
    • RequestorId``String--メンテナンス用のお客様用参照ID (ある場合)。
    • 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およびの状態に対してのみ入力されます。COMPLETED``DataCenter.Advisory
    • AccountNumber``String--メンテナンスアクティビティに関連するお客様のアカウント番号を示します。
    • Impact``String--メンテナンスアクティビティまたはインシデントによるお客様への影響のレベル/重大度を示します。サポートされる値：
      • SERVICE_IMPACTING-サービスに影響を与えるアクティビティまたはインシデントを示します。
      • NON_SERVICE_IMPACTING-修理にもかかわらずバックアップサーバが稼働を続けている場合など、サービスを中断しないアクティビティやインシデントを示します。
    • ProdID``String--メンテナンスアクティビティの詳細情報を参照するリンクを示します。
    • Organizer``String--メンテナンスオーガナイザの名前を示します。エクイニクスのカスタマーサポートまでお問い合わせください。
    • 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=="  
}

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

  • Body``Object--通知の詳細を含むオブジェクト。オブジェクト内の属性は、リソースと動詞によって異なります。

    • RequestorId``String--メンテナンス用のお客様用参照ID (ある場合)。
    • ServicerId``String--ネットワークメンテナンス/インシデント用にEquinixから提供された一意のIDを示します。
    • State``String--チケットの現在の状態サポートされている値:
      • CONFIRMED-データセンターのメンテナンス/インシデントが確認されました。
      • IN-PROCESS-データセンターのメンテナンス/インシデントが現在進行中です。
      • COMPLETED-データセンターのメンテナンス/インシデントが完了しました。
      • CANCELLED-データセンターのメンテナンス/インシデントがキャンセルされました。
    • Description``Object-- Equinix技術者からのチケットの概要。
    • Sequence``Number--関連する通知の増分番号。数字は0から始まります。
    • StartDateTime``String--メンテナンスの開始日時を示します。
    • EndDateTime``String--メンテナンスの終了日時を示します。この値は、タイプ「Network.Maintenance」のリソースに対して常に入力されます。この値は、タイプのリソースに関しては、状態に対してのみ入力されます。COMPLETED``Network.Incident
    • AccountNumber``String--メンテナンスアクティビティに関連するお客様のアカウント番号を示します。
    • Impact``String--メンテナンスアクティビティまたはインシデントによるお客様への影響のレベル/重大度を示します。サポートされる値：
      • SERVICE_IMPACTING-サービスに影響を与えるアクティビティまたはインシデントを示します。
      • NON_SERVICE_IMPACTING-修理にもかかわらずバックアップサーバが稼働を続けている場合など、サービスを中断しないアクティビティやインシデントを示します。
    • ProdID``String--メンテナンスアクティビティの詳細情報を参照するリンクを示します。
    • Organizer``String--メンテナンスオーガナイザの名前を示します。エクイニクスのカスタマーサポートまでお問い合わせください。
    • 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--オーダーのお客様用参照ID。これは、発注時に指定できる一意の識別子です。
    • 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 の場合: scopeOfWork、startDateTime、endDateTime、機器の詳細。
      • Cross Connect用：パッチパネル情報、回路詳細、コネクタータイプ
      • 業務訪問の場合：訪問者情報、目的、期間
      • 出荷：輸送会社情報、追跡番号、配送指示
      • トラブルチケットの場合：問題の説明、深刻度、影響を受けるサービス
    • Attachments``Array--オーダーに関連する添付ファイルの配列。各添付ファイルには以下が含まれます。
      • Id-添付ファイルの一意の識別子
      • Name-添付ファイルのファイル名
      • Url-添付ファイルのダウンロードURL（利用可能な場合）
このページは役に立ちましたか？