すべてのプロダクト
Search

このプロダクト

    Dataphin:API データソースの作成

    ドキュメントセンター

    Dataphin:API データソースの作成

    最終更新日:Aug 14, 2025

    API データソースを作成することで、Dataphin が API からビジネスデータを取得したり、API にデータを書き込んだりできるようになります。このトピックでは、API データソースを作成する方法について説明します。

    権限要件

    データソースを作成できるのは、カスタムグローバルロールで[データソースの作成]権限ポイントを持つユーザー、または[スーパー管理者]、[データソース管理者]、[ドメインアーキテクト]、または[プロジェクト管理者]のシステムロールを持つユーザーのみです。

    手順

    1. Dataphin ホームページで、上部のナビゲーションバーの[管理ハブ] > [データソース管理] をクリックします。

    2. [データソース] ページで、[+データソースの作成] をクリックします。

    3. [データソースの作成] ページで、[API] セクションの[半構造化ストレージ] を選択します。

      最近 API を使用したことがある場合は、[最近使用したデータソース] セクションで API を選択することもできます。検索ボックスにキーワードを入力して API をすばやく検索することもできます。

    4. [API データソースの作成] ページで、接続パラメータを設定します。

      1. データソースの基本情報を設定します。

        パラメータ

        説明

        データソース名

        名前は次の要件を満たしている必要があります。

        • 漢字、英字、数字、アンダースコア (_)、およびハイフン (-) のみを含めることができます。

        • 長さは 64 文字を超えることはできません。

        データソースコード

        データソースコードを設定した後、Flink_SQL ノードでデータソースコード.テーブル名またはデータソースコード.スキーマ.テーブル名形式を使用して、データソース内のテーブルを参照できます。現在の環境に基づいて対応する環境のデータソースに自動的にアクセスするには、変数形式${data source code}.tableまたは${data source code}.schema.tableを使用します。詳細については、「Dataphin データソーステーブルの開発方法」をご参照ください。

        重要

        • データソースコードは、正常に設定された後は変更できません。

        • データソースコードが正常に設定されると、アセットディレクトリとアセットインベントリのオブジェクト詳細ページでデータをプレビューできます。

        • Flink SQL では、現在、MySQL、Hologres、MaxCompute、Oracle、StarRocks、Hive、および SelectDB データソースのみがサポートされています。

        データソースの説明

        データソースの簡単な説明。長さは 128 文字を超えることはできません。

        データソース設定

        設定するデータソースを選択します。

        • ビジネスデータソースが本番データソースと開発データソースを区別する場合、[本番 + 開発データソース] を選択します。

        • ビジネスデータソースが本番データソースと開発データソースを区別しない場合、[本番データソース] を選択します。

        タグ

        タグを追加することで、データソースを分類できます。タグの作成方法については、「データソースタグの管理」をご参照ください。

      2. データソースと Dataphin 間の接続パラメータを設定します。

        説明

        ほとんどの場合、本番データソースと開発データソースは、環境の隔離を実現し、開発データソースが本番データソースに与える影響を軽減するために、異なるデータソースとして設定する必要があります。ただし、Dataphin では、同じパラメータ値を持つ同じデータソースとして設定することもサポートされています。

        パラメータ

        説明

        URL アドレス

        API リクエストの URL アドレスを入力します。

        認証タイプ

        API の要件に基づいて認証方式を選択します。

        • Basic 認証

          • ユーザー名: API のユーザー名を入力します。

          • パスワード: API のパスワードを入力します。

        • Alibaba Cloud AppKey 認証

          • AppKey: API の AppKey を入力します。

          • AppSecret: API の AppSecret を入力します。

        • なし: API の認証は不要です。

        • API キー

          • キー: API キー認証方式のキーを入力します。

          • 値: API キー認証方式の値を入力します。

          • 追加先: API キーを API リクエスト本文パラメータのいずれかに追加します。パラメータ、ヘッダー、または本文。

        • Bearer トークン: トークン情報を入力します。この情報は、リクエストを行う際にAuthorization: Bearer <token>の形式で API ヘッダーに追加されます。

        • OAuth 2.0: [トークンプレフィックス]、[アクセストークン] を入力し、以下の[アクセストークン取得設定] を設定します。

          • トークンプレフィックス (オプション): トークンプレフィックスを入力します。デフォルトはBearerです。このフィールドは空のままにすることができます。

          • アクセストークン: アクセストークン取得設定からの応答におけるアクセストークンの JSON パスを入力します。data.access_tokenなどの複数レベルのパスがサポートされています。

        アクセストークン取得設定

        説明

        このセクションは、認証方式が[OAuth2.0]に設定されている場合にのみ設定可能です。

        • リクエストメソッド: [POST] または[GET] を選択できます。デフォルトは GET です。

        • トークン URL: トークンのリクエストアドレスをhttps://example.com/oauth/tokenの形式で入力します。

        • クライアント ID: クライアント ID を入力します。

        • クライアントシークレット: クライアントシークレットを入力します。

        • クライアント認証: [リクエストヘッダーに Basic 認証情報を送信] または[リクエスト本文にクライアント資格情報を送信] を選択できます。デフォルトでは、リクエストヘッダーに Basic 認証情報が送信されます。

          • リクエストヘッダーに Basic 認証情報を送信: HTTP リクエストのAuthorizationヘッダーフィールドを介して Basic 認証情報を直接送信します。Basic 認証の基本形式はAuthorization: Basic <credentials>で、<credentials>は Base64 エンコードされたユーザー名とパスワードです。

          • リクエスト本文にクライアント資格情報を送信: リクエスト本文にクライアント認証情報を送信します。キーと値のペアはclient_id, client_secretの形式です。

        詳細設定

        説明

        このセクションは、認証方式が OAuth 2.0 に設定されている場合にのみ設定可能です。

        リクエストパラメータ: トークンをリクエストするために必要な追加パラメータを複数入力できます。このフィールドはデフォルトでは空です。ここに入力したパラメータが認証方式によって自動的に追加されたパラメータと競合する場合、ここに入力したパラメータが優先されます。

        • パラメータ名: 英字、数字、アンダースコア (_)、およびハイフン (-) のみサポートされています。名前は 256 文字を超えることはできません。

        • 追加先: [パラメーター]、[ヘッダー]、または[ボディ]を選択できます。デフォルトはパラメーターです。リクエストメソッドが POST の場合にのみ、[ボディ] を選択できます。

        接続テスト: [接続テスト] をクリックすると、システムはトークン URL、クライアント ID、クライアントシークレット、およびクライアント認証を自動的に検証します。接続テストが完了したら、[クエリ結果の展開] をクリックして、フォーマットされた JSON を表示できます。

      3. 詳細設定

        接続再試行: API への接続に失敗した場合、システムは指定された再試行回数に達するまで接続を自動的に再試行します。指定された再試行回数後に接続がまだ失敗する場合は、接続は失敗したとみなされます。

    5. [OK] をクリックして、API データソースの作成を完了します。