OpenAPI Explorer

プロダクト紹介

OpenAPI Explorerとは

OpenAPI Explorer とは、ウェブベースのビジュアル API 呼び出しツールです。 Alibaba Cloud 製品の API の呼び出しが可能で、 OpenAPI Explorer でのリクエスト構造とレスポンスが参照できます。 加えて、 OpenAPI Explorer は API リクエストに従って自動的に SDK サンプルを作成し、 Alibaba Cloud SDK を用いたアプリケーションの構築を支援します。

OpenAPI Explorer の URL は 『https://api.aliyun.com』です。

OpenAPI Explorer は無料の API 呼び出しツールです。 しかし、 ECS インスタンスなどのクラウドリソースを作成する目的で API を使用した場合には、料金が発生する可能性があります。 詳細は、各クラウド製品のドキュメントをご参照ください。

OpenAPI Explorer

OpenAPI Explorer は次の機能を提供します。

  • API の検索
    OpenAPI Explorer には、ほぼ全製品の API が含まれています。 OpenAPI Explorer は、使用したい API を迅速に検索します。
  • API の呼び出し
    ウェブページに要求値をゼロコードで入力すると、API を呼び出せます。
  • リクエスト URL の表示
    リクエストパラメーターに従って、 OpenAPI Explorer は自動的にリクエスト URLを生成します。
  • レスポンスの表示
    リクエストに対するレスポンスは、自動的に JSON フォーマットに表示されます。
  • SDK サンプルの生成
    OpenAPI Explorer は、 API リクエストに従って自動的に SDK サンプルを生成します。
  • CLI 呼び出しのサポート
    ウェブベースの CLI ツールである Cloud Shell を用いて、OpenAPI Explorer でクラウドリソースの管理が可能です。

シナリオ

OpenAPI Explorer は、 Alibaba Cloud ベースのアプリケーションを開発するために、 Alibaba Cloud 製品の API を容易に見つけ出し使用することに特化しています。 OpenAPI Explorer は、どの API が Alibaba Cloud から提供されたか特定することもできます。詳細は、 API 定義をご参照ください。 OpenAPI Explorer は API デバッグやトラブルシューティングなどのシナリオに適用できます。

  • Alibaba Cloud API の呼び出し
    Alibaba Cloud API をベースにしたアプリケーション開発を始める前に、 API リクエストとレスポンスの確認が必要な場合があります。 OpenAPI Explorer はウェブページベースのオンラインデバッグとCLI デバッグメソッドを提供しています。これにより、可視化された API コールの結果を確認できるようになります。 さらに、API の呼び出しが失敗した場合、 OpenAPI Explorer に表示されたエラーメッセージに従って、リクエストの問題を解決できます。
  • SDK サンプルの表示
    Alibaba Cloud SDK を使ったアプリケーション開発の際には、開発を支援するいくつかのコードサンプルが必要になるケースが多々あります。 OpenAPI Explorer は API リクエストに従って、 Java 、 PHP 、 Python 、 Node.JS などのプログラム言語の SDK サンプルを自動生成し、開発プロセスをわかりやすく説明します。

ユーザーガイド

ウェブページ上での API の呼び出し

ブラウザで直接 OpenAPI Explorer にアクセスでき、AccessKey の設定なしでプロダクト API の呼び出しが可能です

このタスクについて

警告:OpenAPI Explorer で API を呼び出すと、クラウドリソースの操作が可能となってしまうためご注意ください。

手順

  1. ウェブブラウザを開いて「https://api.aliyun.com」を入力し、 OpenAPI Explorer にアクセスします。
  2. 左側ナビゲーションウィンドウで [製品] をクリックして使用する製品を見つけます。 選択した製品はすべて API を確認できます。 OpenAPI Explorer
  3. 使用する API を検索してパラメータの値を入力した後に、[リクエストの送信] をクリックします。 ご自身のアカウントで Alibaba Cloud にログインして API を呼び出します。

    注:パラメータにはアスタリスク (*) をつけ、パラメータ値を提供しなければなりません。

    OpenAPI Explorer
  4. レスポンスの確認
    エラーとなった場合、エラーメッセージに従って API リクエストの修正を行います。

Cloud Shell を用いた API の呼び出し

Cloud Shell は OpenAPI Explorer にあらかじめインストールされています。 Cloud Shell は Alibaba Cloud CLI に構築されたオンラインの CLI ツールです。 AccessKey のインスト―ル、設定は不要です。

