Базовый URL

Все URI, упомянутые в документе, имеют следующую базу:

https://api.dotcom-monitor.com/config_api_v1/

В этой статье вы можете найти объекты запросов и ответов JSON для всех типов операций с пользовательскими сборщиками и счетчиками SNMP, подробное описание полей и пояснительные примечания:

Получить информацию о зарегистрированном счетчике

URL-адрес запроса

ПОЛУЧИТЬ https://api.dotcom-monitor.com/config_api_v1/ counterinfo/get/{collector_UID}

Возвращает сохраненный JSON (META о категориях…).

Параметры пути

поле Type Обязательно описание
collector_UID

струна

true

 Идентификатор коллектора, назначенный коллектору. Чтобы найти значение UID, перейдите к разделу Настройка > MetricsView Collectors Изменение идентификатора коллектора коллектора > >.

Реакция на успех

{
    "GetCounterInfoResult":"{"results":[
        {
            "CategoryName":"Sample Category 1",
            "InstanceList":[
                "i-01","i-02",
                "_Total",
                "sdd"
            ],
            "CounterList":[
                "c-01",
                "c-02"
            ]
        },
        {
            "CategoryName":"Sample Category 2",
            "InstanceList":[
                "b-01",
                "b-02",
                "_Total"
            ],
            "CounterList":[
                "d-01",
                "d-02"
            ]
        },
        {
            "CategoryName":"S001",
            "InstanceList":null,
            "CounterList":[
                "var–1"
            ]
        }
    ]
    }"
}
Информация о счетчике регистрации

URL-адрес запроса

СООБЩЕНИЕ https://api.dotcom-monitor.com/config_api_v1/ counterinfo/post/{collector_UID}

Параметры пути

поле Type Обязательно описание
collector_UID

струна

true

 Идентификатор коллектора, назначенный коллектору. Чтобы найти значение UID, перейдите к разделу Настройка > MetricsView Collectors Изменение идентификатора коллектора коллектора > >.
Пример текста записи для пользовательского сборщика
{
    "results": [
        {
            "CategoryName": "Sample Category 1",
            "InstanceList": [
                "i-01",
                "i-02",
                "_Total"
            ],
            "CounterList": [
                "c-01",
                "c-02"
            ]
        },
        {
            "CategoryName": "Sample Category 2",
            "InstanceList": [
                "b-01",
                "b-02",
                "_Total"
            ],
            "CounterList": [
                "d-01",
                "d-02"
            ]
        }
    ]
}
Пример текста сообщения для счетчика SNMP
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Получить список задач

URL-адрес запроса

ПОЛУЧИТЬ https://api.dotcom-monitor.com/config_api_v1/tasks/ counterinfo/get/{collector_UID}

Возвращает JSON со списком задач.

Параметры пути

поле Type Обязательно описание
collector_UID

струна

true

 Идентификатор коллектора, назначенный коллектору. Чтобы найти значение UID, перейдите к разделу Настройка > MetricsView Collectors Изменение идентификатора коллектора коллектора > >.

Реакция на успех

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
Отправка собранных значений счетчиков

URL-адрес запроса

POST https://api.dotcom-monitor.com/config_api_v1/ counterinfo/tasks/post/{collector_UID}

Параметры пути

поле Type Обязательно описание
collector_UID

струна

true

 Идентификатор коллектора, назначенный коллектору. Чтобы найти значение UID, перейдите к разделу Настройка > MetricsView Collectors Изменение идентификатора коллектора коллектора > >.

Пример текста сообщения

{
    "Sample Task UID 1": 2343.44,
    "Sample Task UID 2": 8292
}