コンテンツにスキップ

DQL データ非同期クエリ¶

POST /api/v1/df/asynchronous/query_data

概要¶

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
queries	array		マルチコマンドクエリ。内容は query オブジェクトのリストです。空を許可: False
fieldTagDescNeeded	boolean		field または tag の説明情報が必要かどうか。空を許可: False

パラメータ補足説明¶

クエリの説明

非同期クエリの最終レスポンス content.data[i].warnings[] には DQLDataAccessScopeRestricted が含まれる可能性があります。 details[0].metadata.namespace は今回のリリースでは固定で logging です。restriction=partial は権限のあるインデックスのデータのみを返すことを意味し、 restriction=all は関連するログインデックスに権限がなく、空の結果を返すことを意味します。HTTP ステータスコードとリクエストパラメータは変更されません。

パラメータの説明

パラメータ名	type	必須	説明
queries	array	Y	マルチコマンドクエリ。内容は query オブジェクトのリスト
fieldTagDescNeeded	boolean		field または tag の説明情報が必要かどうか

queries[*] メンバーパラメータの構造説明 *** 注意: 「DQL データクエリ」インターフェースに async_id パラメータが追加されています ***

パラメータ名	type	必須	説明
`async_id`	string	N	非同期クエリタスク ID。この値は前回の dql クエリ結果の content.data[*].async_id から取得します。前回のクエリ結果にこの値が存在する場合、今回のクエリでこの値を指定する必要があります。
qtype	string	Y	クエリ文のタイプ dql: dql タイプのクエリ文を示します。 promql: PromQL タイプのクエリ文を示します。
query	json	Y	クエリ構造
query.q	string		qtype と同じタイプのクエリ文（例：dql または promql クエリ文）
query.ignore_cache	boolean		クエリでキャッシュを無効にするかどうか。デフォルトは false（キャッシュを使用）。
query.promqlType	enum		qtype=promql の場合に有効。promql のクエリタイプ。`instantQuery` と `rangeQuery` から選択可能。デフォルトは `rangeQuery`。
query.highlight	boolean		ハイライトデータを表示するかどうか
query.timeRange	array		時間範囲のタイムスタンプリスト
query.disableMultipleField	bool		単一カラムモードを有効にするかどうか。デフォルトは `true`。
query.showLabel	bool		オブジェクトのラベルを表示するかどうか。デフォルトはなし。
query.funcList	array		dql 戻り値を再集計するための修飾。disableMultipleField=false の場合、このパラメータは無効。
query.slimit	integer		時系列グループサイズ。メトリクスクエリのみ有効。
query.soffset	integer		時系列グループオフセット
query.limit	integer		ページサイズ
query.offset	integer		ページオフセット
query.orderby	array		ソートリスト。`{fieldName:method}` 形式。メトリクスセットクエリのソートは fieldName=time のみサポート。method は ["desc", "asc"]。メトリクスセットクエリのソートは fieldName=time のみサポート。
query.sorderby	array		ソートリスト。sorderby の column は式で、単一の値を返すすべての集計関数（min, max, last, avg, p90, p95, count）をサポート。`{fieldName:method}` 形式。構造は orderby と同じ。
query.order_by	array		ソートリスト。構造は [{"column": "field", "order": "DESC"}]。doris エンジン互換フィールド。
query.sorder_by	array		ソートリスト。構造は [{"column": "field", "order": "DESC"}]。doris エンジン互換フィールド。
query.density	string		レスポンスの点密度。優先度は autoDensity より低く、dql 文で設定された密度より高い。
query.interval	number		時間スライス間隔。Kodo int64 範囲内に変換可能で、1ms 以上の整数ミリ秒の正数のみ受け入れ可能。デフォルト単位は秒。interval_unit でミリ秒を指定可能。
query.interval_unit	string		interval の単位。`s` または `ms` から選択可能。デフォルトは `s`。
query.search_after	array		ページネーションクエリマーカー。前回のリクエストのレスポンスにある search_after 値を今回のリクエストパラメータとして使用。
query.maxPointCount	integer		最大ポイント数
query.workspaceUUID	string		クエリ対象のワークスペースの UUID。"*" はすべての許可されたワークスペースをクエリ。ワークスペース参照インターフェース /wksp_share/granted_ws_list を参照。
query.workspaceUUIDs	array		クエリ対象のワークスペースの UUID リスト。query.workspaceUUID より優先度が高い。["*"] はすべての許可されたワークスペースをクエリ。ワークスペース参照インターフェース /wksp_share/granted_ws_list を参照。
query.targetRegion	string		クエリ対象のワークスペースを ["*"] に指定した場合、このフィールドは必須。
query.output_format	string		lineprotocol：行プロトコル形式で出力。デフォルトでは空欄で、既存の出力形式を保持。
query.cursor_time	integer		セグメントクエリのしきい値。最初のセグメントクエリでは cursor_time を end_time に設定。以降のセグメントクエリでは cursor_time をレスポンスの next_cursor_time に設定。
query.cursor_token	string		ページネーションクエリトークン（エンジンが cursor_token の値を返す）。ページネーションクエリでは、前回のクエリで返された next_cursor_token を今回のクエリの cursor_token に設定。cursor_token がないリクエストでは、同じタイムスタンプのデータがページング時にスキップされる可能性があります。
query.disable_sampling	bool		サンプリング無効化スイッチ。デフォルトは false。
query.disable_truncate	bool		クエリ結果の切り捨てを無効にするかどうか。デフォルトはなし。

レスポンス点密度 density パラメータ値の説明

選択可能な値	説明
lower	低め、60 ポイント
low	低い、180 ポイント
medium	中程度、360 ポイント
high	低い？（原文ママ）720 ポイント

点密度パラメータの優先順位に注意。最大密度 density[high] * maxPointCount > interval > density > dql 文内の制御パラメータ
よくあるクエリの説明
未復旧イベントクエリ注: openapi インターフェースでデータクエリを実行する場合、デフォルトで管理者ロールになります。データアクセスルールの制限を受ける可能性があることに注意してください。

レスポンス¶