Base URL

Todos los URI a los que se hace referencia en el documento tienen la siguiente base:

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

En este artículo puede encontrar objetos de solicitud y respuesta JSON para todo tipo de operaciones con recopiladores personalizados y contadores SNMP, descripción detallada de los campos y notas explicativas:

Obtener información de contador registrado

URL de solicitud

OBTENER https://api.dotcom-monitor.com/config_api_v1/ counterinfo/get/{collector_UID}

Devuelve JSON (META sobre categorías…) que se guardó.

Parámetros de ruta

Campo Tipo Obligatorio Descripción
collector_UID

Cadena

true

 El identificador del recopilador asignado al recopilador. Para encontrar el valor UID, vaya a Configurar > MetricsView Collectors > Edit Collector > ID de recopilador.

Respuesta de éxito

{
    "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"
            ]
        }
    ]
    }"
}
Registrar información del contador

URL de solicitud

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

Parámetros de ruta

Campo Tipo Obligatorio Descripción
collector_UID

Cadena

true

 El identificador del recopilador asignado al recopilador. Para encontrar el valor UID, vaya a Configurar > MetricsView Collectors > Edit Collector > ID de recopilador.
Ejemplo de cuerpo de publicación para Custom Collector
{
    "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"
            ]
        }
    ]
}
Ejemplo de cuerpo de publicación para el contador SNMP
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Obtener lista de tareas

URL de solicitud

OBTENER https://api.dotcom-monitor.com/config_api_v1/tasks/ contrainformación/obtener/{collector_UID}

Devuelve JSON con lista de tareas.

Parámetros de ruta

Campo Tipo Obligatorio Descripción
collector_UID

Cadena

true

 El identificador del recopilador asignado al recopilador. Para encontrar el valor UID, vaya a Configurar > MetricsView Collectors > Edit Collector > ID de recopilador.

Respuesta de éxito

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
Enviar valores de contador recopilados

URL de solicitud

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

Parámetros de ruta

Campo Tipo Obligatorio Descripción
collector_UID

Cadena

true

 El identificador del recopilador asignado al recopilador. Para encontrar el valor UID, vaya a Configurar > MetricsView Collectors > Edit Collector > ID de recopilador.

Ejemplo de cuerpo de publicación

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