Alibaba Cloud プロダクトの API は、RPC API と RESTful API の 2 種類に分けられます。 ほとんどのプロダクトは RPC を使用しています。 種類の異なる API は、呼び出す方法も異なります。

以下の特性によって API の種類を判断できます。

  • パラメータには Action フィールドを含める API は RPC で、PathPattern フィールドを含める API は RESTful です。
  • 通常、プロダクト内のすべての API の種類は同じです。
  • 各 API でサポートする呼び出し方法が 1 つのみで、間違った方法で呼び出しすると ApiNotFound エラーが返されます。

Cloud Shell の使用

以下の手順に従って、OpenAPI Explorer で Cloud Shell を使用します。

  1. ウェブブラウザを起動し、「https://api.aliyun.com」を入力して OpenAPI Explorer にアクセスします。
  2. トップメニューで、[Online Linux Shell] をクリックします。
  3. Alibaba Cloud アカウントで Cloud Shell にログインします。

Cloud Shell での RPC API の呼び出し

次のコマンドを使用して RPC API を呼び出します。

aliyun <ProductCode> <ActionName> [--parameter1 value1 --paramter2 value2]
説明
ProductCode
呼び出すプロダクトのコード。 例えば、ECS の製品コードは ecs で、SLB の製品コードは slb です。 aliyun --help コマンドを実行して、プロダクトコードを取得します。
ActionName
呼び出す API。 たとえば、DescribeInstanceAttribute API を呼び出して、ECS インスタンスの詳細情報を表示します。
parameter
API のパラメータ。 各パラメータの詳細は、各プロダクトの API 資料をご参照ください。

例:次のコマンドを実行して ECS インスタンスの詳細情報を表示します。

注:コマンドを実行する前に、表示したい ECS インスタンスの ID を変更します。

aliyun ecs DescribeInstanceAttribute --InstanceId i-bp198exxxxxx | jq 

Cloud Shell での RESTful API の呼び出し

Container Service などの一部の Alibaba Cloud プロダクトは RESTful API を提供します。 RESTful API の呼び出し方法は、RPC API とは異なります。 Cloud Shell で RESTful API を呼び出すときのリクエスト構造は次のとおりです。

GET リクエスト
 aliyun ecs DescribeInstanceAttribute --InstanceId i-bp198exxxxxx | jq 

 aliyun cs GET /clusters 
POST リクエスト
 aliyun <ProductCode> POST /<Resource> --body "$(cat input.json)"

 aliyun cs POST /clusters//attach --header "Content-Type=application/json" --body "$(cat attach.json)"
DELETE リクエスト
 aliyun <ProductCode> DELETE /<Resource> 

 aliyun cs DELETE /clusters/<cluster-id>

SDK サンプル

OpenAPI Explorer は API リクエストに従って、Java、Python、PHP、Node.js の SDK サンプルを自動生成します。

注:共通リクエストの呼び出し方法は SDK サンプル内で使用されています。 詳細は、「CommonRequest の使用」をご参照ください。

SDK サンプル

FAQ

OpenAPI Explorer を使用する際の注意事項

OpenAPI Explorer では、オンラインデバッグページで APIを呼び出すか、または、Cloud Shell を使って APIを呼び出すかは関係なく、実際の Alibaba Cloud のリソースで操作が行われます。 使用中のリソースへの影響を防ぐためには、[リクエストの送信] をクリックする前に該当リクエストの確認を注意して行ってください。

OpenAPI Explorer の料金

OpenAPI Explorer とプロダクト API はいずれも無料です。 しかし、以下 2 つの条件に合致する場合は費用が発生します。

  • API を使ってクラウドリソースを作成した場合、または、サービスを有効にした場合。 たとえば、CreateInstance API を使って ECS インスタンスを作成した場合などです。 詳細は、各製品の価格情報を記載したドキュメントをご参照ください。
  • Alibaba Cloud Market で提供されている API を呼び出す場合、まず始めに API の購入が必要です。購入後は、呼び出し回数に応じて請求されます。

OpenAPI Explorer 使用にあたっての準備

Alibaba Cloud アカウントを準備し、あらかじめ製品使用にあたって必要な許可を得ます。

Cloud Shell と CLI の違い

Cloud Shell は Alibaba Cloud CLI 上で構築されています。 コマンドの構造と使用方法はAlibaba Cloud CLI と同じです。 しかし、Cloud Shell ではインストールと設定が不要で、 ウェブブラウザ経由での使用が可能です。