APIでサービスキーを作成する
このトピックでは、サービスキーを作成するためのAPI手順、Port ID（productUid）の取得方法、およびサービスキーでのVXCの作成方法について説明します。
サービスキーの概要については、サービスキーの設定およびサービスキーの管理を参照してください。サービスキーAPIについての詳細は、サービスキー (APIドキュメント)をご覧ください。
前提条件
- Megaport Portalへのアクセス。
-
Megaportネットワーク上のPort、MCR、またはMVE。
-
有効なアクセストークンを持っている必要があります。詳細については、APIキーの作成を参照してください。
PortのproductUidを取得するには
-
Postmanで、左のナビゲーションのProduct Detailsをクリックし、GET Product Listを選択します。
-
Sendをクリックします。
-
返された製品の詳細から、サービスキーを作成したいPortの
productUid値を見つけます。この例では、次のPortを使用します：
"productName": "CoreSite LA1" in "city": "Los Angeles" with "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
サービスキーの作成
作成したい製品のproductUid値を特定した後、Megaport APIを使用してサービスキーを作成できます。
サービスキーを作成するには
-
Postmanで、左のナビゲーションのConnectionsをクリックし、Service Keys > POST Generate Service Keyを選択します。
-
オンランプ(Port)の
productUidをコピーし、ボディを更新します。この例では、Portの
productUidの値は8611b645-ea50-46eb-b400-1c2fb858a303です。{ "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303", "description": "Documentation Service Key - Single Use", "active": true, "_set_singleUse_to_false_to_make_service_key_multiUse": true, "singleUse": true, "maxSpeed": "500", "preApproved": true, "vlan": 3, "validFor": { "_make_start_timestamp_equal_to_now": 1608506197135, "start": 1608506197135, "_make_end_timestamp_equal_to_1_month_forward": 1612015200000, "end": 1612015200000 } } -
Body に追加パラメータを指定します。たとえば、レート制限（
maxSpeed）、キーの有効期間（validFor）、単一使用キー（"singleUse": true）か複数回使用キー（"singleUse": false）かなどです。日付は UNIX タイムスタンプ形式で入力します。以下のようなツールを使用して正しい値を確認できます。
https://www.epochconverter.com/ または https://it-tools.tech/date-converter。単一使用キーの場合は、VLAN ID（
vlan）を指定します。これは Bエンドの VLAN ID です。Megaport は要求された VLAN ID が使用可能かどうかを確認します。顧客がこのサービスキーを使用して自分の Port に接続を作成する際、Aエンド用の VLAN ID を指定できます。
VLAN ID の詳細については、VLAN ID の管理 を参照してください。
-
入力が完了したら、Send をクリックしてリクエストを送信します。
POST /v2/service/key
正常なレスポンスはバリデーションを通過し、200 OK ステータスが返されます。
{
"message": "New service key [106e38ae-eb59-415f-ac81-526a5299851d] generated",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": {
"key": "106e38ae-eb59-415f-ac81-526a5299851d",
"createDate": 1712277262872,
"companyId": 1153,
"companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
"companyName": "Megaport Lab",
"description": "Documentation Service Key - Single Use",
"productId": 193076,
"productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
"productName": "My new Port",
"vlan": 3,
"maxSpeed": 500,
"preApproved": true,
"singleUse": true,
"lastUsed": null,
"active": true,
"validFor": {
"start": 1608506197135,
"end": 1612015200000
},
"expired": true,
"valid": false,
"promoCode": null,
"productDto": {
"productUid": "8611b645-ea50-46eb-b400-1c2fb858a303",
"productName": "My new Port",
"portSpeed": 1000,
"locationId": 60,
"vxcPermitted": true,
"companyUid": "160208ae-01e4-4cb9-8d57-03a197bd47a8",
"companyName": "Megaport Lab",
"connectType": "DEFAULT",
"productId": 193076,
"productType": "MEGAPORT",
"provisioningStatus": "LIVE",
"createDate": 1712268634020,
"createdBy": "0b367492-186d-47ab-96e0-34ca03d29dcd",
"terminateDate": null,
"liveDate": 1712268694790,
"market": "US",
"costCentre": "Optional finance reference",
"usageAlgorithm": "NOT_POST_PAID",
"marketplaceVisibility": false,
"secondaryName": null,
"lagPrimary": false,
"lagId": null,
"aggregationId": null,
"contractStartDate": 1712268694807,
"contractEndDate": 1714831200000,
"contractTermMonths": 1,
"associatedVxcs": [],
"associatedIxs": [],
"attributeTags": {},
"virtual": false,
"buyoutPort": false,
"locked": false,
"adminLocked": false,
"diversityZone": null,
"nserviceId": 521477,
"cancelable": true
}
}
}
新しいサービスキーがMegaport Portalに表示されます。
キーの編集または無効化
サービスキーの詳細を編集したり、サービスキーを恒久的に無効化することができます。
キーを無効化したい理由はいくつか考えられます。たとえば、自社のPortの1つに対してサービスキーを作成し、それを顧客と共有したものの、顧客がそのサービスキーを使用して接続を作成する前にPortが使用できなくなった場合、顧客がそのサービスキーを使用できないようにしたいと考えるかもしれません。
サービスキーを編集または無効化するには
-
Postmanで、左側のナビゲーションのConnectionsフォルダを開き、Service Keys > PUT Update Service Keyを選択します。
-
必要に応じてサービスキーの詳細を編集します。
-
サービスキーを恒久的に無効化するには、
activeパラメータをfalseに設定します。
キーの共有
サービスキーは、メールやメッセージングなど、お好みの方法で共有できます。
注記
サービスキーの受取人は、サービスキーのパラメータを変更または修正することはできません。
サービスキーを使用したVXCの作成
サービスキーを受け取った後は、そのサービスキーを使用して、サービスキーで定義されたAエンドのオンランプと、自身のBエンドのオンランプを接続するVXCを作成できます。
サービスキーを使用してVXCを作成するには
-
Postmanで、左側のナビゲーションのConnectionsフォルダを開き、Service Keys > POST Create VXC with a Service Keyを選択します。
-
リクエストのBodyで設定の詳細を指定します。
-
productUid- 自社のMegaportロケーション内のPortのproductUidを入力します。 -
bEnd: productUid- サービスキー検索から取得したロケーションのproductUidを入力します。 -
serviceKey- サービスキー全体を入力します。 -
ratelimit- サービスキーで設定された最大レート制限までのratelimitを指定します。 -
term- VXCの契約期間を指定します。指定できる有効な値は 1、12、24、36 ヶ月です。termを指定しない場合、VXCの注文には 1（最低契約期間なし）がデフォルトで適用されます。 -
shutdown- VXCを一時的に停止したり再有効化したりできます。有効な値はtrue（停止）およびfalse（有効）です。指定しない場合、デフォルトはfalse（有効）になります。 -
promoCode- サービス注文用のプロモーションコードを入力できます。このコードは検証されないため、存在しない場合やサービスに適用されない場合でも、リクエストは成功します。 -
vlan- （オプション）希望するAエンドのVLANを指定します。この接続に使用されていないVLAN IDを入力してください。このVLAN IDはこのPortで一意である必要があり、2〜4093の範囲で指定できます。既に使用されているVLAN IDを指定した場合、システムは次に使用可能なVLAN番号を表示します。注文を続行するには一意のVLAN IDが必要です。値を指定しない場合、Megaportが自動的に割り当てます。
プロバイダー側の終端用のBエンドVLANは、サービスキーに基づいて自動的に入力されます。
{ "productUid": "7fba50bb-ac35-465b-9b8b-9a6d7335ec7a", "associatedVxcs": [ { "productName": "VXC from service key", "rateLimit": 100, "term": 12, "shutdown": false, "promoCode": "promox3mnthfree2", "serviceKey": "106e38ae-eb59-415f-ac81-526a5299851d", "aEnd": { "vlan": 2 }, "bEnd": { "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303" } } ] } -
-
完了したら、Send をクリックしてリクエストを送信します。
POST /v3/networkdesign/buyヒント
オーダー前にリクエストをテストして価格の詳細を確認するには、同じ Body 設定で
/v3/networkdesign/validateエンドポイントを使用します。
成功したレスポンスは、バリデーションに合格し、200 OK ステータスが返されます。
{
"message": "VXC [399f0fd8-8a69-4e15-abdb-537b0cb8a858] created. ",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": [
{
"createDate": 1610140443499,
"vxcOrderId": 55791,
"payerMegaPortId": 74841,
"nonPayerMegaPortId": 39950,
"payerMegaPortName": "My LA API Port",
"nonPayerMegaPortName": "BNE5-01-10G",
"payerCompanyId": 15,
"nonPayerCompanyId": 28,
"payerLocationId": 60,
"nonPayerLocationId": 44,
"salesId": null,
"payerCompanyName": "Megaport Lab",
"nonPayerCompanyName": "6YS",
"payerMegaPortNsId": 167551,
"nonPayerMegaPortNsId": 90147,
"payerVlanId": 2,
"nonPayerVlanId": 373,
"payerInnerVlanId": null,
"nonPayerInnerVlanId": null,
"payerApproverName": "Test Name",
"payerApproverId": 32278,
"nonPayerApproverName": null,
"nonPayerApproverId": null,
"payerApproval": 1610140443263,
"nonPayerApproval": 1610140443308,
"fixedTerm": true,
"duration": 1,
"rollover": true,
"serviceName": "from My LA API Port to BNE5-01-10G",
"payerStatus": "APPROVED",
"nonPayerStatus": "APPROVED",
"speed": 100,
"distanceBand": "ZONE",
"intercapPath": "",
"awsId": null,
"promoCode": null,
"rateType": "MONTHLY",
"vxcJTechnicalServiceId": 74842,
"vxcJTechnicalServiceUid": "399f0fd8-8a69-4e15-abdb-537b0cb8a858",
"provisionDate": 1610140443232,
"orderType": "NEW",
"monthlyDiscountAmount": null,
"discountMonths": null,
"amazonDirectConnectConfigDto": null,
"amsixConnectConfigDto": null,
"webAirProvItem": null,
"sdrcProvItem": null,
"rate": null,
"setup": null,
"asn": null,
"bgpPassword": null,
"usageAlgorithm": "POST_PAID_HOURLY_SPEED_LONG_HAUL_VXC",
"costCentre": null,
"azureServiceKey": null,
"oracleVirtualCircuitId": null,
"serviceKey": "106e38ae-eb59-415f-ac81-526a5299851d",
"connectType": "DEFAULT",
"payerConfig": {},
"nonPayerConfig": {},
"attributeTags": {},
"fullyApproved": true
}
]
}
サービスキーVXC の注文後、接続先の会社に通知が送信され、受信する会社はキーを承諾するか拒否することができます。キーを変更することはできませんが、受け入れる前にサービスキーのパラメータの変更を要求することができます。
サービスキーVXC は、両社のMegaport Portalに表示されます。