メインコンテンツにスキップ

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

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

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

前提条件​

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

  2. Aサイドポート情報を確認します。 Get All Portエンドポイントを使用して、関連するポート情報を取得します。

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

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

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

メモ

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

POST/ファブリック/v4/connections
方法POST
エンドポイント/fabric/v4/connections
ヘッダーAuthorization、Content-Type
パスパラメータ該当なし
クエリーパラメータ該当なし
ボディパラメータtype``name、、order、、bandwidth、aSide``zSide、notifications

接続を作成せずに本番環境でこのリクエストを安全に検証するには、「本番環境でのテスト(APIドライラン)」を参照してください。

サンプル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リクエストの本文でAサイドポート情報とZサイドサービストークンの詳細を指定します。

サンプル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リファレンスを参照してください。

接続の監視​

指定された接続の取得エンドポイントを使用して、接続ステータスを監視します。

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