すべてのプロダクト
Search

このプロダクト

    IoT Platform:カスタムサービス API

    ドキュメントセンター

    IoT Platform:カスタムサービス API

    最終更新日:Jun 21, 2026

    プリセットのメトリクス API や製品データ API に加えて、カスタムサービス API を作成し、カスタムストレージテーブルからメトリクスとデータを取得できます。

    前提条件

    データソースのメトリクスとストレージテーブルが作成されている必要があります。詳細については、「メトリクスの概要」および「カスタムストレージテーブル」をご参照ください。

    操作手順

    1. IoT Platform コンソールで、[概要] ページに移動し、対象の Enterprise Edition インスタンスの [ID] またはエイリアスをクリックします。

    2. 左側のナビゲーションペインで、[データサービス > データ API] を選択します。

    3. [データ API] ページで、[カスタムサービス API] タブをクリックし、[API の作成] をクリックします。

    4. [API の作成] ウィザードで、[API の基本情報] セクションのパラメーターを設定し、[次へ] をクリックします。

      パラメーター

      説明

      API 名

      API の名前を入力します。名前に使用できる文字は、漢字、英字、数字、アンダースコア (_)、ハイフン (-) で、長さは最大 30 文字です。

      API パス

      API パスを入力します。これは、インスタンス内の一意なリソース識別子です。

      API を呼び出す際、リクエストパラメーター apiPath の値は、このパスと一致する必要があります。

      パスはスラッシュ (/) で始まり、英字、数字、アンダースコア (_)、スラッシュ (/) を使用できます。パスの長さは最大 128 文字です。例： /pk/temperatureMax

      重要

      API の公開後は、API パスを変更できません。

      API タグ

      タグの内容を入力し、Enter キーを押します。

      タグに使用できる文字は、漢字、英字、数字、アンダースコア (_)、ハイフン (-) で、長さは最大 30 文字です。

      API を管理しやすくするために、カスタム識別子としてタグを使用します。

      重要

      API には最大 5 つのタグを追加できます。

      API の説明

      API の目的や機能など、API の説明を入力します。

      レスポンス形式

      レスポンス データ形式は JSON に固定されています。

    5. [パラメーターの設定とテスト] ページで、以下のパラメーターを設定します。

      カテゴリ

      パラメーター

      説明

      データソース

      メトリクス

      特定の [メトリクス フィールド] と [データ セット] を選択します。

      [データ セット] とは、メトリクス フィールド内のオブジェクトの特定の集まりであり、たとえば製品フィールド内の特定の製品やデバイス フィールド内の特定のデバイスなどを指します。

      メトリクスの詳細については、「メトリクスとは」をご参照ください。

      ストレージテーブル

      データパースまたは SQL 分析タスクによって生成されたカスタムストレージテーブルを選択します。

      詳細については、「コールドストレージテーブル」をご参照ください。

      パラメーターの設定

      データセット

      この設定は、[データソース] として [メトリクス] を選択し、[メトリクス フィールド] と [データ セット] を指定した場合にのみ表示されます。

      [データのプレビュー] をクリックすると、選択したデータソースの詳細ページに移動します。

      データ範囲

      この設定は、[データソース] として [メトリクス] を選択した場合にのみ表示されます。

      API のデータ範囲を選択します：

      • [派生メトリクス]：合計や平均などの集計計算によって、生メトリクス、元の定義、派生定義から取得されるデータ。

      • [派生定義]：元の定義から派生し、サブエンティティに適用されるメトリクス。

      派生メトリクスと派生定義の詳細については、「メトリクスのタイプ」をご参照ください。

      リクエストパラメーター

      [パラメーターの追加] をクリックして、選択したデータソースのメトリクスを API のリクエストパラメーターとして追加します。データソースがカスタムストレージテーブルの場合、システムフィールドとプライマリキーフィールドのみがサポートされます。

      各パラメーターについて、バインド フィールド、名前、タイプ、演算子、必須かどうか、値の例、および説明を設定する必要があります。

      重要

      パラメーター タイプが数値の場合、 LIKE 演算子はサポートされません。

      レスポンスパラメーター

      [パラメーターの追加] をクリックして、選択したデータソースのメトリクスを API のレスポンス パラメーターとして追加します。

      各パラメーターについて、優先度、バインド フィールド、名前、タイプ、ソートに使用するかどうか、値の例、および説明を設定する必要があります。

      右側の [すべてのパラメーターを選択] チェックボックスをオンにすると、すべてのテーブル フィールドが API レスポンスに含まれます。

      説明

      • このフィールドを使用して、結果を昇順または降順にソートします。

      • 各メトリクスは、1 つのレスポンス パラメーターとしてのみ設定できます。

      ソート順

      パラメーターをソートする順序を選択します。

      • [昇順] (デフォルト)：パラメーターは昇順にソートされます。

      • [降順]：パラメーターは降順にソートされます。

      詳細設定

      ページネーション レスポンスの有効化

      レスポンスのページネーションを有効にするかどうかを指定します。

      • [無効]：最大 100 件の結果を返します。

      • [有効]：すべての結果をページ単位で返します。この機能を有効にすると、次の共通パラメーターが自動的に追加されます：

        • pageNum： ページ番号。

        • pageSize： ページサイズ。最大値は 100 です。

      タイムアウト エラー設定

      API 呼び出しが 8 秒を超えると、タイムアウト エラーが返されます。この設定は変更できません。

      これらの設定が完了したら、[API のテスト] セクションでリクエストパラメーターのテスト値を入力し、[テストの開始] をクリックします。

      [レスポンス例] タブでサンプルデータを表示するか、[リクエスト詳細] をクリックして特定のリクエスト情報を確認できます。テストが成功すると、[レスポンス例] タブに errCode:0 や errMsg:"success" などのフィールドを含む JSON レスポンスが表示されます。下部には、「Test succeeded」 メッセージと API 呼び出しの所要時間が表示されます。

    6. [公開] をクリックします。

      重要

      • API を公開する前に、テストが成功することを確認してください。

      • [保存] のみをクリックした場合、API はオフラインの状態で保存されます。

      • 設定が不完全な API は、[編集] をクリックして設定を完了してから公開できます。

      • オフラインの API のみ削除できます。

      [正常に公開されました] ページで、[別の API を作成] をクリックしてさらにカスタム API を作成するか、[リストで表示] をクリックしてリスト内の API を表示します。

    次のステップ

    カスタムサービス API を作成した後、API を呼び出してデータを取得できます。詳細については、「API の管理と使用」をご参照ください。

    API 呼び出しの例については、以下を参照してください。