ネットワークに接続する
ネットワークとポートおよび仮想デバイス間の低レイテンシーの直接接続を確立します。
前提条件
-
認証 - OAuth2用のユーザー認証情報、クライアントID、クライアントシークレットを送信します。 認証を使用します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API認証を参照してください。
-
Fabric ネットワーク情報を取得する -
fabric/v4/networks/searchエンドポイントにPOSTリクエストを送信して、利用可能なネットワークのリストを検索して取得します。 -
ポートまたは仮想デバイス情報を決定します。
-
すべてのポートを取得エンドポイントを使用して、Equinix Fabricのポート情報を取得してください。特定のポートの情報を取得するには、[Get Specified Port エンドポイントを使用します。
-
Networkエッジデバイスの情報を確認します。登録済みのエクイニクス仮想デバイス/冗長デバイス/クラスタが必要です。利用可能な仮想デバイスとクラスタを確認するには、Get Virtual Devices または Get Virtual Device {uuid} を呼び出してください。接続には、デバイス上で利用可能なインターフェースを選択できます。ただし、指定がない場合はエクイニクスがインターフェースを選択します。
-
タグ付きポートからEVPLANネットワークへの接続の作成
タグ付きポートからEVPLANネットワークへの接続を作成するには、/fabric/v4/connectionsエンドポイントにPOSTリクエストを送信します。リクエストの本文に、接続の設定の詳細を指定します。
| POST /fabric/v4/connections | |
|---|---|
| Method | POST |
| Endpoint | /fabric/v4/connections |
| Headers | Authorization, Content-Type |
| Path Parameters | Not applicable |
| Query Parameters | Not applicable |
| Body Parameters | type, name, order, bandwidth, aSide, zSide, notifications, redundancy |
接続を作成せずに本番環境でこのリクエストを安全に検証するには、[本番環境でのテスト(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": "EVPLAN_VC",
"name": "MY-EVPLAN-CONNECTION-1",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "9127bb72-5f4f-4517-be74-3af7ce612687"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 300
}
}
},
"zSide": {
"accessPoint": {
"type": "NETWORK",
"network": {
"uuid": "25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2"
}
}
},
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
}'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。
回答例
{
"type": "EVPLAN_VC",
"href": "https://uat2api.npclouda.equinix.com/fabric/v4/connections/01df5124-eed1-4a30-89bb-240c33d5cd12",
"uuid": "01df5124-eed1-4a30-89bb-240c33d5cd12",
"name": "test2",
"operation": {
"providerStatus": "NOT_AVAILABLE",
"equinixStatus": "PROVISIONING"
},
"order": {
"billingTier": "Up to 50 MB"
},
"notifications": [
{
"type": "ALL",
"emails": [
"1eqxnfvuser1@equinix.com"
]
}
],
"changeLog": {
"createdBy": "eqxnfvuser1",
"createdByFullName": "eqxnfvuser eqxnfvuser",
"createdByEmail": "1eqxnfvuser1@equinix.com",
"createdDateTime": "2023-03-27T18:29:53.117Z",
"updatedBy": "eqxnfvuser1",
"updatedByFullName": "eqxnfvuser eqxnfvuser",
"updatedByEmail": "1eqxnfvuser1@equinix.com",
"updatedDateTime": "2023-03-27T18:29:53.117Z"
},
"bandwidth": 50,
"redundancy": {
"priority": "PRIMARY",
"group": "7a58dd05-f46d-4b1d-a154-2e85c396ea63"
},
"aSide": {
"accessPoint": {
"location": {
"metroCode": "DC"
},
"port": {
"type": "XF_PORT",
"href": "https://uat2api.npclouda.equinix.com/fabric/v4/ports/e569f0bb-96d5-6d5e-92e0-387a5c00a379",
"uuid": "e569f0bb-96d5-6d5e-92e0-387a5c00a379",
"name": "eqx-nfv-DC5-L-Dot1q-STD-Pri-1G-JP-2"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 44
}
}
},
"zSide": {
"accessPoint": {
"network": {
"href": "https://uat2api.npclouda.equinix.com/fabric/v4/networks/ecc81fe0-7a96-4e08-94f2-0ab52fae662b",
"uuid": "ecc81fe0-7a96-4e08-94f2-0ab52fae662b",
"name": "EVPLAN-AMER-1",
"platformUuid": "52c6ec8b-4aad-4167-be6d-1972a12d1b83",
"state": "ACTIVE",
"type": "EVPLAN",
"scope": "REGIONAL",
"location": {
"region": "AMER"
}
}
}
}
}
レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの一覧とその説明については、API リファレンス を参照してください。
タグなしポートから EPLAN ネットワークへの接続の作成
タグなしポートから EPLAN ネットワークへの接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。リクエストの本文に、接続の設定の詳細を指定します。
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '
{
"type": "EPLAN_VC",
"name": "MY-EPLAN-CONNECTION-1",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "9127bb72-5f4f-4517-be74-3af7ce612687"
}
}
},
"zSide": {
"accessPoint": {
"type": "NETWORK",
"network": {
"uuid": "25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2"
}
}
},
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
}'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。
仮想デバイスからEVPLANネットワークへの接続の作成
仮想デバイスからEVPLAN Networkへの接続を作成するには、/fabric/v4/connectionsエンドポイントにPOSTリクエストを送信します。リクエストの本文に、接続の設定の詳細を指定します。
curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '
{
"type": "EVPLAN_VC",
"name": "MY-VD-EVPLAN-CONNECTION-1",
"bandwidth": 1000,
"aSide": {
"accessPoint": {
"type": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
},
"interface": {
"type": "NETWORK",
"id": 7
}
}
},
"zSide": {
"accessPoint": {
"type": "NETWORK",
"network": {
"uuid": "25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2"
}
}
},
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test1@equinix.com"
]
}
]
}'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。