Skip to content

Modify Auto Discovery Configuration¶

POST /api/v1/issue_auto_discovery/{cfg_uuid}/modify

Overview¶

Route Parameters¶

Parameter Name	Type	Required	Description
cfg_uuid	string	Y	Issue auto discovery configuration UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Title name Example: name Can be empty: False Maximum length: 256
description	string	N	Description Example: description Can be empty: False Can be an empty string: True
dqlNamespace	string	Y	Data scope Example: rum Can be empty: False Optional values: ['keyevent']
every	integer	Y	Check frequency (in seconds) Example: 300 Can be empty: False $minValue: 300 $maxValue: 3600 Optional values: [300, 600, 900, 1800, 3600]
conditions	string	N	Content within curly braces in the DQL query filter condition Example: `source` IN ['kube-controller'] Can be empty: False Can be an empty string: True
dimensions	array	N	List of dimension fields Example: ['chan_xxx1', 'chan_xxx2'] Can be empty: False $minLength: 1
config	json	Y	Issue definition configuration Example: {} Can be empty: False
config.name	string	Y	Title name Example: name Can be empty: False Maximum length: 256
config.level	string	N	Level Example: level Can be empty: False Can be an empty string: True
config.channelUUIDs	array	N	List of channel UUIDs Example: ['chan_xxx1', 'chan_xxx2'] Can be empty: False
config.description	string	N	Description Example: description Can be empty: False
config.extend	json	N	Additional extended information. Refer to the extend field in issue creation, generally not recommended for OpenAPI side settings. Example: {} Can be empty: True

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_xxxxx/modify' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"test-core-worker","description":"This is a test example for creating an issue auto discovery rule","every":300,"dqlNamespace":"keyevent","conditions":"`source` = \"lwctest\"","dimensions":["name"],"config":{"name":"Title in issue definition","description":"Modified description in issue definition","level":"system_level_0","extend":{"text":"Modified description in issue definition","manager":["acnt_xxx"]},"channelUUIDs":["chan_xxxxx"]}}' \
--insecure

Response¶

{
    "code": 200,
    "content": {
        "conditions": "`source` = \"lwctest\"",
        "config": {
            "channelUUIDs": [
                "chan_xxxxx"
            ],
            "description": "Modified description in issue definition",
            "extend": {
                "manager": [
                    "acnt_xxxx"
                ],
                "text": "Modified description in issue definition"
            },
            "level": "system_level_0",
            "name": "Title in issue definition"
        },
        "createAt": 1735893393,
        "creator": "wsak_xxxx",
        "declaration": {
            "organization": "xxx"
        },
        "deleteAt": -1,
        "description": "This is a test example for creating an issue auto discovery rule",
        "dimensions": [
            "name"
        ],
        "dqlNamespace": "keyevent",
        "every": 300,
        "id": 47,
        "name": "test-core-worker",
        "status": 0,
        "updateAt": 1735893669.0875816,
        "updator": "wsak_xxxx",
        "uuid": "iatdc_xxxx",
        "workspaceUUID": "wksp_xxxxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1634728700182310814"
}