REST API

Data Catalog は、このマニュアルで説明するすべてのタスクをプログラムで実行するためのステートレス REST API を備えています。

REST API に関するドキュメントは http://<host>:<port>/denodo-data-catalog/swagger-ui.html にあります。

注釈

Data Catalog 7.0 は以下のタスクを実行するための REST API を備えています。

  • Virtual DataPort との同期

  • 使用状況統計の計算

  • メタデータのエクスポート

  • メタデータのインポート

  • Ping

Data Catalog 7.0 の REST API は後方互換性が維持されていますが、非推奨です。Data Catalog 8.0 の REST API への移行を検討することをお勧めします。

Data Catalog 7.0 の REST API に関するドキュメント上の記述は、見出しが legacy- から始まります。

認証

REST API のエンドポイントの大半は認証を要求するため、リクエストごとに資格情報を提供する必要があります。REST API は HTTP Basic 認証 方式をサポートします。以下の手順に従って、資格情報を提供してください。

  1. ユーザー ID とパスワードをコロン (:) でつないで、ユーザーパスを作成します。

  2. Base64 でユーザーパスをエンコードし、US-ASCII の文字列にします。

  3. Authorization という名称のヘッダーを作成し、値に Basic <BASE64-user-pass> を指定します。

次の例は Data Catalog の新しいホームページから情報を取得する例で、ユーザー名 admin とパスワード admin を使用して認証を行っています。

curl --location --request GET 'http://localhost:9090/denodo-data-catalog/public/api/home' --header 'Authorization: Basic YWRtaW46YWRtaW4='

Data Catalog に複数の Virtual DataPort サーバーを登録している場合、接続するサーバーを指定する必要があります。これには、クエリパラメータ serverId を使用し、サーバーの内部 ID を値として指定します。

注釈

次の REST API のエンドポイントから、Data Catalog に登録された Virtual DataPort サーバーの内部 ID を取得できます。 /public/api/configuration/servers

CORS の構成

クロスサイト環境から Data Catalog の REST API にアクセスするには、Denodo Platform を以下のように構成する必要があります。

  1. CORS の初期設定 」の手順に従って設定を行います (CORS が有効な状態で Denodo REST Web サービスを公開している場合は、実施済みです)。

  2. Denodo インストール環境で何らかのサーバーを起動する前に、 <DENODO_HOME>/resources/apache-tomcat/conf/context.xml ファイルを開いて、 SameSite Cookie のデフォルトポリシーを次の値に変更します。

    <CookieProcessor sameSiteCookies="none" />