API - IBM Cloud Direct Link 2.0 への接続
IBM Cloud™ Direct Link 2.0 で接続を確立し、IBX コロケーション資産を IBM Cloud リソースに接続します。
IBMアカウントIDの確認
IBM Cloud コンソール にログインし、Manage > Account を選択して、IBM アカウント ID を確認します。
Fabric API の前提条件
-
認証 - OAuth2用のユーザー認証情報、クライアントID、クライアントシークレットを送信します。 認証を使用します。OAuth APIを呼び出して認証情報を検証および認証する方法については、API認証を参照してください。
-
A面の情報を決めるどちらか：
- Get All Ports APIリクエストを使用して、Equinix Fabricのポート情報を取得します。
または
- Networkエッジデバイスの情報を確認します。登録済みのエクイニクス仮想デバイス／冗長デバイス／クラスタが必要です。利用可能な仮想デバイスとクラスタを確認するには、Get Virtual Devices または Get Virtual Device {uuid}をコールします。接続には、デバイス上で利用可能な任意のインターフェースを選択できます。ただし、指定がない場合はエクイニクスがインターフェースを選択します。
-
サイドメトロの場所を選択します。Get All Metros APIリクエストを使用して、Equinix Fabricが利用可能なすべてのメトロを検索し、接続先を決定します。
-
サービスプロファイルを特定します。特定のサービスプロファイルを検索するには、Retrieve Service Profiles API リクエストを使用するか、利用可能なすべてのサービスプロファイルを一覧表示するには、Get Service Profiles API リクエストを使用します。 接続先のプロフィール
DOT1QポートからIBM Cloud Direct Link 2.0への接続
DOT1Q ポートから IBM Cloud Direct Link 2.0 への接続を作成するには、/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, redundancy, aSide, zSide, additionalInfo, notifications |
サンプル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,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "DOT1Q",
"vlanTag": 1001
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"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",
"name": "Conn-1",
"state": "PROVISIONING",
"order": {
"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 1 Gbps"
},
"bandwidth": 1000,
"redundancy": {
"group": "m167f685-41b0-1b07-6de0-320a5c00abeu",
"priority": "PRIMARY"
},
"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": {
"accessPoint": {
"type": "SP",
"profile": {
"href": "https://api.equinix.com/fabric/v4/services/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5",
"type": "L2_PROFILE",
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"href": "https://api.equinix.com/v4/metros/SV",
"metroCode": "SV",
"region": "AMER"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"notifications": [
{
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
],
"operation": {
"equinixStatus": "PROVISIONING",
"providerStatus": "PROVISIONING"
},
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z"
}
}
レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの一覧とその説明については、API リファレンス を参照してください。
QINQポートからIBM Cloud Direct Link 2.0への接続
QINQ ポートから IBM Cloud Direct Link 2.0 への接続を作成するには、/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, redundancy, aSide, zSide, additionalInfo, notifications |
サンプル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,
"redundancy": {
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"type": "COLO",
"port": {
"uuid": "a867f685-41b0-1b07-6de0-320a5c00abdd"
},
"linkProtocol": {
"type": "QINQ",
"vlanCTag": 1001,
"vlanSTag": 1002
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "xx-xxx-xx",
"sellerRegion": "us-west-1"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": "12345"
},
{
"key": "CER IPv4 CIDR",
"value": "11.1.1.10/30"
},
{
"key": "IBM IPv4 CIDR",
"value": "11.1.1.10/30"
}
],
"notifications": {
"type": "ALL",
"emails": [
"test@equinix.com",
"test2@equinix.com"
]
}
}'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。
Network EdgeデバイスからIBM Cloud Direct Link 2.0への接続
Network EdgeデバイスからIBM Cloud Direct Link 2.0への接続を作成するには、/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, redundancy, aSide, zSide, additionalInfo, notifications |
サンプル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": "port2ibm2-vvv-0425f",
"bandwidth": "50",
"aSide": {
"accessPoint": {
"type": "VD",
"virtualDevice": {
"type": "EDGE",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
}
},
"zSide": {
"accessPoint": {
"type": "SP",
"profile": {
"type": "L2_PROFILE",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"location": {
"metroCode": "SV"
},
"authenticationKey": "XXXXXXXXXX",
"sellerRegion": "San Jose 2"
}
},
"additionalInfo": [
{
"key": "ASN",
"value": 12345
},
{
"key": "BGP_CER_CIDR",
"value": "172.16.0.17/30"
},
{
"key": "BGP_IBM_CIDR",
"value": "172.16.0.18/30"
},
{
"key": "Global",
"value": false
}
],
"project": {
"projectId": "16799d66-ef43-445c-ba29-d17522d8a137"
},
"order": {
"purchaseOrderNumber": "1-129105284100"
},
"notifications": [
{
"type": "ALL",
"emails": [
"x@gmail.com"
]
}
]
}
'
リクエストボディに含まれるパラメータは、この例に特有のものです。パラメーターの全リストとその説明については、APIリファレンスを参照してください。
回答例
{
"type": "EVPL_VC",
"href": "https://api.equinix.com/fabric/v4/connections/0175e136-8be7-4b04-8d57-c33c20555501",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"name": "port2ibm2-vvv-0425f",
"operation": {
"providerStatus": "PROVISIONING",
"equinixStatus": "PROVISIONING"
},
"order": {
"purchaseOrderNumber": "1-129105284100",
"billingTier": "Up to 50 MB"
},
"notifications": [
{
"type": "ALL",
"emails": [
"x@gmail.com"
]
}
],
"changeLog": {
"createdBy": "fabricamcrh1",
"createdByFullName": "XXXXX XXXXXX",
"createdByEmail": "x@gmail.com",
"createdDateTime": "2024-04-25T20:41:37.805Z",
"updatedBy": "fabricamcrh1",
"updatedByFullName": "XXXXXX XXXXXX",
"updatedByEmail": "x@gmail.com",
"updatedDateTime": "2024-04-25T20:41:37.805Z"
},
"bandwidth": 50,
"redundancy": {
"group": "d1f11356-91ca-4550-8488-ba434a771e09",
"priority": "PRIMARY"
},
"aSide": {
"accessPoint": {
"interface": {
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"id": 8,
"type": "CLOUD"
},
"location": {
"metroCode": "DC"
},
"virtualDevice": {
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"type": "EDGE"
}
}
},
"zSide": {
"accessPoint": {
"location": {
"metroCode": "SV"
},
"profile": {
"href": "https://api.equinix.com/fabric/v4/serviceProfiles/e092ed47-63d2-4f4a-87a0-82e3b08eefe5",
"type": "L2_PROFILE",
"name": "IBM Cloud Direct Link 2",
"uuid": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"sellerRegion": "San Jose 2",
"authenticationKey": "XXXXXXXXXXXXXXXXXXX"
}
}
}
レスポンスペイロードには、リクエストボディで定義された設定パラメータが含まれます。使用可能なパラメータの一覧とその説明については、API リファレンス を参照してください。
接続ステータスの監視
接続ステータスを監視するには、fabric/v4/connections/{connectionId} エンドポイントに GET リクエストを送信します。
equinixStatusattribute values | providerStatusattribute values | IBM Direct Link status | Description |
|---|---|---|---|
PROVISIONING | PROVISIONING | - | Connection request has not been sent to IBM yet. |
PENDING_PROVIDER_VLAN | PENDING_APPROVAL | Create approval pending | The connection awaits for approval. |
PROVISIONED | PROVISIONING / PROVISIONED | Create in progress | Connection establishment in progress. |
PROVISIONED | PROVISIONED | Provisioned | Connection established. |
接続を受け入れる
IBM Cloud コンソール にログインし、[IBM Cloud Direct Link Exchange ページ に移動して、保留中の接続を確認して承諾します。