コンテンツにスキップ

データクエリタスクの作成¶

POST /api/v1/log_backup_cfg/query_task

概要¶

データ転送の非同期クエリタスクを作成し、クエリタスクIDを返します。このクエリタスクIDは後でクエリタスクの状態を確認するために使用できます。

注意：1回のクエリで最大10個のファイルを取得できます。さらに多くのファイルをクエリする場合は、tokenパラメータを指定して再度呼び出し、tokenパラメータの値には前回のクエリで返されたtoken値を設定してください。

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

パラメータ名	型	必須	説明
name	string	Y	ルール名空文字列を許可: False
search	json		検索条件。正規表現のみサポート空文字列を許可: False
startTime	string	Y	開始時間。ミリ秒単位のタイムスタンプ（文字列）例: 1763542157000 空文字列を許可: False
endTime	string	Y	終了時間。ミリ秒単位のタイムスタンプ（文字列）例: 1763542157000 空文字列を許可: False
token	string		クエリカーソル。ページングクエリを行う場合、前回の結果のtokenを指定します空文字列を許可: False 空文字列を許可: True
topN	integer		1ページあたりの返却件数空文字列を許可: False 例: 10 $minValue: 1 $maxValue: 1000
dataType	string		データタイプ空文字列を許可: False 空文字列を許可: True 選択可能な値: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am']

パラメータ補足説明¶

search リクエストパラメータの説明

パラメータ名	型	説明
conditions	array[json]	クエリ条件。各条件は1つのjsonオブジェクトで、キー: key, value, logic
operator	string	論理演算子。選択可能な値: and, or

conditions パラメータの説明

パラメータ名	型	説明
key	string	フィールド名
value	string	フィールド値
logic	string	論理演算子。選択可能な値: match, notMatch

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/log_backup_cfg/query_task' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"xxx-test","dataType":"logging","startTime":"1764000000000","endTime":"1764037304000","search":"","topN":50}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "task_id": "d4ih5flt3l333a0ulmu0:a29kby14LWJhY2t1cGxvZy0w"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "087552ec57015df654c5eaefdd604305"
}