すべてのプロダクト
Search

このプロダクト

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

    ドキュメントセンター

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

    最終更新日:Mar 27, 2025

    Alibaba Cloud の IoT Platform を使用すると、ビジネス要件に合わせてカスタマイズされたカスタムサービス API を作成して、データメトリックとカスタムストレージテーブルにアクセスできます。このトピックでは、カスタムサービス API を作成する手順の概要を説明します。

    前提条件

    データソースに関連するメトリックとストレージテーブルがすでに確立されていることを確認します。

    詳細については、「メトリックの概要」および「カスタムストレージテーブル」をご参照ください。

    手順

    1. IoT Platform コンソール で、[概要] をクリックします。[概要] タブで、管理するインスタンスを見つけ、インスタンス [ID] またはインスタンス名をクリックします。

    2. 左側のナビゲーションウィンドウを使用して、[dataservice Studio] > [データ API] に移動します。

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

    4. [API の作成] 構成ウィザードで、[API 基本情報] を入力し、[次へ] をクリックします。

      パラメーター

      説明

      API 名

      API 名を入力します。漢字、英字、数字、アンダースコア（_）、ハイフン（-）を含めることができ、最大 30 文字です。

      API パス

      インスタンス内で API リソースを一意に識別する API パスを指定します。

      API を呼び出すときは、リクエストパラメーターの apiPath をこの値に対応させる必要があります。

      スラッシュ（/）で始まり、英字、数字、アンダースコア（_）、スラッシュ（/）を含めることができ、最大長は 128 文字です。例：pk/temperatureMax。

      重要

      API パスは、API が公開されると変更できません。

      API タグ

      タグの内容を入力し、Enter キーを押してタグを作成します。タグには、漢字、英字、数字、アンダースコア（_）、ハイフン（-）を含めることができ、最大 30 文字です。

      漢字、英字、数字、アンダースコア（_）、ハイフン（-）をサポートし、タグの最大長は 30 文字です。

      タグを使用すると、より柔軟な管理のために API ID をカスタマイズできます。

      重要

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

      API の説明

      API の説明を記述し、その機能とその他の関連情報を詳しく説明します。

      戻り値の型

      API 呼び出し後に返されるデータは JSON 形式です。

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

      カテゴリ

      構成項目

      説明

      データソース

      メトリック

      関連する [メトリックドメイン] と [データセット] を選択します。

      [データセット] は、特定のプロダクトやデバイスなど、メトリックドメイン内のオブジェクトの特定の組織を表します。

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

      ストレージテーブル

      データ解析タスクまたは SQL 解析タスクから生成されるカスタムストレージテーブルを選択します。

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

      構成パラメーター

      データセット

      [メトリック] が選択されている場合、[データソース] が特定の [メトリックドメイン] と [データセット] とともに自動的に表示されます。

      [データのプレビュー] をクリックして、データソースの詳細ページにアクセスします。

      データ範囲

      このオプションは、[データソース] が [メトリック] に設定されている場合にのみ表示されます。

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

      • [派生メトリック]：合計や平均などの集計計算によって元のメトリックから派生したデータ。

      • [派生定義]：サブエンティティに適用される元のメトリック定義の派生物。

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

      リクエストパラメーター

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

      パラメーターには、バインディングフィールド、名前、タイプ、演算子、必須かどうか、値の例、説明を含める必要があります。

      重要

      数値パラメータータイプは、LIKE 演算子をサポートしていません。

      レスポンスパラメーター

      [パラメーターの追加] をクリックして、レスポンスパラメーターを追加します。

      パラメーターには、優先順位、バインディングフィールド、名前、タイプ、ソートの使用法、値の例、説明を含める必要があります。

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

      説明

      • ソートとは、フィールドの値に基づいてクエリ結果を昇順または降順に並べ替えることです。

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

      ソート方法

      パラメーターの順序を決定します。

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

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

      詳細設定

      戻り値のページングを有効にする

      返される結果をページ分割するかどうかを選択します。

      • [無効]：ページ分割なしで最大 100 件の結果を表示できます。

      • [有効]：複数ページにわたるすべての結果を表示します。有効にすると、次の共通パラメーターが自動的に含まれます。

        • pageNum：ページ分割のページ番号。

        • pageSize：1 ページあたりの結果数。最大 100。

      タイムアウトエラー設定

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

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

      リクエストの開始後、[サンプルを返す] タブで返されたサンプルデータを確認するか、[リクエストの詳細] をクリックして詳細なリクエスト情報を表示できます。

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

      重要

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

      • [保存] をクリックして保存された API は、未公開としてマークされます。

      • 不完全な API 構成は、[編集] をクリックして編集し、最終決定後に公開できます。

      • API は、未公開またはオフラインの場合にのみ削除できます。

      [公開に成功しました] ページで、[再作成] をクリックして追加のカスタム API を定義するか、[リストに移動] をクリックして作成した API を確認できます。

    次の手順

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

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