Okerr :: техподдержка

Зачем это нужно

При удаленной работе с okerr (не через веб-интерфейс. Например, при массовом создании и [пере]настройке параметров индикаторов) нужно знать имена параметров.

Через веб интерфейс

Если есть индикатор нужного типа проверки, то на страничке индикатора видны имена параметров:

В этом случае, мы видим, что для метода проверки "HTTP status code" имена параметров: url, options и status.

Через API checkmethods

По адресу https://cp.okerr.com/api/checkmethods можно получить JSON структуру всех методов проверки и их параметров, например:

    "httpstatus": {
        "args": {
            "options": {
                "default": "",
                "desc": "Options: ssl_noverify addr=1.2.3.4",
                "textname": "Options: ssl_noverify addr=1.2.3.4",
                "value": ""
            },
            "status": {
                "default": "200",
                "desc": "HTTP status code",
                "textname": "status",
                "value": "404"
            },
            "url": {
                "default": "https://okerr.com/",
                "desc": "URL",
                "textname": "URL",
                "value": "https://www.opl.it/okerr"
            }
        },
        "name": "HTTP status code",
        "remote": true
    },

Здесь мы видим, что для метода проверки httpstatus используются аргументы options, status и url.

Через API indicator

Можно посмотреть параметры через API функции в okerrclient, для отдельного индикатора:

hostname ~ $ okerrapi indicator -n github
{
    "age": 1301,
    "args": {
        "options": "",
        "status": "200",
        "url": "https://github.com/"
    },
    "changed": 1682023266,
    "checkmethod": "httpstatus",
    "desc": "",
    "details": "Got status code 200 OK as expected",
    "disabled": false,
    "errage": 0,
    "expected": null,
    "flags": [
        "OK"
    ],
    "id": 4711,
    "location": "de",
    "maintenance": null,
    "name": "github",
    "patience": 1200,
    "policy": 871,
    "policyname": "Default",
    "policyperiod": "1h",
    "problem": false,
    "scheduled": 1717592729,
    "silent": false,
    "status": "OK",
    "statusage": 35567164,
    "tags": [
        "OK",
        "httpstatus",
        "active",
        "policy:Default"
    ],
    "uerrage": 0,
    "updated": 1717589129
}

В структуре args мы видим ключи 'url' и 'status', 'options'.