概要
クエリ API は、イベント、系列、集計用にそれぞれ 1 つの API の 3 つの REST API で構成されます。
クエリ API は、オプションのページネーションを使用して、HTTP GET リクエストを介して、指定された時間範囲のイベント スキーマとイベント数を返します。 系列 および 集計系列 の情報は、オプションのページネーションを使用した GET 操作によっても公開されます。
| API | 説明 |
|---|---|
| イベント API の取得 | 検索範囲と述語に一致する生イベントのリストを返します。 |
| シリーズ API の取得 | モデルで定義されている変数またはインラインで提供された変数を介してネットワークに記録されたデータを使用して、キャプチャされたイベントからの Time Series Insights データのクエリと取得を可能にします。 |
| 集計系列 API | 集計関数またはサンプル関数を使用して記録されたデータを集計することで、キャプチャされたイベントからの Time Series Insights データのクエリと取得を有効にします。 |
API は、HTTP リクエスト JSON 本文で指定された さまざまなカスタマイズされた操作 もサポートします。 クエリ定義 は、一般的な操作に使用できます。
Von Bedeutung
- JSON のフラット化とエスケープ規則に関する今後の変更の一環として、配列は Dynamic 型として格納されます。 Get Events APIを介してのみ
アクセス可能な、この型として格納されるペイロードプロパティ。
エラー応答
クエリの実行が失敗した場合、JSON 応答ペイロードには、次の構造に準拠するエラー応答が含まれます。
{
"error" : {
"code" : "...",
"message" : "...",
"innerError" : {
"code" : "...",
"message" : "...",
}
}
}
ここでは、 innerError はオプションです。 不正な形式の要求などの基本的なエラーに加えて、次のエラーが返されます。
| Http 状態コード | エラー コード | エラーメッセージの例 | 考えられる innerError コード |
|---|---|---|---|
| 400 | 無効なAPIバージョン | API バージョン '2016' はサポートされていません。 サポートされているバージョンは、'2016-12-12'、'2018-11-01-preview' です。 | - |
| 400 | InvalidUrl | リクエスト URL '/a/b' を解析できませんでした。 | - |
| 400 | 無効な入力 | 指定されたクエリ 'aggregate' は無効です。 サポートされているクエリは、'getEvents'、'getSeries'、'aggregateSeries' です。 | InvalidQueryType (無効なクエリタイプ) |
| 400 | 無効な入力 | 'projectedVariables.temperature.value' の '$event.temperature.Double > 0' 時系列式は、有効なプロパティ参照式ではありません。 | 無効なプロパティ参照式 |
| 400 | 無効な入力 | 'projectedVariables.temperature.filter' の '$event.temperature.Double' 時系列式が無効です。 これは、ブール値を返す述語式のみにすることができます。 | InvalidPredicateExpression (無効述語式) |
| 400 | 無効な入力 | 'projectedVariables.temperature.aggregation' の '$event.temperature.Double' 時系列式は無効です。 集計式は含まれていませんでした。 | 無効な集計式 |
| 400 | 無効な入力 | 'projectedVariables.temperature.value' の '$event.temperature.Double > 0' 時系列式は、'numeric' 型の有効な値式ではありません。 | 無効値式 |
| 400 | 無効な入力 | 'projectedVariables.temperature.value' の値時系列式は指定しないでください。または、種類の変数 'aggregate' に対して null にする必要があります。 | 値式ShouldNotBe 指定 |
| 400 | 無効な入力 | 'projectedVariables.temperature.value' の値時系列式は、変数の種類 'numeric' に指定する必要があります。 | 値式指定すべき |
| 400 | 無効な入力 | 変数の種類 'aggregate' は、'projectedVariables.temperature.aggregation' の式 'min($value)' に対して無効です。 | 無効な変数の種類 |
| 400 | 無効な入力 | 'interval' のタイムスパン '00.00:01' は、有効なISO8601タイムスパン形式ではありません。 | InvalidTimeSpanFormat (無効な時間スパンフォーマット) |
| 400 | 無効な入力 | timeSeriesId '["ABC123"]' のインスタンスが見つかりません。 | インスタンスが見つからない |
| 400 | 無効な入力 | 名前が 'timeSeriesName' のインスタンスが見つかりません。 | インスタンスが見つからない |
| 400 | 無効な入力 | timeSeriesId '["ABC321"]' のインスタンスは削除できません。 この時系列 ID に関連付けられているインジェストされたイベントが既に存在します。 | インスタンスを削除できない |
| 400 | 無効な入力 | ID が '5e19f688-83fb-4aee-8321-5c123ed016b7' の環境では、時系列クエリ API はサポートされていません。 | TimeSeriesQueryNotSupported |
| 400 | 無効な入力 | 名前が 'temperature' の射影変数が、型変数定義またはインライン変数定義に見つかりませんでした。 | ProjectedVariableNotFound (投影変数が見つかりません) |
| 400 | 無効な入力 | ID が '7e19g688-83fb-4aee-8321-5c123ed016b7' で名前が 'ABC123' の型を更新挿入できません。 この名前は、ID '6e19g688-83fb-4aee-8321-5c123ed016b7' の型で既に使用されています。 | 名前すでに存在します |
| 400 | 無効な入力 | ID '4e19g688-83fb-4aee-8321-7c123ed016b7' で名前 'XYZ123' の階層を更新挿入できません。 この名前は、ID '8e39g688-83fb-4aee-8321-5c123ed016b7' の階層で既に使用されています。 | HierarchyNotDefined (階層未定義) |
| 400 | 無効な入力 | インスタンス数が「1,000,000」の制限を超えました。 | インスタンス数超過制限 |
| 400 | 無効な入力 | 種類数が「1000」の制限を超えました。 | NumberOfTypesExceededLimit |
| 400 | 無効な入力 | 階層の数が「32」の制限を超えました。 | 階層数ExceededLimit |
| 400 | 無効な入力 | エンティティサイズが最大許容サイズ「16,384」を超えています。 | オブジェクトサイズExceededLimit |
| 400 | 無効な入力 | 長さが '6' のオブジェクト名 'ABC123' が、最大許容文字数制限 '5' を超えています。 | 名前ExceededLimit |
| 408 | RequestTimeout | 要求が '30' 秒後にタイムアウトしました。 | バッチ要求サイズ超過制限 |
| 503 | リクエストが多すぎます | 環境 '95880732-01b9-44ea-8d2d-4d764dfe1904' の同時要求数 '30' を超えました。 | EnvRequestLimitExceeded (環境要求制限超過) |
こちらも参照ください
アプリケーション登録と Azure Active Directory プログラミング モデルの詳細については、「 開発者向け Azure Active Directory」を参照してください。
要求と認証のパラメーターについては、「 認証と承認」を参照してください。
HTTP リクエストとレスポンスのテストを支援するツールには、次のものがあります。
フィドラー。 この無料の Web デバッグ プロキシは REST 要求をインターセプトできるため、HTTP 要求と応答メッセージを診断できます。
JWT.io。 このツールを使用すると、ベアラー トークン内のクレームをすばやくダンプし、その内容を検証できます。
郵便配達員。 これは、REST API をデバッグするための無料の HTTP 要求および応答テスト ツールです。
Azure Time Series Insights Gen2 の詳細については、 Gen2 のドキュメントを参照してください。