このトピックでは、定義済みメトリック API、製品データ API、およびカスタム サービス API の管理と使用の概要について説明します。
前提条件
定義済みメトリック API を管理および使用するには、製品とデバイスが作成され、バックアップが完了していることを確認してください。
詳細については、「データアクセス」をご参照ください。
製品データ API またはカスタム サービス API の場合は、対応する API が作成されていることを確認してください。詳細については、「製品データ API」および「カスタム サービス API」をご参照ください。
API の管理
IoT Platform コンソール で、[概要] をクリックします。[概要] タブで、管理するインスタンスを見つけ、インスタンス [ID] またはインスタンス名をクリックします。
左側のナビゲーションウィンドウを使用して、[dataservice Studio > データ API] に移動します。
[データ API] ページに移動し、[定義済みメトリック API]、[製品データ API]、または [カスタム サービス API] タブを選択し、目的の API を見つけて、[操作] 列の [表示] をクリックします。
[API の詳細] ページの右上で、バージョン番号を選択して、基本情報、API モニタリング、パラメーターなど、そのバージョンの詳細を表示します。
[API 操作] をクリックして、API の使用方法を確認します。
[API テスト] をクリックして、API をテストし、リクエストの詳細、戻り値の例、および呼び出しの例を表示します。
API の使用
API の詳細が手元にあれば、サーバー上で対応する API を統合および呼び出して関連データを取得し、データ資産の使用を最大化できます。
単一の Alibaba Cloud アカウントでデータ サービス API を呼び出す場合の 1 秒あたりの最大リクエスト数 (QPS) は 100 であることに注意してください。
ListAnalyticsData を呼び出して、ビジネス要件に従って指定された API からデータを取得します。
Alibaba Cloud が提供する SDK を使用している場合は、開発言語に基づいて次の例を参照してください。
Alibaba Cloud SDK を使用していない場合は、開発中に次の一般的なパラメーターに注意してください。
名前
タイプ
必須
値の例
説明
apiPath
文字列
はい
pk/temperatureMax
API のエンドポイントパス。
iotInstanceId
文字列
はい
iot-cn-npk1u******
トピックが関連付けられている IoT Platform インスタンスの一意の識別子。詳細については、「IoT Platform インスタンス関連の問題」をご参照ください。
pageNum
整数
いいえ (条件付き)
10
ページ分割された結果のページ番号。
pageSize
整数
いいえ (条件付き)
100
ページあたりのレコード数を指定します。最大 100 です。
API の詳細ページで、API の戻りパラメーターを確認できます。以下は、一般的な戻りパラメーターです。
名前
タイプ
値の例
説明
Count
Long
3
返されたエントリの総数を示します。
HasNext
ブール値
false
後続のデータページが利用可能かどうかを指定します。
true: 次のページがあります。
false: これ以上ページはありません。
PageNum
整数
1
現在のページ番号。
PageSize
整数
100
ページごとに表示されるエントリの数。
ResultJson
文字列
[{"testCode":"TBB186","testLevel":5,"testWorkYears":3,"testName":"Jack"},{"testCode":"TBB1314","testLevel":2,"testWorkYears":4,"testName":"Tom"},{"testCode":"TBB8888","testLevel":2,"testWorkYears":5,"testName":"Eric"}]
返されたデータの詳細を含む JSON 文字列。