Base URL

Alle URIs, auf die im Dokument verwiesen wird, haben die folgende Basis:

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

In diesem Artikel finden Sie JSON-Anforderungs- und Antwortobjekte für alle Arten von Vorgängen mit benutzerdefinierten Kollektoren und SNMP-Zählern, detaillierte Feldbeschreibungen und erläuternde Hinweise:

Registrierte Zählerinformationen abrufen

URL anfordern

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

Gibt JSON (META über Kategorien…) zurück, das gespeichert wurde.

Pfadparameter

Feld drucktype Erforderlich beschreibung
collector_UID

Schnur

true

 Die Collector-ID, die dem Collector zugewiesen ist. Um den UID-Wert zu finden, gehen Sie zu Configure > MetricsView Collectors > Edit Collector Collector > ID.

Erfolgsreaktion

{
    "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"
            ]
        }
    ]
    }"
}
Zähler-Info registrieren

URL anfordern

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

Pfadparameter

Feld drucktype Erforderlich beschreibung
collector_UID

Schnur

true

 Die Collector-ID, die dem Collector zugewiesen ist. Um den UID-Wert zu finden, gehen Sie zu Configure > MetricsView Collectors > Edit Collector Collector > ID.
Beispiel für einen Beitragstext für einen benutzerdefinierten 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"
            ]
        }
    ]
}
Beispiel für einen Beitragstext für SNMP-Zähler
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Aufgabenliste abrufen

URL anfordern

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

Gibt JSON mit Aufgabenliste zurück.

Pfadparameter

Feld drucktype Erforderlich beschreibung
collector_UID

Schnur

true

 Die Collector-ID, die dem Collector zugewiesen ist. Um den UID-Wert zu finden, gehen Sie zu Configure > MetricsView Collectors > Edit Collector Collector > ID.

Erfolgsreaktion

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
Gesammelte Zählerwerte senden

URL anfordern

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

Pfadparameter

Feld drucktype Erforderlich beschreibung
collector_UID

Schnur

true

 Die Collector-ID, die dem Collector zugewiesen ist. Um den UID-Wert zu finden, gehen Sie zu Configure > MetricsView Collectors > Edit Collector Collector > ID.

Beispiel für einen Beitragstext

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