API Inspector は実験的な機能です。 API Inspector では、各ステップの背後にある API 呼び出しをコンソールに表示すること、および異なる言語の API コードを自動生成することができます。 Cloud Shell または API Explorer からオンラインでデバッグすることができます。

機能

API Inspector、API Explorer、および Cloud Shell は、API を学習しデバッグするための統合的なソリューションを形成します。 以下の機能が備わっています。
  • 自動記録: 関連する API 呼び出しを取得するには、通常どおりコンソールで操作を実行します。 詳細は、「API 呼び出しの自動記録」をご参照ください。
  • ワンクリックでのコード生成: 事前に入力されたパラメーターを使用し、さまざまな言語の API コードスクリプトが生成され、これらを直接実行することができます。 詳細は、「ワンクリックで API コードを生成する」をご参照ください。
  • オンラインデバッグ: API Inspector を API Explorer および Cloud Shell と一緒に使用すると、ワンクリックのオンラインデバッグ環境を実装することができ、開発環境を構築する必要はありません。 取得したものがそのまま表示されます。 詳細は、「API Explorer によるオンラインデバッグ」および「Cloud Shell によるオンラインデバッグ」をご参照ください。

API Inspector の有効化

API Inspector を有効化するには、以下の手順を実行します。
  1. SLB コンソールにログインします。
  2. 左側のナビゲーションウィンドウで、[SLB Lab] > [API Inspector] をクリックします。
  3. [API Inspector] ページで、API Inspector を有効化します。 API 中断ペンダントがページの右側に表示されます。


API 呼び出しの自動記録

API Inspector の自動記録機能を説明するため、SLB インスタンスの名前の変更を例として取り上げます。
  1. [インスタンス] > [Server Load Balancer] をクリックします。
  2. SLB インスタンスの名前を SLB1 に変更します。
  3. [OK] をクリックします。
  4. ページ右側の をクリックします。 前の操作に関連した API 呼び出しをすべて見ることができます。


  5. コア API を表示するには、[クラス OpenAPI Explorer の説明を非表示にする] をクリックします。 この例でのコア API は SetLoadBalancerName です。


ワンクリックで API コードを生成する

API の記録の完了後、 API 名をクリックすると、事前に入力されたパラメーターを使用し、Python、Java、Go、Node.js、および PHP の API コードスクリプトが生成されます。

をクリックすると、対応する形式のコードスクリプトがコピーされ、このスクリプトは直接実行できます。


API Explorer によるオンラインデバッグ

API の記録の完了後、[OpenAPI Explorer] または をクリックして、OpenAPI Explorer コンソールに移動し、対応する機能をデバッグします。 API のパラメーター値は、コンソールの操作に従って自動的に生成されます。



をクリックすると、呼び出された API のパラメーターを詳細に説明するドキュメントが表示されます。

Cloud Shell によるオンラインデバッグ

API の記録の完了後、API 呼び出しの詳細を展開し、 をクリックすることにより、Cloud Shell のオンラインワンクリックデバッグを利用することができます。

Cloud Shell のワンクリックデバッグを利用する場合、頻繁に利用するスクリプトとファイルを保存するための OSS バケットを作成し、関連付けることを推奨します。 ただし、少額の OSS 利用コストが発生します。 OSS バケットを作成しなくてもかまいません。
SLB の Cloud Shell デバッグ用クラウドコマンドラインの形式は以下のとおりです。
aliyun slb actionName --parameter1 value1 --paramter2 value2...
この例では、呼び出された SetLoadBalancerName API が、SLB インスタンスの名前を SLB1 に変更しています。同様に次のクラウドコマンドラインを実行します。
aliyun slb SetLoadBalancerName --RegionId cn-hangzhou --LoadBalancerName SLB1 --LoadBalancerId lb-bp1b6c719dfa08exfuca5
このコマンドを実行した場合の戻り値は以下のようになります。
{"RequestId":"14466282-B00F-49C1-B11E-FB8D3772E3DA"}