API を使用したポートの作成
このトピックでは、Port を作成するための API 手順について説明します。Port の場所を調べ、Port を検証してコストを決定し、Port を注文し、許可証明書 (LOA)Letter of Authorization (LOA) は、顧客がデータセンターサービスからPortへの物理的なクロスコネクトを確立するために、データセンタープロバイダーに提示する必要がある文書です。LOAは、顧客が新しいPortをプロビジョニングする際にMegaport Portalを通じて提供されます。
をダウンロードする方法を含みます。
始める前に、有効なアクセストークンを取得してください。詳細については、API キーの作成を参照してください。
Postman コレクションで Port の場所の詳細を調べる
-
左側のナビゲーションで Locations をクリックし、GET Locations (v3) をクリックします。このリクエストは、パラメータやボディ情報を必要としません。
-
リクエストを送信するには、Send をクリックします。
GET {baseUrl}/v3/locations
ステータス: 200 OK を確認し、Body セクションを Pretty 形式で表示して、リクエストが成功したことを確認します。
リクエストは何百もの Port の場所を返します。虫眼鏡をクリックして、特定の都市、データセンター、または他のパラメータを検索フィールドに入力して検索できます。この例では、Digital Realty、ロンドンの場所を使用します。
{
"id": 89,
"name": "Digital Realty London LHR20",
"address": {
"street": "227 Marsh Wall",
"suburb": null,
"city": "London",
"state": null,
"postcode": "E14 9SD",
"country": "United Kingdom"
},
"dataCentre": {
"id": 3,
"name": "Digital Realty"
},
"metro": "London",
"market": "UK",
"status": "Active",
"longitude": -0.012144,
"latitude": 51.499714,
"orderingMessage": null,
"diversityZones": {
"red": {
"mcrSpeedMbps": [
5000,
100000,
1000,
25000,
10000,
2500,
50000
],
"megaportSpeedMbps": [
100000,
10000,
1000
],
"mveMaxCpuCoreCount": null,
"mveAvailable": true
},
"blue": {
"mcrSpeedMbps": [
1000,
2500,
5000,
10000
],
"megaportSpeedMbps": [
1000,
10000,
100000
],
"mveMaxCpuCoreCount": null,
"mveAvailable": true
}
},
"productAddOns": {
"crossConnect": {
"available": false,
"type": null
}
}
}
ポートを作成するには、market 値と id 値が必要です。この例では、マーケットは UK、データセンター ID は 89 です。
ポート注文をテストして検証するには
-
Postman で、左側のナビゲーションで Ports フォルダを開き、POST Validate Port Order (v3) を選択します。
-
Body を次の内容で更新し、Send をクリックします：
locationId（89）、term（月数 - 1、12、24、または 36）、productName（任意のポート名）、portSpeed（1000、10000、または 100000 Mbps）、およびmarket（UK）。
[
{
"locationId": 89,
"term": 1,
"locationUid": null,
"productName": "API Port",
"productType": "MEGAPORT",
"createDate": 1452475039656,
"portSpeed": 1000,
"virtual": false,
"promoCode": "promox3mnthfree2",
"market": "UK"
}
]
正常なレスポンスはバリデーションを通過し、200 OK ステータスが返されます。レスポンスにはサービスの料金詳細も含まれます。
{
"message": "Validation passed",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": [
{
"price": {
"hourlySetup": 0,
"dailySetup": 0,
"monthlySetup": 0,
"hourlyRate": 0,
"dailyRate": 0,
"monthlyRate": 500.00,
"fixedRecurringCharge": 500.00,
"postPaidBaseRate": "no base rate",
"longHaulMbpsRate": 0,
"mbpsRate": 0,
"currency": "GBP",
"key": "no key",
"productType": "MEGAPORT",
"empty": false
},
"serviceName": "API Port",
"productType": "MEGAPORT",
"productUid": "f9859fd3-344d-4a33-8cd2-a3b6ebfaaef0",
"market": "UK",
"string": "London"
}
]
}
検証済みの Port を注文するには
-
検証済みの Port リクエストとレビュー済みコスト情報を使用して、POST Validate Port Order (v3) の Body からコピーし、POST Buy Port (v3) の Body に貼り付けます。
重要
api.megaport.com でこの呼び出しを行うと、アカウントにサービスの料金が請求されます。あるいは、これらの例のようにステージング API に対してプロビジョニングしても料金は発生しません。
-
リクエストを送信します。 成功した応答には
technicalServiceUidが含まれ、これはproductUidと同じです。 この例では、この値は a49cf3f1-20a1-4390-93aa-5005bdafe3d7 です。
{
"message": "MEGAPORT [a49cf3f1-20a1-4390-93aa-5005bdafe3d7] created. ",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": [
{
"serviceName": "API Port",
"name": "API Port",
"secondaryName": null,
"technicalServiceId": 68124,
"technicalServiceUid": "a49cf3f1-20a1-4390-93aa-5005bdafe3d7",
"requestedDate": 1588862976322,
"configuredDate": null,
"currentEstimatedDelivery": null,
"companyName": "Megaport Lab",
"companyId": 2278,
"aggregationId": null,
"lagPrimary": false,
"billingContactName": null,
"billingContactId": null,
"adminContactName": null,
"adminContactId": null,
"technicalContactName": null,
"technicalContactId": null,
"salesName": null,
"salesId": null,
"billableId": 56333,
"billableUsageAlgorithm": "NOT_POST_PAID",
"productType": "MEGAPORT",
"provisioningStatus": "DEPLOYABLE",
"inAdvanceBillingStatus": "NOT_ACTIVATED",
"provisioningItems": [],
"tags": [],
"vxcDistanceBand": null,
"intercapPath": null,
"marketplaceVisibility": true,
"vxcPermitted": true,
"vxcAutoApproval": false,
"createDate": 1588862976322,
"terminationDate": null,
"contractStartDate": 1588860000000,
"contractTermMonths": 1,
"rateType": "MONTHLY",
"trialAgreement": false,
"payerCompanyId": null,
"nonPayerCompanyId": null,
"minimumSpeed": null,
"maximumSpeed": null,
"rateLimit": 10000,
"errorMessage": null,
"market": "UK",
"accountManager": null,
"promptUid": null,
"components": [],
"attributes": [],
"aLocation": null,
"bLocation": null,
"aLocationId": null,
"bLocationId": null,
"attributeTags": {},
"createdBy": "a51cc1c6-95a0-48c7-a5a0-e49d77a6c536",
"buyoutPort": false,
"virtual": false,
"locked": false,
"adminLocked": false
}
]
}
新しい Port は、作業環境に表示されます。portal.megaport.com または portal-staging.megaport.com のいずれかです.
ヒント
この例で使用したリクエストのすべてのオプションを見るには、https://dev.megaport.com を参照してください。
許可証明書 (LOA) のダウンロード
Port を作成した後、LOA をダウンロードできます。
注記
LOA をダウンロードする前に、Port のプロビジョニングステータスが設定済みである必要があります。
LOA をダウンロードするには
-
Postman で、左側のナビゲーションから Ports を展開し、GET Regenerate LOA for Megaport Service を選択します。
-
GET コマンドで、Port 作成時に生成された
productIDを置き換えます。 -
リクエストを送信します。
成功した 200 OK 応答の場合、Body セクションには次のメッセージが表示されます:
このレスポンスはプレビューできません。 ダウンロードして適切なアプリケーションで開いてください。このメッセージは、LOA が PDF ドキュメントであり、ダウンロードする必要があるため表示されます。ダウンロードするには、Postman で Save Response をクリックして、PDF を便利な場所に保存します。