データセットからAPIを有効化 - Cloud

Talend Cloud Data Inventoryユーザーガイド

Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend Data Inventory
Content
データガバナンス
データクオリティとプレパレーション > データの充実化
データクオリティとプレパレーション > データの識別
データクオリティとプレパレーション > データセットの管理
管理と監視 > 接続の管理
Last publication date
2023-11-10
互換性があるデータセットの概要から、含まれているデータにアクセスできるAPIを容易に有効化できます。

始める前に

  • Remote Engine Gen2をお使いの場合は、互換性があるエンジンプロファイルが使用されるよう、sudo ./remote-engine.sh start -r <region> -k <pair key> -p data-apisというコマンド( <region>はuseuapauのいずれか)でエンジンを起動済みであること。
  • Talend Cloud Management Consoleで、[Dataset Administrator] (データセットマネージャー)ロールか[Dataset Manager] (データセットマネージャー)ロール(または少なくとも[View API] (APIを表示)権限および[Manage API] (APIを管理)権限)が自分に割り当てれていること。

手順

  1. データセットのリストから、API経由で使用できるようにしたいデータセットを選択します。
  2. APIの設定を始めるには、データセットの概要から以下のことができます:
    • 左メニューの[API]タブをクリックします。
    • [API]タイルで[Enable] (有効化)をクリックします。
  3. [Get started] (はじめに)をクリックして、API設定フォームに到達します。
  4. 最後のAPI URLを構成する[Entity set name] (エンティティセット名)を入力します。
  5. [Primary key] (プライマリキー)ドロップダウンリストから、ソースデータセットから特定のレコードの選択に使用されるフィールドを選択します。
    データセットの最初のフィールドがデフォルトで選択されています。
  6. [Add] (追加)をクリックして、APIを呼び出せるコンシューマーを定義し始めます。
  7. コンシューマーの[Name] (名前)を入力します。
  8. [Type] (タイプ)ドロップダウンリストで[Authentication] (認証)メソッドを選択します。
    • [Basic] (基本)認証の場合は、コンシューマーが[Username] (ユーザー名)フィールドおよび[Password] (パスワード)フィールドで使う認証情報を定義します。
    • [Api key] (Apiキー)認証の場合は、[Generate API key] (APIキーを生成)をクックして、リクエストヘッダーで使う結果のトークンをコピーします。
  9. [Add] (追加)をクリックします。
    リストにコンシューマーが表示されるようになり、さらに追加できます。
  10. API設定を確定して、自動的に生成されたAPIを開始するには、[Enable] (有効化)をクリックします。

タスクの結果

データセットの2つのタイルが含まれるようになった[API]ビューに戻りました:
  • [Consuming] (利用)タイル: httphttpsかによってコンシューマーと共有するAPIのURL、再利用しやすいよう表現力を高めたリクエスト例、APIのOAS3定義を取得するためのダウンロードボタンが用意されています。また、[Open in API Tester] (API Testerで開く)ボタンを使えば、事前設定済みのAPIコールをTalend API Testerででテストすることもできます。
  • [Monitoring] (監視)タイル: 過去24時間のAPIアクティビティおよび呼び出しの成否を監視できます。

[Enable API] (APIを有効化)スイッチを使えば状況に応じてAPIを有効化と無効化をすばやくを切り替えられます。また、[Edit] (編集)をクリックすれば設定フォームに戻ることができます。

データセットの概要の[API]タイルには、APIステータスとアクティビティの概要も見つかります。

重要: 以下のような場合、既知の問題のため、共有されているデータセットからAPIを有効にできないことがあります。
  • データセットがユーザーグループと共有されている。この場合は、他の個々のユーザーとデータセットを共有するようにしてください。
  • データセットまたは対応する接続を最後に変更したユーザーが、そのデータセットに対する権限を失っている。この場合は、そのユーザーと再共有してみるか、Talendのサポート担当者に連絡してデータセットをアップデートしてもらってください。