Azure Time Series Insights Gen2 クエリ API

[アーティクル]
08/05/2023

概要

クエリ API は、3 つの REST API で構成され、イベント、系列、集計用にそれぞれ 1 つの API が構成されます。

Query API は、省略可能な改ページを使用して HTTP GET 要求を使用して、指定された時間範囲のイベントスキーマとイベント数を返します。系列情報と 集計系列 情報は、省略可能な改ページ位置を使用して GET 操作を通じて公開されます。

API	説明
イベント API を取得する	検索範囲と述語に一致する生イベントの一覧を返します。
シリーズ API を取得する	モデルで定義された変数またはインラインで指定された変数を介してネットワークに記録されたデータを使用して、キャプチャされたイベントから Time Series Insights データのクエリと取得を有効にします。
集計シリーズ API	集計関数またはサンプル関数を使用して記録されたデータを集計することで、キャプチャされたイベントから Time Series Insights データのクエリと取得を有効にします。

API では、HTTP 要求 JSON 本文で指定されたさまざまなカスタマイズされた操作もサポートされています。クエリ定義は、一般的な操作に使用できます。

重要

JSON のフラット化とエスケープの規則への今後の変更の一部として、配列が動的型として格納されます。この型として格納されているペイロードプロパティは、Get Events API を通じてのみアクセスできます。

エラー応答

クエリの実行が失敗した場合、JSON 応答ペイロードには、次の構造に準拠するエラー応答が含まれます。

{
    "error" : {
        "code" : "...",
        "message" : "...",
        "innerError" : {  
            "code" : "...",
            "message" : "...",
        }
    }
}

ここでは、 innerError は省略可能です。形式が正しくない要求などの基本的なエラーに加えて、次のエラーが返されます。

Http 状態コード	エラーコード	エラーメッセージの例	可能な innerError コード
400	InvalidApiVersion	API バージョン '2016' はサポートされていません。サポートされているバージョンは、'2016-12-12'、'2018-11-01-preview' です。	-
400	InvalidUrl	要求 URL '/a/b' を解析できませんでした。	-
400	InvalidInput	指定されたクエリ 'aggregate' が無効です。サポートされているクエリは、'getEvents','getSeries','aggregateSeries' です。	InvalidQueryType
400	InvalidInput	'projectedVariables.temperature.value' の '$event.temperature.Double > 0' の時系列式は、有効なプロパティ参照式ではありません。	InvalidPropertyReferenceExpression
400	InvalidInput	'projectedVariables.temperature.filter' の '$event.temperature.Double' 時系列式が無効です。ブール値を返す述語式のみを指定できます。	InvalidPredicateExpression
400	InvalidInput	'projectedVariables.temperature.aggregation' の '$event.temperature.Double' 時系列式が無効です。集計式が含まれていませんでした。	InvalidAggregateExpression
400	InvalidInput	'projectedVariables.temperature.value' の '$event.temperature.Double > 0' 時系列式は、型 'numeric' の有効な値式ではありません。	InvalidValueExpression
400	InvalidInput	'projectedVariables.temperature.value' の値の時系列式は指定しないでください。型 'aggregate' の変数には null にする必要があります。	ValueExpressionShouldNotBeSpecified
400	InvalidInput	'projectedVariables.temperature.value' の値の時系列式は、変数の種類 'numeric' に指定する必要があります。	ValueExpressionShouldBeSpecified
400	InvalidInput	'projectedVariables.temperature.aggregation' の式 'min($value)' の変数の種類 'aggregate' は無効です。	InvalidVariableKind
400	InvalidInput	'interval' の timespan '00.00:01' は、有効な ISO8601 timespan 形式ではありません。	InvalidTimeSpanFormat
400	InvalidInput	timeSeriesId '["ABC123"]' のインスタンスが見つかりません。	InstanceNotFound
400	InvalidInput	"timeSeriesName" という名前のインスタンスが見つかりません。	InstanceNotFound
400	InvalidInput	timeSeriesId '["ABC321"]' のインスタンスは削除できません。この時系列 ID に関連付けられているイベントは既に取り込まれています。	CannotDeleteInstance
400	InvalidInput	ID '5e19f688-83fb-4aee-8321-5c123ed016b7' の環境では、時系列クエリ API はサポートされていません。	TimeSeriesQueryNotSupported
400	InvalidInput	'temperature' という名前の投影された変数が、型またはインライン変数の定義に見つかりませんでした。	ProjectedVariableNotFound
400	InvalidInput	ID '7e19g688-83fb-4aee-8321-5c123ed016b7' と名前 'ABC123' の型をアップサートできません。この名前は、ID '6e19g688-83fb-4aee-8321-5c123ed016b7' の型で既に使用されています。	NameAlreadyExists
400	InvalidInput	ID '4e19g688-83fb-4aee-8321-7c123ed016b7' と名前 'XYZ123' の階層をアップサートできません。この名前は、ID '8e39g688-83fb-4aee-8321-5c123ed016b7' の階層で既に使用されています。	HierarchyNotDefined
400	InvalidInput	インスタンスの数が '1,000,000' の制限を超えました。	NumberOfInstancesExceededLimit
400	InvalidInput	型の数が '1000' の制限を超えました。	NumberOfTypesExceededLimit
400	InvalidInput	階層の数が '32' の制限を超えました。	NumberOfHierarchiesExceededLimit
400	InvalidInput	エンティティサイズが、許可される最大サイズ '16,384' を超えています。	ObjectSizeExceededLimit
400	InvalidInput	長さ '6' のオブジェクト名 'ABC123' が、許容される文字の上限 '5' を超えています。	NameExceededLimit
408	RequestTimeout	要求が '30' 秒後にタイムアウトしました。	BatchRequestSizeExceededLimit
503	TooManyRequests	環境 '95880732-01b9-44ea-8d2d-4d764dfe1904' の同時要求数 '30' を超えました。	EnvRequestLimitExceeded

次の方法で共有

Azure Time Series Insights Gen2 クエリ API

概要

エラー応答

関連項目

その他のリソース