Base URL

Todas as URIs mencionadas no documento têm a seguinte base:

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

Neste artigo, você pode encontrar objetos de solicitação e resposta JSON para todos os tipos de operações com coletores personalizados e contadores SNMP, descrição detalhada de campos e notas explicativas:

Obter informações do contador registrado

Solicitar URL

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

Retorna JSON (META sobre categorias…) que foi salvo.

Parâmetros do caminho

campo Type Necessário descrição
collector_UID

corda

true

 O ID do coletor atribuído ao coletor. Para localizar o valor do UID, vá para Configurar > MetricsView Collectors > Edit Collector ID do coletor>.

Resposta de sucesso

{
    "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 informações do contador

Solicitar URL

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

Parâmetros do caminho

campo Type Necessário descrição
collector_UID

corda

true

 O ID do coletor atribuído ao coletor. Para localizar o valor do UID, vá para Configurar > MetricsView Collectors > Edit Collector ID do coletor>.
Exemplo de corpo de postagem para coletor personalizado
{
    "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"
            ]
        }
    ]
}
Exemplo de corpo de postagem para contador SNMP
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Obter lista de tarefas

Solicitar URL

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

Retorna JSON com lista de tarefas.

Parâmetros do caminho

campo Type Necessário descrição
collector_UID

corda

true

 O ID do coletor atribuído ao coletor. Para localizar o valor do UID, vá para Configurar > MetricsView Collectors > Edit Collector ID do coletor>.

Resposta de sucesso

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

Solicitar URL

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

Parâmetros do caminho

campo Type Necessário descrição
collector_UID

corda

true

 O ID do coletor atribuído ao coletor. Para localizar o valor do UID, vá para Configurar > MetricsView Collectors > Edit Collector ID do coletor>.

Exemplo de corpo do post

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