すべてのプロダクト
Search

このプロダクト

    Dataphin:API 入力コンポーネントの構成

    ドキュメントセンター

    Dataphin:API 入力コンポーネントの構成

    最終更新日:Nov 19, 2025

    API入力コンポーネントを設定すると、データ統合とデータ開発のために API データソースから Dataphin にデータを読み取ることができます。このトピックでは、API入力コンポーネントを設定する方法について説明します。

    前提条件

    • API データソースが作成されていること。詳細については、「API データソースを作成する」をご参照ください。

    • API入力コンポーネントのプロパティを設定するために使用するアカウントが、データソースに対するリードスルー権限を持っていること。権限がない場合は、データソースに対する権限を申請する必要があります。詳細については、「データソースに対する権限を申請する」をご参照ください。

    手順

    1. Dataphin ホームページの上部ナビゲーションバーで、[開発] > [Data Integration] を選択します。

    2. [統合] ページの上部ナビゲーションバーで、プロジェクトを選択します（開発-本番モードでは、環境を選択する必要があります）。

    3. 左側のナビゲーションウィンドウで、[バッチパイプライン] をクリックします。 [バッチパイプライン] リストで、開発するオフラインパイプラインをクリックして、オフラインパイプラインの構成ページを開きます。

    4. ページの右上隅にある [コンポーネントライブラリ] をクリックして、[コンポーネントライブラリ] パネルを開きます。

    5. [コンポーネントライブラリ] パネルの左側のナビゲーションウィンドウで、[入力] を選択します。 右側の入力コンポーネントリストで [API] コンポーネントを見つけ、キャンバスにドラッグします。

    6. API入力コンポーネントカードの image アイコンをクリックして、[API] [入力設定] ダイアログボックスを開きます。

    7. [API 入力設定] ダイアログボックスで、パラメーターを設定します。

      パラメーター

      説明

      ステップ名

      API入力コンポーネントの名前。Dataphin は自動的にステップ名を生成します。ビジネスシナリオに基づいて名前を変更することもできます。名前は次の要件を満たしている必要があります。

      • 名前に使用できるのは、漢字、英字、アンダースコア (_)、数字のみです。

      • 名前は最大 64 文字まで入力できます。

      データソース

      データソースのドロップダウンリストには、現在の Dataphin インスタンスにあるすべての API データソースが表示されます。これには、リードスルー権限を持っているデータソースと、リードスルー権限を持っていないデータソースの両方が含まれます。

      • リードスルー権限を持っていないデータソースの場合、データソースの横にある [リクエスト] をクリックして、データソースに対するリードスルー権限を申請できます。詳細については、「データソースに対する権限を申請する」をご参照ください。

      • API データソースがない場合は、[作成] をクリックしてデータソースを作成します。詳細については、「API データソースを作成する」をご参照ください。

      リクエストメソッド

      POST リクエストと GET リクエストがサポートされています。デフォルトでは GET が選択されています。

      • POST: [パラメーター]、[ヘッダー]、[本文] を設定できます。これらのパラメーターは空にすることができます。

      • GET: [パラメーター] と [ヘッダー] を設定できます。これらのパラメーターは空にすることができます。

      URL パス

      オプション。URL にパスを入力します。ここに入力したパスパラメーターは、データソースで設定された URL と連結されて、リクエスト URL が形成されます。たとえば、データソースで設定された URL が https://www.aliyun.com で、入力した URL パスが /home の場合、リクエスト URL は https://www.aliyun.com/home になります。

      読み取る JSON パス (オプション)

      JSON パスを入力すると、パスに基づいてデータが読み取られます (例: data.result)。JSON パスを入力しない場合は、返されたデータが読み取られます。

      リクエスト数

      [単一リクエスト] と [複数リクエスト] に対応しています。

      • 単一リクエスト: 1 つのリクエストのみが送信されます。

      • 複数リクエスト: 指定されたループパラメーターに基づいて複数のリクエストが送信されます。複数リクエストを選択した場合は、次のパラメーターを設定する必要があります。

        ループモード: [ページネーションループ] または [パラメータ走査ループ] を選択できます。

        ページネーションループ

        • ページネーションメソッド: [ページ番号/オフセット] または [カーソル] を選択できます。

        • リクエストパラメーター: ループリクエストのパラメーターを設定します。[パラメーター] または [本文] から選択するか、手動で入力できます (本文の形式が JSON の場合のみサポートされます)。リクエスト本文の形式が JSON の場合に適用可能な、a.b.c などの JSON パス形式がサポートされています。

        • パラメーター値のソース (ページネーションメソッドがカーソルの場合のみ設定可能): パラメーター値のソースは戻りパラメーターである必要があります。リクエスト更新値を入力できます。JSON パスがサポートされています。

        • 開始値 (オプション):

          • ページネーションメソッドがページ番号/オフセットの場合: リクエストの開始値を入力します。デフォルト値は 1 です。

          • ページネーションメソッドがカーソルの場合: リクエストの開始値を入力します。デフォルト値は 0 です。

        • ステップサイズ (オプション、ページネーションメソッドがページ番号/オフセットの場合のみ設定可能): ループリクエストのステップサイズを入力します。デフォルト値は 1 です。

        • 終了条件: 終了条件が満たされるとループが停止します。

          • 左の条件: パラメーターソースとパラメーター値を設定します。

            • パラメーターソース: [リクエストパラメーター]、[戻りパラメーター]、または [リクエスト数] を選択できます。デフォルト値は戻りパラメーターです。

            • パラメーター値: JSON パスをサポートしています。パラメーターソースがリクエストパラメーターの場合は、演算子と右の条件を設定する必要はありません。

          • 演算子: [空]、[空ではない]、=、≠、＞、≥、＜、または ≤ を選択できます。空 または 空ではない を選択した場合は、右の条件を設定する必要はありません。

          • 右の条件: パラメーターソースとパラメーター値を設定します。

            • パラメーターソース: [リクエストパラメーター]、[戻りパラメーター]、または [定数] を選択できます。デフォルト値は定数です。

            • パラメーター値: JSON パスをサポートしています。

        パラメータ走査ループ

        • リクエストパラメーター: ループリクエストのパラメーターを設定します。[パラメーター] または [本文] から選択するか、手動で入力できます (本文の形式が JSON の場合のみサポートされます)。リクエスト本文の形式が JSON の場合に適用可能な、a.b.c などの JSON パス形式がサポートされています。

        • 取得方法:

          • [手動入力]: パラメーター値リスト領域に、ループリストを入力します。改行を使用して値を区切ることができます。

          • [API 取得]: 現在、認証なしの API のみがサポートされています。

            • URL: パラメーターリストのリクエストアドレスを設定します。リクエストメソッドは [POST] または [GET] にすることができます。デフォルト値は GET です。

            • リクエストパラメーター: リクエストの追加パラメーターを設定します。デフォルト値は空です。[作成] をクリックして行を追加し、パラメーター名、パラメーター値、および追加先を設定します。

              • パラメーター名 と パラメーター値: すべての文字がサポートされています。

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

            • 出力値: 出力値を入力します。data.list などの JSON パスがサポートされています。

        • 終了条件: 選択したすべてのパラメーター値が走査されると、ループが終了します。

      リクエストパラメーター

      リクエストパラメーターには、[パラメーター]、[ヘッダー]、[本文] (リクエストメソッドが POST の場合のみサポート)、および [署名] が含まれます。

      パラメーター、ヘッダー、本文

      • パラメーター名: 漢字、英字、特殊文字がサポートされています。

      • パラメータータイプ: [定数]、[タイムスタンプ]、または [乱数] を選択できます。

      • パラメーター値: パラメータータイプとして 定数 を選択した場合、パラメーター値には漢字、英字、特殊文字を含めることができます。パラメータータイプとして タイムスタンプ を選択した場合、パラメーター値は自動生成のみ可能です。パラメータータイプとして 乱数 を選択した場合、パラメーター値は 16 ビット、32 ビット、64 ビット、または 128 ビットの乱数として自動生成できます。

      • データ型: 本文 でのみ、データ型を設定できます。[文字列]、[Long]、[JSON]、[Double]、[ブール値]、または [日付] を選択できます。デフォルト値は文字列です。

      • アクション:

        • 作成: [+作成] をクリックしてパラメーターの行を追加します。image アイコンをクリックしてこのパラメーターを保存してから、別のパラメーターを作成できます。image アイコンをクリックしてパラメーターの設定をキャンセルします。

        • 編集: 設定済みパラメーターの [アクション]image 列にある アイコンをクリックして、パラメーターの設定を編集します。

        • シフト: 設定済みパラメーターの [アクション]image 列にある アイコンをクリックして、パラメーターを現在のリスト以外のリストに移動します。たとえば、現在のパラメーターがパラメーターリストにある場合は、ヘッダーリストまたは本文リストに移動できます。同じ名前のパラメーターがターゲットリストに既に存在する場合は、パラメーターを移動できません。ターゲットリストが本文で、本文の入力メソッドが JSON の場合は、パラメーターを移動できません。

        • 削除: 設定済みパラメーターの [アクション]image 列にある アイコンをクリックして、パラメーターを削除します。パラメーターが署名設定によって参照されている場合は、削除できません。

      本文 の入力形式は、[JSON] または [キーと値] にすることができます。

      • JSON: JSON コード編集領域に、対応する JSON コードを入力する必要があります。image アイコンをクリックすると、入力されたコードが自動的にフォーマット (整形) されます。

      • キーと値: [作成] をクリックし、パラメーター名とパラメーター値を入力して、現在のパラメーターのパラメータータイプとデータ型を選択します。

      署名

      署名はデフォルトで無効になっています。署名を有効にした後、署名を生成するためのルールを設定する必要があります。

      • 署名名: カプセル化されたリクエストパラメーターのキー値。

      • 署名の場所: [パラメーター]、[ヘッダー]、または [本文] (リクエストメソッドが POST の場合のみサポート) を選択できます。

      • 生成関数: MD5HEX、HMAC-MD5、SHA1HEX、HMAC-SHA256、HMAC-SHA1、SHA256、SHA256HEX、SHA512HEX、またはHMAC_SHA512 を選択します。

      • キー: 管理 > データセキュリティ > キー管理 からキーを選択するか、手動でキーを入力できます。

        現在の Dataphin インスタンスがデータ資産セキュリティの付加価値モジュールを購入していない場合は、手動入力のみがサポートされます。現在の Dataphin インスタンスがデータ資産セキュリティの付加価値モジュールを購入している場合は、管理 > データセキュリティ > キー管理 からキーを選択することのみ可能です。ドロップダウンリストにキーがない場合は、[登録に移動] をクリックして 管理 > データセキュリティ > キー管理 に移動し、キーを登録できます。

        説明

        このパラメーターは、生成関数を MD5HEX、SHA1HEX、SHA256、SHA256HEX、または SHA512HEX に設定した場合はオプションです。

      • 連結内容: パラメーター値のみ、パラメーター名 + パラメーター値、またはカスタムを選択します。 デフォルト値はパラメーター名 + パラメーター値です。

        パラメーター値のみ、パラメーター名 + パラメーター値

        • 参照パラメーター: パラメーターリストから複数のキー値 (KV) パラメーターを選択します。

        • 連結順序: 辞書順または選択順を選択します。 デフォルト値は辞書順です。

        • コネクタ (オプション): パラメーター区切り文字またはキー値コネクタを構成します。

          • パラメーター区切り文字: カスタムパラメーター区切り文字を入力します。 デフォルト値は & です。

          • キー値コネクタ: カスタムキー値コネクタを入力します。 デフォルト値は = です。 連結内容がパラメーター値のみに設定されている場合、キー値コネクタは構成できません。

        • 連結例: 前述の設定に基づいて、連結された文字列が表示されます。パラメーターでタイムスタンプまたは乱数が使用されている場合は、一時的に生成された値がここに表示されます。

        カスタム

        署名文字列: カスタム署名文字列を入力します。 @ 記号を入力して、パラメーターの候補をトリガーします。 連結内容をパラメーター値のみまたはパラメーター名 + パラメーター値からカスタムに切り替え、参照パラメーターが含まれている場合、システムは連結順序とコネクタに基づいてそれらを連結し、署名文字列に入力します。

        署名文字列には、キー、Params、Header、または Body のパラメーター、および定数を含めることができます。 [キー] を選択すると、#{secret} が署名文字列に追加されます。 [すべての Params]、[すべての Header]、または[すべての Body] を選択すると、システムは対応するリストからすべてのパラメーターを署名文字列に追加し、各パラメーターは K:V 形式で新しい行に追加されます。 たとえば、パラメーター名が id の場合、id:#{id} が署名文字列に追加されます。 Body が JSON 形式の場合、JSON オブジェクト全体がシステムに渡され、#{body_json} プレースホルダーが署名文字列に追加されます。

      出力フィールド

      出力フィールドが表示されます。出力フィールドを手動で追加できます。

      • 出力フィールドを一括追加する。

        • 形式: [一括追加] をクリックします。[JSON] 形式または [TEXT] 形式で出力フィールドを一括設定できます。

          • JSON 形式:

            // 例:
