Skip to content

Create Automatic Discovery Configuration



POST /api/v1/issue_auto_discovery/add

Overview

Body Request Parameters

Parameter Name Type Required Description
name string Y Title name
Example: name
Allow empty: False
Max length: 256
description string Description
Example: description
Allow empty: False
Allow empty string: True
dqlNamespace string Y Data scope
Example: rum
Allow empty: False
Optional values: ['keyevent']
every integer Y Check frequency (time length in seconds)
Example: 300
Allow empty: False
$minValue: 300
$maxValue: 3600
Optional values: [60, 300, 600, 900, 1800, 3600]
conditions string DQL query filter condition within the curly braces part
Example: source IN ['kube-controller']
Allow empty: False
Allow empty string: True
dimensions array Dimension field list
Example: ['chan_xxx1', 'chan_xxx2']
Allow empty: False
$minLength: 1
config json Y Issue definition configuration
Example: {}
Allow empty: False
config.name string Y Title name
Example: name
Allow empty: False
Max length: 256
config.level string Level
Example: level
Allow empty: False
Allow empty string: True
config.channelUUIDs array Channel UUID list
Example: ['chan_xxx1', 'chan_xxx2']
Allow empty: False
config.description string Description
Example: description
Allow empty: False
config.extend json Additional extension information, refer to the extend field in issue creation, generally not recommended to set on the OpenAPI side
Example: {}
Allow empty: True

Parameter Additional Notes

Request Example

curl 'https://openapi.guance.com/api/v1/issue_auto_discovery/add' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"test-core-worker","description":"desc1","every":300,"dqlNamespace":"keyevent","conditions":"`source` = \"lwctest\"","dimensions":["name"],"config":{"name":"name1","description":"desc1","level":"system_level_0","extend":{"manager":["acnt_e52a5a7b6418464cb2acbeaa199e7fd1"]},"channelUUIDs":["chan_61367ab1e38744738eb0a219dbf8bac1"]}}' \
--insecure

Response

{"code":200,"content":{"conditions":"`source` = \\"lwctest\\"","config":{"channelUUIDs":["chan_xxx"],"description":"desc1","extend":{"manager":["acnt_xxx"]},"level":"system_level_0","name":"name1"},"createAt":1735893173,"creator":"wsak_xxxx","declaration":{"asd":"aa,bb,cc,1,True","asdasd":"dawdawd","business":"aaa","dd":"dd","fawf":"afawf","organization":"64fe7b4062f74d0007b46676"},"deleteAt":-1,"description":"desc1","dimensions":["name"],"dqlNamespace":"keyevent","every":300,"id":null,"name":"test-core-worker","status":0,"updateAt":null,"updator":null,"uuid":"iatdc_xxxx","workspaceUUID":"wksp_xxxx"},"errorCode":"","message":"","success":true,"traceId":"4483644685680847012"} 

Feedback

Is this page helpful? ×