API - IBM Cloud Direct Link on Classic への接続

Classic の IBM Cloud™ Direct Link を使用して接続を確立し、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ポート情報を取得します。
サイドメトロの場所を選択します。Get All Metros APIリクエストを使用して、Equinix Fabricが利用可能なすべてのメトロを検索し、接続先を決定します。
サービスプロファイルを特定します。特定のサービスプロファイルを検索するには、Retrieve Service Profiles API リクエストを使用するか、利用可能なすべてのサービスプロファイルを一覧表示するには、Get Service Profiles API リクエストを使用します。接続先のプロフィール

DOT1QポートからClassic上のIBM Cloud Direct Linkへの接続

DOT1Q ポートから IBM Cloud Direct Link on Classic への接続を作成するには、/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": "Global",  
            "value": "false"  
        }  
    ],  
    "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"  
            },  
            "sellerRegion": "us-west-1"  
        }  
    },  
    "additionalInfo": [  
        {  
            "key": "ASN",  
            "value": "12345"  
        },  
        {  
            "key": "Global",  
            "value": "false"  
        }  
    ],  
    "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ポートからClassicのIBM Cloud Direct Linkへの接続

QINQ ポートから IBM Cloud Direct Link on Classic への接続を作成するには、/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": "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": "Global",  
            "value": "false"  
        }  
    ],  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "test@equinix.com",  
                "test2@equinix.com"  
            ]  
        }  
    ]  
}'

接続ステータスの監視

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

`equinixStatus`attribute values	`providerStatus`attribute 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 ページに移動して、保留中の接続を確認して承諾します。

IBMアカウントIDの確認​

Fabric API の前提条件​

DOT1QポートからClassic上のIBM Cloud Direct Linkへの接続​

QINQポートからClassicのIBM Cloud Direct Linkへの接続​

接続ステータスの監視​

接続を受け入れる​