[{
  "index": "0",
  "name": "user_id",
  "type": "String"
 },
 {
  "index": "1",
  "name": "user_name",
  "type": "String"
 }]
            説明

            index は指定されたオブジェクトの列番号を示し、name はインポート後のフィールド名を示し、type はインポート後のフィールドタイプを示します。たとえば、"index":3,"name":"user_id","type":"String" は、ファイルの 4 番目の列がインポートされ、フィールド名が user_id で、フィールドタイプが String であることを示します。

          • TEXT 形式:

            // 例:
0,user_id,String
1,user_name,String

        • 行区切り文字 と 列区切り文字: 一括追加の形式が TEXT の場合、行区切り文字と列区切り文字を設定できます。行区切り文字は、各フィールドの情報を区切るために使用されます。デフォルト値は改行 \n です。サポートされている値は \n ; . です。列区切り文字は、フィールド名とフィールドタイプを区切るために使用されます。デフォルト値はカンマ (,) です。

      • 単一の出力フィールドを作成する。

        [出力フィールドを作成] をクリックし、ページのプロンプトに従って、ソースインデックスとフィールドに入力し、タイプを選択します。image アイコンをクリックして現在の行を保存し、image アイコンをクリックして現在の行を削除します。

      • 出力フィールドを管理する。

        追加されたフィールドに対して、次の操作を実行できます。

        • [操作] agag 列の アイコンをクリックして、既存のフィールドを編集します。

        • [操作] agfag 列の アイコンをクリックして、既存のフィールドを削除します。

    8. [確認] をクリックして、API 入力コンポーネントのプロパティ設定を完了します。