API 疑難排解

如果您在使用 API 或 Megaport Terraform 解決方案時遇到問題，請依序執行以下疑難排解動作。

如需 API 教學與逐步指南，請參閱 Megaport API 總覽。如需完整參考文件（包含可運作的範例），請參閱 https://dev.megaport.com/。

若要試用 API，我們建議使用已匯入 Megaport 集合的 Postman 用戶端；有關下載與使用 Postman 的資訊請見文件。

疑難排解動作

動作	步驟
確保 API 存取權杖有效	Megaport API 呼叫需要在建立 API 金鑰後產生的存取權杖。存取權杖用於驗證 API 使用者，並僅允許暫時存取所需的 Megaport Portal 區域。存取權杖最長 24 小時即會到期，之後您需要產生新的存取權杖。如需更多資訊，請參閱建立 API 金鑰。
確保 API 環境（URL）正確	請確認您使用的 URL 是適用於目標環境。 PRODUCTION - https://api.megaport.com 完整可用的線上系統。您需自行負擔在此系統中訂購的任何服務與相關費用。 STAGING - https://api-staging.megaport.com 可讓您在不影響正式環境的情況下測試指令。此測試環境每 24 小時會以最新的正式環境值覆寫。
確保 API 參數正確	Megaport API 使用標準的 HTTP 回應代碼。一般而言，400 - Bad Request 錯誤通常是因為遺漏或不正確的參數所致。若您收到此錯誤，請再次仔細檢查您的參數。
確保您的 API 語法正確	在與 Megaport API 互動時，正確的語法至關重要。Megaport API 建立於 REST 之上，具有可預期的 URL，並接受經過表單編碼的請求本文。您可以在 https://dev.megaport.com 查看正確呼叫的範例。從此頁面的下拉式選單選擇您偏好的語言，即可看到在 API 環境中進行各項操作的範例。
API 限制	一般速率限制每個 IP 位址在一個滾動的 5 分鐘期間內有 500 次請求的限制。服務更新每 5 分鐘僅能進行一次服務更新，且每個服務每月最多 100 次更新。備註：目前這些並非硬性限制，但 Megaport 會在超出限制時加以監控與檢視。若發生超限，可能會被封鎖存取。

常見 API 錯誤訊息

登入錯誤

"message": "Bad session token - try logging in again."

常見原因：

使用者名稱、電子郵件或密碼不正確
欠缺或不正確的權杖

語法錯誤

HTTP Status 400 – Bad Request

此錯誤通常發生於必要的語法遺漏或不正確時。

API URL 不正確

與 URL 不正確相關的錯誤範例如下：

“message”:” Service abcd1234 has wrong product type VXC”

在此情境中，客戶使用了這個 URL：

URL = "https://api-staging.megaport.com/v2/product/megaport/abcd1234-1234-1234-1234-abcdef123456/telemetry?from=1614283800000&to=1614284400000&type=BITS"

但正確的 URL 為：

URL = "https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-1234-1234-abcdef123456/telemetry?type=A_BITS&from=1614283800000&to=1614284400000"

參數不正確

例如，某客戶在此時間範圍要求 VXC telemetry 時回報無資料輸出：

起始： GMT：2021 年 8 月 3 日（星期二）下午 1:52:23
結束： GMT：2021 年 8 月 3 日（星期二），下午 1:57:23

語法

https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743&to=1627999043

輸出

{“serviceUid”:”abcd1234-1234-0000000000”,”type”:”A_BITS”,”timeFrame”:{“from”:1627998743,”to:”1627999043},”data”:[ ]}

根據 Get VXC Telemetry 文件，From 與 To 參數必須以毫秒為單位提供各自的 epoch 值（因此每個值的末端需要多加數個 0）：

https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000

Megaport 需要的資料

如果上述疑難排解動作仍無法解決您的問題，請聯絡 Megaport 支援。遇到 API 問題時，Megaport 會在後端進行調查與疑難排解。

為協助調查，請提供您執行的測試結果，以及其他相關資訊，例如：

使用的電子郵件/帳戶
動作與錯誤發生的日期、時間與時區
API 組態
API URL
請求本文資料
端點參數與語法
錯誤類型與錯誤的截圖

有用的參考資料

Megaport 常見 API 問題的解決方案