本文へスキップ

サービス・トークンを使用した接続先への接続

サービス・トークンで事前に定義された情報を使用して、アセットまたはサードパーティ間の接続を確立できます。サービス・トークンは、接続のAサイドとZサイドの両方に対して発行できます。

たとえば、ポートからサービス・トークンが提供する宛先への接続を作成できます。Zサイド・サービス・トークンは、ポート、Network Edge仮想デバイス、またはネットワークに対して発行できます。

前提条件​

  1. Authenticate - OAuth2認証のためのユーザー認証情報、クライアントID、クライアントシークレットを送信します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API Authenticationを参照してください。

  2. A 側のポート情報を決定します。 Get All Ports エンドポイントを使用して、関連するポート情報を取得します。

  3. プロバイダからサイド・サービス・トークンの詳細を取得します。この情報は、接続作成APIを呼び出すために必要です。

DOT1Qポートからサービス・トークンへの接続の作成​

DOT1Q ポートからサービス トークンで定義された接続先に接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。リクエストの本文には、サイドのポート情報とサイドのサービス・トークンの詳細を指定します。

メモ

サービストークンは、複数の受信者に送信することができ、どの受信者も1回だけ使用することができます。

POST /fabric/v4/connections
MethodPOST
Endpoint/fabric/v4/connections
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parameterstype, name, order, bandwidth, aSide, zSide, notifications

接続を作成せずに本番環境でこのリクエストを安全に検証するには、［本番環境でのテスト（APIドライラン）］（../../equinix-api/testing/testing-in-production-dry-run.md）を参照してください。

サンプルcURLリクエスト：

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "type": "EVPL_VC",  
    "name": "Conn-1",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "bandwidth": 1000,  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q",  
                "vlanTag": 1001  
            }  
        }  
    },  
    "zSide": {  
        "serviceToken": {  
            "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        }  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test2@equinix.com"  
            ]  
        }  
    ]  
}'

リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。

回答例

{  
    "href": "https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62",  
    "type": "EVPL_VC",  
    "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",  
    "state": "PROVISIONING",  
    "name": "Conn-1",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100",  
        "billingTier": "Up to 1 Gbps"  
    },  
    "bandwidth": 1000,  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "href": "https://api.equinix.com/fabric/v4/ports/a867f685-41b0-1b07-6de0-320a5c00abdd",  
                "type": "XF_PORT",  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q",  
                "vlanTag": 1001  
            }  
        }  
    },  
     "zSide": {  
        "serviceToken": {  
            "href": "https://api.equinix.com/fabric/v4/serviceTokens/25acdea5-1eeb-4f0b-8ca9-6c505f46847d",  
            "uuid": "25acdea5-1eeb-4f0b-8ca9-6c505f46847d"  
        },  
        "accessPoint": {  
            "location": {  
                "metroHref" : "https://api.equinix.com/fabric/v4/metros/DC",  
                "region": "AMER",  
                "metroName": "Ashburn",  
                "metroCode": "DC"  
            },  
            "port": {  
                "type": "XF_PORT",  
                "href": "https://api.equinix.com/fabric/v4/ports/c5720fcc-4ae7-ae7e-13e0-306a5c00adaf",  
                "uuid": "c5720fcc-4ae7-ae7e-13e0-306a5c00adaf",  
                "name": "eqx-nfv-CX-DC6-L-Dot1q-BO-10G-PRI-JUN-7"  
            },  
            "linkProtocol": {  
                "type": "DOT1Q",  
                "vlanTag": 3132  
            }  
        }  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test2@equinix.com"  
            ]  
        }  
    ],  
    "operation": {  
        "equinixStatus": "PROVISIONING",  
        "providerStatus": "NOT_AVAILABLE"  
    },  
    "changeLog": {  
        "createdDateTime": "2021-07-15T19:30:29.526Z"  
    }  
}

レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの一覧とその説明については、API リファレンス を参照してください。

QINQ ポートからサービストークンへの接続を作成します。​

QINQ ポートからサービストークンで定義された接続先への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。リクエストの本文には、サイドのポート情報とサイドのサービス・トークンの詳細を指定します。

サンプルcURLリクエスト：

curl -X  
POST 'https://api.equinix.com/fabric/v4/connections'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "type": "EVPL_VC",  
    "name": "Conn-1",  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "bandwidth": 1000,  
    "aSide": {  
        "accessPoint": {  
            "type": "COLO",  
            "port": {  
                "uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"  
            },  
            "linkProtocol": {  
                "type": "QINQ",  
                "vlanCTag": 1001,  
                "vlanSTag": 1002  
            }  
        }  
    },  
    "zSide": {  
        "serviceToken": {  
            "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"  
        }  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test2@equinix.com"  
            ]  
        }  
    ]  
}'

リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。

接続の監視​

接続ステータスを監視するには、Get Specified Connection エンドポイントを使用します。

このページは役に立ちましたか？