Skip to content

List¶

GET /api/v1/outer_function/list

Overview¶

List the Func functions that OpenAPI allows to execute

Query Parameters¶

Parameter	Type	Required	Description
_fuzzySearch	string		Fuzzy search query field Example: SuperVIP Template Allow empty: False
funcId	string		Search by function ID Example: SuperVIP Template Allow empty: False
funcTitle	string		Search by function title, using Like query Example: SuperVIP Template Allow empty: False
funcTags	commaarray		Function tags, used to filter functions by tags Example: Allow empty: False
funcScriptId	string		Script collection ID Example:

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.guance.com/api/v1/outer_function/list' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --compressed

Response¶

{
    "code": 200,
    "content": [
        {
            "argsJSON": [
                "workspace_uuid",
                "workspace_token",
                "your_name"
            ],
            "category": "openapi",
            "definition": "test(workspace_uuid, workspace_token, your_name='OpenAPI User')",
            "description": "Test interface, mainly to help users test whether they can call DataFlux Func through OpenAPI",
            "extraConfigJSON": null,
            "id": "example__openapi.test",
            "integration": null,
            "kwargsJSON": {
                "workspace_token": {},
                "workspace_uuid": {},
                "your_name": {
                    "default": "OpenAPI User"
                }
            },
            "name": "test",
            "scriptDescription": null,
            "scriptId": "example__openapi",
            "scriptSetDescription": null,
            "scriptSetId": "guance",
            "scriptSetTitle": "Guance Support",
            "scriptTitle": null,
            "tagsJSON": null,
            "title": "Test",
            "url": "/api/v1/func/example__openapi.test"
        },
        {
            "argsJSON": [
                "workspace_uuid",
                "workspace_token",
                "data"
            ],
            "category": "openapi",
            "definition": "report_event(workspace_uuid, workspace_token, data)",
            "description": "Report events, implement event writing through DataFlux Func\nSupport self-built inspections, and all alert handling logic for monitors\n\nParameters:\n    data {dict,list} The event data or its list to be reported, structured as follows:\n                        {\n                            \\\"title\\\"         : {str}      Event title, only supports single-line text\n                            \\\"message\\\"       : {str}      Event content, supports Markdown\n                            \\\"status\\\"        : {str}      Event level, optional values: ok, info, warning, error, critical\n                            \\\"dimension_tags\\\": {str,dict} Event dimensions, such as: { 'host': 'web001' } or its serialized string\n                        }",
            "extraConfigJSON": null,
            "id": "example__openapi.report_event",
            "integration": null,
            "kwargsJSON": {
                "data": {},
                "workspace_token": {},
                "workspace_uuid": {}
            },
            "name": "report_event",
            "scriptDescription": null,
            "scriptId": "example__openapi",
            "scriptSetDescription": null,
            "scriptSetId": "guance",
            "scriptSetTitle": "Guance Support",
            "scriptTitle": null,
            "tagsJSON": null,
            "title": "Report Event",
            "url": "/api/v1/func/example__openapi.report_event"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-1B02BD5D-D249-4D56-8762-9D6CB31FF0D1"
}