API のトラブルシューティング
API や Megaport Terraform ソリューションで問題が発生した場合は、以下のトラブルシューティングを実施します。
API のチュートリアルやステップバイステップのガイドについては、「API の概要」を参照してください。動作例を含む完全なリファレンスについては、https://dev.megaport.com/ を参照してください。
API を試すには、インポートされた Megaport コレクションを備えた Postman クライアントをお勧めします。Postman のダウンロードと使用に関する情報は、ドキュメンテーションに記載されています。
トラブルシューティング
| アクション | ステップ |
|---|---|
| API アクセス トークンが有効であることを確認する | Megaport API コールには、API キーを作成した後に生成するアクセス トークンが必要です。アクセス トークンは API ユーザーの認証に必要で、Megaport Portal の必要な部分だけに一時的にアクセスできるようにするものです。アクセス トークンは 24 時間後までに失効します。失効したら、新規アクセス トークンを生成する必要があります。詳細については、「API キーの作成」を参照してください。 |
| API 環境 (URL) が正しいことを確認する | 使用している URL が意図した環境のものであることを確認します。
|
| API のパラメータが正しいことを確認する | Megaport API は、標準的な HTTP レスポンス コードを使用します。「400 - Bad Request」エラーは、通常、欠落した、または不正なパラメータが原因で発生します。このエラーが発生する場合は、パラメータを再確認します。 |
| API の構文が正しいことを確認する | Megaport API を使用する際には、正しい構文が必要です。Megaport API は REST に基づいており、予測可能な URL を持ち、フォームエンコードされたリクエスト ボディを受け入れます。 正しい呼び出しの例については、https://dev.megaport.com/ を参照してください。このページのドロップダウン メニューから希望の言語を選択すると、API 環境内で処理を行う際の例を見ることができます。 |
| API の制限 | 一般的な帯域制限 1 つの IP アドレスに対して、5 分間に 500 リクエストまでの帯域制限があります。 サービスの更新 サービスの更新は 5 分ごとに 1 回のみ可能で、1 つのサービスにつき月に最大 100 の更新が可能です。 注意: これらの制限は現状では厳格なものではありませんが、制限を超えた場合は、Megaport が監視や審査を行います。制限を超えると、アクセスがブロックされる可能性があります。 |
一般的な API のエラー メッセージ
ログイン エラー
「メッセージ」: 「Bad session token - try logging in again. (セッション トークンが不正です - 再度ログインを試みてください。)」
一般的な原因:
- 不正なユーザー名、E メール、またはパスワード
- 欠落した、または不正なトークン
構文エラー
HTTP Status 400 - Bad Request (HTTP ステータス 400 - 不正なリクエスト)
このエラーは一般的に、必要な構文が欠落していたり、不正な場合に発生します。
不正な API の URL
不正な URL に関連したエラーの例を示します。
「メッセージ」: 「Service abcd1234 has wrong product type VXC (サービス abcd1234 に間違ったプロダクト タイプ 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
- 終了時: 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 docs (VXC テレメトリーの取得)」ドキュメンテーション』によると、From と To のパラメータは、各エポック値に対してミリ秒単位で設定する必要があります (そのため、各値の末尾に 0 を追加する必要があります)。
https://api-staging.megaport.com/v2/product/vxc/abcd1234-1234-0000000000telemetry?type=A_BITS&from=1627998743000&to=1627999043000
Megaport が必要とするデータ
トラブルシューティングを行っても問題が解決しない場合は、Megaport サポートにお問い合わせください。 API に問題がある場合、Megaport はバックエンドで問題を調査し、トラブルシューティングを行います。
調査を支援するために、実施したテストの結果や以下のその他の関連情報を提出してください。
- 使用した E メール/アカウント
- アクションとエラーが発生した日付、時刻、タイムゾーン
- API の構成
- API の URL
- ボディ データ
- エンドポイントのパラメータと構文
- エラーのタイプとそのスクリーンショット