超簡単に目的のAPIを探し出す方法(Alibaba Cloud)

用意するものはブラウザのみです。

今回はGoogle Chromeのデベロッパーツールでの確認方法を紹介します。

なお、EdgeやFirefoxでも類似のツールを使用して確認することができます。

手順

今回は例として、Cloud Enterprise Network(CEN)で、CENインスタンスに紐づくTransitRouterリソースを取得するAPIを調べる方法を例として紹介します。 あくまで例ですので、どの製品にも応用が効きます。

1. Alibaba Cloudで情報を取得したい製品のコンソールに移動します。今回はCENです。

2. 目的のCENのインスタンスに移動したら、Chromeのデベロッパーツールを起動します。

3. Chromeのデベロッパーツールで、Networkのタブをクリックし、filterの箇所に[api.json]と入力し、左上のレコーディングをON(丸の中に■の赤アイコン)にしておきます。

4. この状態でブラウザ画面を再読込すると、APIリクエストの状況がタイムラインとともに表示されていきます。

画面表示が落ち着くと、APIリクエストも落ち着きますので、ある程度落ち着いたところで、虫眼鏡アイコンをクリックします。

api.jsonで絞っただけではまだ情報が多いので、検索フォームにインスタンス固有のIDなどを入力し、APIリクエストのそれっぽいレスポンスを絞り込み、目的のAPI名を探ります。ここでは、TransitRouterのインスタンスIDの情報を入力します。

5. 検索フォームに情報を入力したところ、目的の情報を含むレスポンスを2つに絞ることができ、api.json?のあとに続く英大文字と小文字混じりのAPI名らしき文字列を見つけることができます。
この例では、「ListTransitRouters」になります。

このAPIがあるかどうか、公式のドキュメントとOpenAPIで検索します。ここまで絞れていると、公式ホームページのドキュメント検索でもすぐに結果がわかります。

また、ブラウザでOpenAPIにアクセスして、「ListTransitRouters」のAPIが実行可能かどうか確認します。

公式ドキュメントにも存在し、OpenAPIでも実際に実行できれば、ユーザ側でも実行可能なAPIということになります。

まとめ

ブラウザの開発者ツールを使用して、目的のAPIを特定する方法を紹介しました。

Alibaba Cloudでは膨大な数のAPIがあるため、同じ方法で他のAPIもすぐに探し出すことができるので非常に有用です。

Alibaba Cloudでは記事内でもご紹介したWeb上でAPIの実行ができるOpenAPIというツールもありますので、ブラウザツールでのAPIの特定方法とOpenAPIをご活用いただき、Alibaba CloudをAPIでより便利にご利用いただけると幸いです。

関連サービス