OpenAPI Explorer を試してみた

こんにちは。
ネクストスケープの開發@mamikaihatsu)です。

先日、Alibaba Cloud に OpenAPI Explorer というプロダクトがリリースされました。
CLI記事を連続投稿していた私にとって、これは記事にしなきゃと思い、早速試してみました。


OpenAPI Explorerとは

Webインターフェイス や WebCLI ( Cloud Shell ) から APIを呼び出して、プロセス全体を表示する事が可能。
また、リクエストパラメータに基づいたSDKのサンプルコードを自動生成する事も出来ます。

主な機能

  • WebインターフェイスでAPIリクエスト
  • WebCLIでAPIリクエスト
  • SDKのサンプルコードの自動生成

つまり・・
ブラウザ上で、準備不要ですぐにAPIを試す事ができ、SDKのサンプルコードが自動生成されるので、
Alibaba Cloudを活用したアプリ開発をスムーズに進めることが出来るのです。

とても便利です!

ただし、APIリクエストは実際に実行されるので、
リソースの作成や削除など、十分に注意してください。
また、すでに利用した事のあるプロダクトしか使用しませんが、
新たに利用する際は、先に管理コンソールから有効化をしておく必要があります。


OpenAPI Explore を使ってみる

OpenAPI Explorer の専用サイト(https://api.aliyun.com)にアクセス

メニューは以下になります。

  • Online Debug (Webインターフェイスでのリクエスト、SDKコード自動生成)
  • Online Linux Shell (WebCLIでのリクエスト)

Online Debug (Webインターフェイスでのリクエスト、SDKコード自動生成)

■何が出来るか
プロダクトのApiNameや、そのパラメータを調べたり、リクエストを投げる事ができ、レスポンスの確認も可能。また、入力した内容のSDKのサンプルコードも自動生成する事が出来ます。

■フロー
[Online Debug]をクリックし、プロダクト選択、ApiNameを選択、パラメータを入力といった流れになります。
自動生成のコードはJava,Node.js,Go,PHP,Pythonから選択可能。
SDKには.NET版もあるのに、ここでは選択欄にないです・・・。きっと今後対応することに期待!

試しに、東京リージョンのゾーンAのECSインスタンスのステータス一覧を取得してみます

プロダクト:Elastic Compute Service
ApiName:DescribeInstanceStatus
パラメータ:RegionID:Japan(Tokyo),ZoneID:ap-northeast-1a

パラメータを入力すると、SDKのサンプルコードが自動で書き換わります。

[Submit Request]をクリックすると、Json形式での結果が出力されました。

必要なパラメータが何なのかを調べなくても良いので、とても作成しやすいです。
レスポンス時間も表示されているので嬉しいですね。

Online Linux Shell (WebCLIでのリクエスト)

■何が出来るか
Alibaba Cloud CLIはもちろんのこと、python、curl、ssh、kubectl、fun、terraform、vimが
すでにインストールされた Cloud Shell を利用する事が出来ます。

■フロー
[Online Linux Shell]をクリックすると、最初、[Authorization]メッセージが表示されます。
1時間で認証が切れるようになっているらしいです。
再度表示しない場合は[Don’t remind me on this device]にチェックを入れて[OK]を押してください。

次に、スクリプトやファイルの保存の為に、NASをマウントするかと聞かれます。
今はお試し利用なので、一旦スキップしておきます。

CLIが起動されました!

すでにログインされているので、aliyun configureは不要です。

Webインターフェイスの時と同じAPIをCLIで入れてみます。

$ aliyun ecs DescribeInstanceStatus --RegionId ap-northeast-1 --ZoneId ap-northeast-1a

問題なく結果が表示されました。
インストール不要なので、とても楽に実行できました。


最後に

視覚的にも分かりやすく、調査コストを大幅に削減する事ができ、とても便利です。
管理コンソールよりCLIで操作したい派はもちろんですが、ちょっとAPIを確認したい時にも使えそうです。