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分おきに1サービス更新を行うことができ、1サービスあたり月に最大100回更新可能です。注記: 現在、これらは厳しい制限ではありませんが、Megaportは制限が破られた時に監視し見直します。制限違反が発生すると、アクセスがブロックされる可能性があります。

一般的なAPIエラーメッセージ

ログインエラー

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

一般的な原因:

ユーザー名、メール、またはパスワードが不正
トークンが不足または不正

構文エラー

HTTPステータス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テレメトリを要求した際にデータ出力がなかったことを報告しました:

開始: GMT: 2021年8月3日火曜日 1:52:23 PM
終わり: GMT: 2021年8月3日火曜日 1:57:23 PM

構文

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”:[ ]}

VXCテレメトリの取得ドキュメントから、開始と終了のパラメータは各エポック値についてミリ秒で設定する必要があります（したがって各値に余分なゼロが必要です）:

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問題の解決策