すべてのプロダクト
Search
ドキュメントセンター

Quick BI:API インターフェイスの作成

最終更新日:Mar 14, 2025

DataService Studio は、データベースから上位アプリケーションへのインターフェイスを介したデータのプロビジョニングを可能にする機能を提供します。この機能は、Quick BI Enterprise Standard Edition 限定で利用可能です。

手順

DataService Studio 機能を構成するには、次の手順に従います。

  1. 新しい API を作成するには、Quick BI プロダクトホームページに移動し、以下の図に示されている手順に従います。

    Quick BI プロダクトホームページで、以下の図の手順に従って新しい API を作成します。image

  2. [API の作成] > [基本情報の構成] ページで、[API 名][インターフェイスワークスペース][インターフェイスデータセット][データ戻り値の型][API の説明] などのパラメーターを入力します。次に、[次へ] をクリックします。ガイダンスについては、以下の図を参照してください。image.png

  3. [API の作成] > [API パラメーターの追加] ページで、リクエストパラメーターと戻り値パラメーターを設定し、[保存] または [保存してデバッグ] をクリックします。詳細については、以下の図を参照してください。image.png

    説明

    [保存] は現在の構成を保存します。 [保存してデバッグ] は、[API のデバッグ] ページに移動します。

  4. [保存してデバッグ] を選択して [API のデバッグ] ページに進みます。ここで、デバッグパラメーター値を入力し、戻り値パラメーターを選択します。

  5. [デバッグの実行] をクリックします。以下の図に示すように、[デバッグ結果] ページに [返された JSON][データプレビュー] が表示されます。image.png

    説明

    DataService Studio で作成された API は、次の権限の対象となります。API を呼び出す Alibaba Cloud アカウントは、Quick BI 組織管理者ロールと権限管理者ロールを持っている必要があり、API を呼び出す前に少なくとも 1 回は Quick BI にアクセスしている必要があります。

関連操作

インターフェイスが確立されると、作成された API インターフェイスの ID、名前、関連付けられたデータセット、関連付けられたワークスペースなどの詳細を DataService Studio モジュール内で表示できます。表示される API と実行できる操作は、選択したタブによって異なります。

  • マイ タブには、自分が作成したすべての API とその関連情報が表示されます。このページでは、以下に示すようにさまざまな操作がサポートされています。image

    • 表示

      API ID の横にある image アイコンをクリックすると、API の 基本情報リクエストパラメーター戻り値パラメーター がポップアップウィンドウに表示されます。このウィンドウでは、API の 編集デバッグ削除、または 転送 もできます。image

    • 編集

      操作列の image アイコンをクリックすると、API の編集 ページで API を編集できます。必要に応じて API の 基本情報パラメーター情報 を変更し、保存 または 保存してテスト をクリックします。image

    • デバッグ

      操作列の image アイコンをクリックすると、API のデバッグ ページにアクセスできます。必要なパラメーター情報を更新し、デバッグの実行 をクリックします。image

    • 統計

      操作列の image アイコンをクリックすると、API 呼び出し統計 > 詳細 ページで API の詳細な呼び出しデータを表示できます。詳細については、「API 呼び出し統計」をご参照ください。image

    • 転送

      操作列の image アイコンをクリックします。API の転送 > 作成者 ページで、新しい API 作成者を選択し、確認 をクリックして転送を完了します。

      説明

      デフォルトでは、作成者ロールには、API の呼び出し権限と管理権限が含まれています。

      image

    • 削除

      操作列の image アイコンをクリックし、ポップアップウィンドウで 確認 をクリックして、選択した API を削除します。image

  • すべて タブには、現在のテナントによって作成されたすべての API とその関連情報が表示されます。

    • 現在のユーザーが作成した API の場合:API の詳細を管理および表示できます。特定の操作の手順については、マイ タブの説明を参照してください。image

    • 現在のユーザーが作成していない API の場合:これらの API の詳細のみを表示できます。管理操作のエントリポイントは使用できません。image