Skip to content

Send Query Task¶

POST /api/v1/logmine/send_task

Overview¶

Send a log clustering query task

Body Request Parameters¶

Parameter Name	Type	Required	Description
query	string		dql query statement, if this value exists, the namespace and conditions parameters will be invalid 【Format】:L::`*`:(`__docid`, analysis_field){}
namespace	string		Full namespace in dql query statement, default value is logging Optional values: ['object', 'object_history', 'custom_object', 'logging', 'keyevent', 'unrecovered_event', 'tracing', 'rum', 'network', 'security', 'backup_log', 'profiling', 'billing']
highlight	boolean		Whether to highlight the query string
conditions	string		dql query filter conditions Example: `source` IN ['kube-controller'] Allow empty: False Allow empty string: True
timeRange	array		Data time range, two elements, Example: [1573646935000, 1573646960000] Allow empty: False
analysisField	string	Y	Approximate text analysis field Example: message Allow empty: True

Parameter Additional Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/logmine/send_task' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"namespace":"logging","conditions":"index in [`default`]","highlight":true,"timeRange":[1683534635416,1683535535416],"analysisField":"message"}' \
--compressed

Response¶

{
    "code": 200,
    "content": {
        "taskId": "logminetaskchcbedk24lokg5cqfdb0"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "10594577704924482412"
}