API - AWS Direct Connect への接続

Fabric と AWS Direct Connect を使用して、IBX コロケーション資産と Amazon Web Services (AWS) リソースの間に、直接のレイヤ 2 接続を確立します。API を使用して、ポート、Network Edge デバイス、または Fabric Cloud Router から接続を作成します。

AWSが提供するサービストークンをお持ちの場合は、サービストークンを使用した接続先への接続を参照してください。

API の前提条件

認証 - OAuth2用のユーザー認証情報、クライアントID、クライアントシークレットを送信します。認証を使用します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API認証を参照してください。
A面の情報を決めるどちらか：
- Equinixファブリックのポート情報を確認するには、/fabric/v4/portsエンドポイントにGETリクエストを送信します。ポートUUID（複数可）とリンクプロトコルタイプ（DOT1QまたはQINQ）が必要です、
または
- GET リクエストを [/fabric/v4/serviceTokens`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Tokens/operation/getServiceTokens) エンドポイントに送信して、a 側のサービストークンを取得します。トークンの UUID が必要です。a-side トークンは、接続の a-side を設定するための関連情報を提供します。
または
- NetworkEdgeデバイス情報を確認します。利用可能な仮想デバイスとクラスタを確認するには、/ne/v1/devices エンドポイントに GET リクエストを送信します。デバイスの UUID が必要です。デバイスの詳細を取得するには、/ne/v1/devices/{device_id} エンドポイントに GET リクエストを送信します。接続には、デバイス上の利用可能なインターフェイスを選択できます。指定しない場合、接続は自動的に次に利用可能なインターフェースに割り当てられます。
または
- Fabric Cloud Router情報を確認します。利用可能なクラウドルーターを確認するには、/fabric/v4/routers/search エンドポイントに POST リクエストを送信します。ルーターのUUIDが必要です。
AWS Direct Connectのサービスプロファイルとロケーション情報を確認します。どのサービスプロファイルを選択すべきかについての詳細は、AWS Direct Connect Overview ページに記載されています。
- AWS Direct Connect UUID - 69ee618d-be52-468d-bc99-00566f2dd2b9.
- AWS Direct Connect High Capacity UUID - de55ca94-df3b-4680-845f-6f7093f76bef.
- AWS Direct Connect 冗長 UUID - 8b5cbdbd-53da-4d37-9bfc-cc988eb522f1.
- AWS Direct Connect- 大容量冗長化 - ed48616a-c182-40b4-a462-a78ba812e961
位置情報を検索するには、AWS Direct Connect サービスプロファイル ID のいずれかを使用して /fabric/v4/serviceProfiles/{service_profile_ID} エンドポイントに GET リクエストを送信します。レスポンスのメトロオブジェクトには、エクイニクスのメトロと関連するAWSリージョンのリストが含まれます。接続を作成するには、この両方が必要です。
Amazon アカウント ID の確認と検証AWS Management Console にログインし、アカウント番号を確認します。アカウント番号の確認方法については、AWS ドキュメントを参照してください。エンドポイント/fabric/v4/connections/validateにPOSTリクエストを送信し、AWSアカウントIDを使用して、指定したメトロで選択したサービスプロファイルへの接続を作成できることを確認します。

DOT1Q ポートからの接続

DOT1Q ポートから AWS への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。接続の type は EVPL_VC です。

aSide` オブジェクトに以下のようなポート情報をプロバイダとして入力してください：

accessPoint.type as COLO
ポートのUUIDをport.uuidにプロバイダしてください。
linkProtocol.type as DOT1Q.
VLAN ID を linkProtocol.vlanTag にプロバイダします。

以下のような AWS Direct Connect の詳細と場所の詳細を zSide オブジェクトにプロバイダします：

accessPoint.typeをSP`に設定します。
profile.typeをL2_PROFILE` に設定します。
接続先の AWS サービスプロファイルを profile.uuid に指定します。
location.metroCode`に接続先のEquinixメトロを指定してください。
sellerRegionにメトロに関連するAWSリージョンを指定します。この情報は、[/fabric/v4/serviceProfiles/{service_profile_ID}`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) エンドポイントから確認できます。API Prerequisites](#api-prerequisites)エンドポイントを参照してください。API の前提条件](#api-prerequisites) を参照してください。
AWSアカウントIDとしてauthenticationKeyを設定します。

帯域幅や冗長性`など、その他の接続設定の詳細をリクエスト本文で指定します。パラメータの一覧とその説明については、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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "COLO",
      "port": {
        "uuid": "<port_uuid>"
      },
      "linkProtocol": {
        "type": "DOT1Q",
        "vlanTag": <vlan_ID>
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

QINQ ポートからの接続

QINQ ポートから AWS への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。接続の type は EVPL_VC です。

aSide` オブジェクトに以下のようなポート情報をプロバイダとして入力してください：

accessPoint.typeをColo`に設定します。
ポートのUUIDをport.uuidにプロバイダしてください。
linkProtocol.type as QINQ
内側のタグ ID を linkProtocol.vlanCTag にプロバイダします。
外部タグ ID を linkProtocol.vlanSTag にプロバイダします。

以下のような AWS Direct Connect の詳細と場所の詳細を zSide オブジェクトにプロバイダします：

accessPoint.typeをSP`に設定します。
profile.typeをL2_PROFILE` に設定します。
接続先の AWS サービスプロファイルを profile.uuid に指定します。
location.metroCode`に接続先のEquinixメトロを指定してください。
sellerRegionにメトロに関連するAWSリージョンを指定します。この情報は、[/fabric/v4/serviceProfiles/{service_profile_ID}`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) エンドポイントから確認できます。API Prerequisites](#api-prerequisites)エンドポイントを参照してください。API の前提条件](#api-prerequisites) を参照してください。
AWSアカウントIDとしてauthenticationKeyを設定します。

サンプル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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "COLO",
      "port": {
        "uuid": "<port_uuid>"
      },
      "linkProtocol": {
        "type": "QINQ",
        "vlanCTag": <inner_tag_ID>,
        "vlanSTag": <outer_tag_ID>
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}

サービス・トークンを使った接続

A-side Service Token を使用して AWS への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。接続の type は EVPL_VC です。

aSide` オブジェクトに Service Token UUID をプロバイダします。サービストークンは、接続を確立するために必要な他のすべての情報を提供します。

以下のような AWS Direct Connect の詳細と場所の詳細を zSide オブジェクトにプロバイダします：

accessPoint.typeをSP`に設定します。
profile.typeをL2_PROFILE` に設定します。
接続先の AWS サービスプロファイルを profile.uuid に指定します。
location.metroCode`に接続先のEquinixメトロを指定してください。
sellerRegionにメトロに関連するAWSリージョンを指定します。この情報は、[/fabric/v4/serviceProfiles/{service_profile_ID}`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) エンドポイントから確認できます。API Prerequisites](#api-prerequisites)エンドポイントを参照してください。API の前提条件](#api-prerequisites) を参照してください。
AWSアカウントIDとしてauthenticationKeyを設定します。

サンプル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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "serviceToken": {
      "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}

Network Edge デバイスから接続する

Network Edge デバイスから AWS への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。接続の type は EVPL_VC です。

aSide` オブジェクトで Network Edge デバイスを定義します：

accessPoint.type as VD
virtualDevice.type as EDGE
virtualDevice.uuid as your device's UUID

以下のような AWS Direct Connect の詳細と場所の詳細を zSide オブジェクトにプロバイダします：

accessPoint.typeをSP`に設定します。
profile.typeをL2_PROFILE` に設定します。
接続先の AWS サービスプロファイルを profile.uuid に指定します。
location.metroCode`に接続先のEquinixメトロを指定してください。
sellerRegionにメトロに関連するAWSリージョンを指定します。この情報は、[/fabric/v4/serviceProfiles/{service_profile_ID}`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) エンドポイントから確認できます。API Prerequisites](#api-prerequisites)エンドポイントを参照してください。API の前提条件](#api-prerequisites) を参照してください。
AWSアカウントIDとしてauthenticationKeyを設定します。

サンプル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": "<your_connection_name>",
  "bandwidth": <connection_speed>,
  "redundancy": {
    "priority": "<redundancy_code>"
  },
  "aSide": {
    "accessPoint": {
      "type": "VD",
      "virtualDevice": {
        "type": "EDGE",
        "uuid": "<device_uuid>"
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

Fabric Cloud Router から接続する

Fabric Cloud Router から AWS への接続を作成するには、/fabric/v4/connections エンドポイントに POST リクエストを送信します。接続の type は IP_VC です。

aSide` オブジェクトで Fabric Cloud Router を定義します：

accessPoint.typeをCLOUD_ROUTER` に設定します。
ルーターの UUID として router.uuid を設定します。

以下のような AWS Direct Connect の詳細と場所の詳細を zSide オブジェクトにプロバイダします：

accessPoint.typeをSP`に設定します。
profile.typeをL2_PROFILE` に設定します。
接続先の AWS サービスプロファイルを profile.uuid に指定します。
location.metroCode`に接続先のEquinixメトロを指定してください。
sellerRegionにメトロに関連するAWSリージョンを指定します。この情報は、[/fabric/v4/serviceProfiles/{service_profile_ID}`](https://docs.equinix.com/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileByUuid) エンドポイントから確認できます。API Prerequisites](#api-prerequisites)エンドポイントを参照してください。API の前提条件](#api-prerequisites) を参照してください。
AWSアカウントIDとしてauthenticationKeyを設定します。

サンプルcURLリクエスト：

curl -X
POST 'https://api.equinix.com/fabric/v4/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
  "type": "IP_VC",
  "name": "<your_connection_name>",
    "bandwidth": <connection_speed>,
    "redundancy": {
      "priority": "<redundancy_code>"
    },
  "aSide": {
    "accessPoint": {
      "type": "CLOUD_ROUTER",
      "router": {
        "uuid": "<cloud_router_uuid>"
      }
    }
  },
  "zSide": {
    "accessPoint": {
      "type": "SP",
      "profile": {
        "type": "L2_PROFILE",
        "uuid": "<service_profile_uuid>"
      },
      "location": {
        "metroCode": "<equinix_metro_code>"
      },
      "sellerRegion": "<aws_region_name>",
      "authenticationKey": "<amazon_account_ID>"
    }
  },
  "project": {
    "projectId": "<project_uuid>"
  },
  "notifications": [
    {
      "type": "ALL",
      "emails": [
      "<contact_email>"
      ]
    }
  ]
}'

接続状況の監視

接続ステータスを監視するには、fabric/v4/connections/{connection_id} エンドポイントに GET リクエストを送信します。

`equinixStatus` attribute values	`providerStatus` attribute values	AWS Direct Connect State	Description
`PROVISIONING`	`PROVISIONING`		Connection request has not been sent to AWS yet.
`PROVISIONED`	`PENDING_APPROVAL`	Ordering -> Requested	The connection awaits for acceptance.
`PROVISIONED`	`PROVISIONING`	Pending	Connection establishment in progress.
`PROVISIONED`	`PROVISIONED`	Pending -> Available	The connection has been accepted.

API の前提条件​

DOT1Q ポートからの接続​

QINQ ポートからの接続​

サービス・トークンを使った接続​

Network Edge デバイスから接続する​

Fabric Cloud Router から接続する​

接続状況の監視​

API の前提条件

DOT1Q ポートからの接続

QINQ ポートからの接続

サービス・トークンを使った接続

Network Edge デバイスから接続する

Fabric Cloud Router から接続する

接続状況の監視