Dataphin:ウィザードモードで API を作成する (Dataphin テーブル)

前提条件

• 論理テーブルに基づいて API を作成するには、まず論理ディメンションテーブル、論理ファクトテーブル、論理集計テーブルなどの必要な論理テーブルを作成する必要があります。詳細については、「ディメンションモデリング」をご参照ください。

• 作成した論理テーブルに対して、統合モジュールで同期タスクを 次のように 構成します。

  同期タスクの宛先データソースは、DataService Studio でサポートされている必要があります。また、データソースに対するリードスルー権限も必要です。

  • 左側のナビゲーションウィンドウで、[O&M] > [定期タスク] を選択します。論理テーブルに対応するノードを選択します。[データバックフィル] > [現在および下流ノードのバックフィル] を選択します。ノードリストで、レイヤー 6 を選択し、リスト内のすべてのノードを選択します。データバックフィルインスタンスが正常に実行されたことを確認します。詳細については、「付録: 定期タスクのデータバックフィル」をご参照ください。

  • [アドホッククエリ] で、データが期待どおりであること、および論理テーブルにデータが含まれていることを確認します。詳細については、「データのクエリとダウンロード」をご参照ください。

  • 統合モジュールで同期タスクを構成します。入力コンポーネントには、[論理テーブル入力設定] (LogicalTable) を選択します。出力コンポーネントには、[MySQL 出力コンポーネント] を選択します。詳細については、「LogicalTable 入力コンポーネントの設定」および「MySQL 出力コンポーネントの設定」をご参照ください。

    同期タスクを構成して公開した後、DataService Studio で論理テーブル API を作成して送信または公開できます。

制限事項

論理テーブルから作成された API は、コンピュートエンジンの制限を受けます。サポートされているコンピュートエンジンの詳細については、「DataService Studio でサポートされているコンピュートエンジン」をご参照ください。

権限の説明

プロジェクトの管理者と開発者は API を作成できます。

注意事項

API のリクエストパラメーターとレスポンスパラメーターは、同じ論理テーブルから取得する必要があります。そうでない場合、API 呼び出しは失敗します。

ステップ 1: API を作成する方法を選択する

1. Dataphin のホームページの上部メニューバーで、[サービス] > [API 開発] を選択します。

2. 左上隅でプロジェクトを選択します。左側のナビゲーションウィンドウで、[API サービス] をクリックします。[API] ページで、[+ API の作成] をクリックします。

3. [API の作成] ダイアログボックスで、[論理テーブル API - ウィザードモード] (Dataphin テーブル) を選択します。

ステップ 2: API パラメーターを設定する

