使用 API 建立服務金鑰
本主題說明使用 API 建立服務金鑰的程序，包含如何取得 Port ID（productUid），以及使用服務金鑰建立 VXC。
如需服務金鑰的概觀，請參閱 設定服務金鑰 與 管理服務金鑰。如需更多服務金鑰 API 資訊，請參閱 Service Keys (API Documentation)。
先決條件
在建立 service key 之前，請確認您已具備：
- 可存取 Megaport Portal 的權限。
-
在 Megaport 網路上的 Port、MCR 或 MVE。
-
有效的存取權杖。若需詳細資訊，請參閱 建立 API 金鑰。
取得 Port 的 productUid
-
在 Postman 中，按一下左側導覽中的 Product Details (產品詳細資料)，並選取 GET Product List (GET 產品清單)。
-
按一下 Send (送出)。
-
從回傳的產品詳細資料中，找到您要為其建立服務金鑰之 Port 的
productUid值。此範例使用以下 Port：
"productName": "CoreSite LA1" 位於 "city": "Los Angeles" 其 "productUid": "8611b645-ea50-46eb-b400-1c2fb858a303"
建立服務金鑰
找到要建立服務金鑰之產品的 productUid 值之後，您可以使用 Megaport API 建立服務金鑰。
建立服務金鑰
-
在 Postman 中，按一下左側導覽中的 Connections (連線)，並選取 Service Keys > POST Generate Service Key (Service Keys > POST 產生 Service Key)。
-
複製您 on-ramp（Port）的
productUid，並更新 Body。此範例中，該 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），或將vlan設定為-1以建立未標記的 VXC。備註
只有在相關 MVE vNIC 或 Port 尚未存在未標記連線時，您才可以建立單次使用的未標記服務金鑰。
這是 B-End 的 VLAN ID。如果您已指定 VLAN ID，Megaport 會檢查所要求的 VLAN ID 是否可用。當客戶使用此服務金鑰在您的 Port 上建立連線時，他們可以為 A-End 指定 VLAN ID。
如需有關 VLAN ID 的更多資訊，請參閱管理 VLAN IDs。
-
完成後，請按一下 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 建立服務金鑰並與客戶分享，但在客戶使用該服務金鑰建立連線前，該 Port 已不可用，而您想阻止客戶再使用此服務金鑰。
編輯或停用服務金鑰的方法
-
在 Postman 左側導覽列中，打開 Connections 資料夾並選取 Service Keys > PUT Update Service Key。
-
根據需要編輯服務金鑰的詳細資料。
-
若要永久停用服務金鑰，請將
active參數設為false。
共享金鑰
您可以依您偏好的方式分享服務金鑰，例如透過電子郵件或即時通訊。
備註
服務金鑰的接收者無法變更或修改服務金鑰參數。
使用服務金鑰建立 VXC
收到服務金鑰後，您可以使用該服務金鑰來建立 VXC，將服務金鑰中定義的 A-End 上線點與您的 B-End 上線點相連。
使用服務金鑰建立 VXC 的方法
-
在 Postman 左側導覽列中，打開 Connections 資料夾並選取 Service Keys > POST Create VXC with a Service Key。
-
在請求的 Body 中指定組態詳細資料。
-
productUid- 輸入您在 Megaport 位置的 Port 的productUid。 -
bEnd: productUid- 輸入從服務金鑰查詢取得的productUid位置。 -
serviceKey- Enter the full service key. -
ratelimit- 指定ratelimit，其上限為服務金鑰所設定的最大速率限制。 -
term- 指定 VXC 的合約期間。有效值為 1、12、24、36、48 與 60 個月。如果您在訂購 VXC 時未指定term，預設為 1（無最低期限）。 -
shutdown- 您可以暫時停用並重新啟用 VXC。有效值為true（停用）及false（啟用）。如果未提供，預設為false（啟用）。 -
promoCode- 您可以在服務訂單中輸入促銷代碼。該代碼不會被驗證，所以如果代碼不存在或無法用於此服務，呼叫仍會成功。 -
vlan- （選填）偏好的 A-End VLAN。請指定一個未使用的 VLAN ID 給此連線。此 VLAN ID 必須在此 Port 上唯一，範圍為 2 至 4093。如果您指定已在使用中的 VLAN ID，系統會顯示下一個可用的 VLAN 號碼。必須為唯一的 VLAN ID 才能繼續下單。如果您未指定值，Megaport 會自動指派。
供應商端終端的 B-End 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提示
為了在下單前測試您的請求且檢視價格細節，請使用
/v3/networkdesign/validate端點並採用相同的 Body 組態。
成功回應會通過驗證，並帶有 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 中。