1. [API の作成] ページで、API の基本情報とパラメーターを設定します。

   API の基本情報

   パラメーター	説明
   API 名	API の名前を入力します。名前は次のルールに従う必要があります: 文字、数字、アンダースコア (_)、および漢字のみを含めることができます。 長さは 4～100 文字である必要があります。 文字で始まる必要があります。 グローバルに一意である必要があります。
   リクエストメソッド	API は GET および LIST リクエストメソッドをサポートしています。 GET: サーバーに特定のリソースを取得するようにリクエストします。 LIST: サーバーにリソースの一部を取得するようにリクエストします。
   データ更新頻度	API が更新されたデータを返す頻度。これにより、呼び出し元はデータの適時性を理解できます。サポートされている頻度は、[日次]、[毎時]、[毎分]、および [カスタム] です。[カスタム] を選択した場合は、最大 128 文字まで入力できます。
   API グループ	現在のプロジェクトから API グループを選択します。グループを作成するには、「サービスグループの作成」をご参照ください。
   説明	API の簡単な説明を入力します。説明は最大 128 文字です。
   プロトコル	API は [HTTP] および [HTTPS] プロトコルをサポートしています。 HTTP: Hypertext Transfer Protocol。HTTP は最も広く使用されているネットワークプロトコルです。 HTTPS: ゲートウェイが Alibaba Cloud API Gateway の専用または共有インスタンスとして構成されている場合は、HTTPS プロトコルを選択できます。呼び出しの失敗を防ぐために、独立ドメインの SSL 証明書が有効であることを確認してください。SSL 証明書を構成するには、[プラットフォーム管理ネットワーク構成] を選択し、[ネットワーク構成] ページに移動します。
   タイムアウト	API 呼び出しを監視する最大時間。デフォルト値は 3 秒です。3〜60 秒の正の整数を設定できます。 API 呼び出しが指定された [タイムアウト] を超えると、エラーが報告されます。これにより、API 呼び出し中の例外を迅速に検出して処理できます。例外を表示するには、「サービス監視 API の表示と管理」をご参照ください。
   キャッシュ設定	キャッシュを [有効] または [無効] にできます。有効にした場合は、[キャッシュタイムアウト] を設定する必要があります。デフォルトは 300 秒で、60 秒から 1,000,000 秒 (約 277.78 時間) の間の正の整数を設定できます。
   バージョン番号	API のバージョン番号を入力します。各構成にはバージョン番号があるため、以前のバージョンと比較できます。バージョン番号は API に対して一意である必要があります。命名規則は次のとおりです: 最大長は 64 文字です。 大文字と小文字、数字、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。
   戻り値の型	デフォルト値は JSON です。

   API リクエストおよびレスポンスパラメーター

   API の [リクエストパラメーター] と [レスポンスパラメーター] を設定するには、まず入力パラメーターと出力パラメーターのソース ([論理テーブル]) を決定します。次に、パラメーターを [リクエストパラメーター] と [レスポンスパラメーター] のエリアに追加します。最後に、[リクエストパラメーター] と [レスポンスパラメーター] の基本情報を設定します。

   1. [パラメーターチェック] パネルで、[モード] と [Dataphin 論理テーブル] を選択します。選択した論理テーブルのすべてのフィールドがページの下部に一覧表示されます。

      

      パラメーター	説明
      モード	[Basic] モードと [Dev_Prod] モードがサポートされています。 基本モードでは、開発、送信、公開中に本番データベースが読み取られます。 Dev-Prod モードでは、開発と送信中に開発者データベースが読み取られ、公開後に本番データベースが読み取られます。
      論理テーブルフィールド	論理テーブルを含む業務カテゴリを選択し、次に論理テーブルを選択します。テーブルからすべてのフィールドまたは単一のフィールドをコピーできます。

   2. 左側のリストで 1 つ以上のフィールドを選択します。 アイコンをクリックして、選択したフィールドを右側の [リクエストパラメーター] リストに追加します。次に、リクエストパラメーターの基本情報を設定します。

      

      パラメーター	説明
      パラメーター名	ユーザーが API にアクセスするために使用する公開パラメーター。命名規則は次のとおりです: 文字、数字、またはアンダースコア (_) を含めることができます。 文字で始まる必要があります。 長さは 1〜64 文字である必要があります。
      バインドフィールド	API が呼び出されたときにアクセスされる内部パラメーター。
      パラメータータイプ	パラメータータイプには、[DOUBLE]、[FLOAT]、[STRING]、[DATE(yyyy-MM-dd HH:mm:ss)]、[BOOLEAN]、[INT]、[LONG]、[SHORT]、[BYTE]、[BIGDECIMAL]、および [BINARY] があります。 論理テーブルのフィールドタイプに対応するパラメータータイプを選択します。フィールドタイプが利用可能なパラメータータイプのリストにない場合は、String を選択します。
      オペレーター	API が呼び出されたときにリクエストパラメーターを処理するために使用されるメソッド。サポートされているオペレーターとその意味の詳細については、「付録: API 開発でサポートされているオペレーター」をご参照ください。
      例	開発者を支援するために、リクエストパラメーターのサンプル値を入力します。たとえば、パラメーター名が ID、パラメータータイプが Int、オペレーターが = の場合、サンプルを 5 に設定できます。最大 1,000 文字まで入力できます。
      説明	リクエストパラメーターの簡単な説明を入力します。最大 1,000 文字まで入力できます。
      必須	API を呼び出すためにリクエストパラメーターが必要かどうかを指定します。 [いいえ] を選択: このパラメーターなしで API を呼び出す SQL 文を実行できます。 [はい] を選択: このパラメーターなしで API を呼び出す SQL 文を実行できません。 たとえば、リクエストパラメーターは id で必須、レスポンスパラメーターは name です。次の文を実行すると、異なる結果が得られます: select name from tableA where id=5;: 対応する name フィールドとデータを返します。 select name from tableA;: SQL 文の実行に失敗します。

   3. 左側のリストで 1 つ以上のフィールドを選択します。 アイコンをクリックして、選択したフィールドを右側の [レスポンスパラメーター] リストに追加します。次に、レスポンスパラメーターの基本情報を設定します。

      

      パラメーター	説明
      パラメーター名	ユーザーに返されるパブリックパラメーターの名前。名前は次の要件を満たす必要があります: 文字、数字、およびアンダースコア (_) を含めることができます。 文字で始まる必要があります。 長さは 1～64 文字である必要があります。
      関連付けられた列	API が呼び出されたときにアクセスされる内部パラメーター。
      パラメータータイプ	パラメーターのデータ形式。サポートされているパラメータータイプには、DOUBLE、FLOAT、STRING、DATE(yyyy-MM-dd HH:mm:ss)、BOOLEAN、INT、LONG、SHORT、BYTE、BIGDECIMAL、および BINARY が含まれます。 論理テーブルのフィールドタイプに対応するパラメータータイプを選択します。フィールドタイプがリストにない場合は、String を選択します。
      例	開発者向けの参照を提供するために、レスポンスパラメーターのサンプル値を入力します。最大長は 1,000 文字です。
      説明	レスポンスパラメーターの簡単な説明を入力します。最大長は 1,000 文字です。

2. [送信] をクリックして API を作成します。