Base URL

Tous les URI référencés dans le document ont la base suivante :

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

Dans cet article, vous pouvez trouver des objets de requête et de réponse JSON pour tous les types d’opérations avec des collecteurs personnalisés et des compteurs SNMP, une description détaillée des champs et des notes explicatives :

Obtenir les informations sur le compteur enregistré

URL de la demande

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

Renvoie le JSON (META sur les catégories…) qui a été enregistré.

Paramètres de chemin d’accès

champ Type Obligatoire description
collector_UID

corde

true

 ID de collecteur attribué au collecteur. Pour trouver la valeur UID, accédez à Configurer > les collecteurs MetricsView Modifier l’ID > du collecteur du collecteur>.

Réponse au succès

{
    "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"
            ]
        }
    ]
    }"
}
Enregistrer les informations du compteur

URL de la demande

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

Paramètres de chemin d’accès

champ Type Obligatoire description
collector_UID

corde

true

 ID de collecteur attribué au collecteur. Pour trouver la valeur UID, accédez à Configurer > les collecteurs MetricsView Modifier l’ID > du collecteur du collecteur>.
Exemple de corps de poste pour collecteur personnalisé
{
    "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"
            ]
        }
    ]
}
Exemple de corps de publication pour compteur SNMP
{
    "results":
    {
        "OIDs":[
            "Sample OID 1",
            "Sample OID 2"
        ]
    }
}
Obtenir la liste des tâches

URL de la demande

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

Renvoie JSON avec la liste des tâches.

Paramètres de chemin d’accès

champ Type Obligatoire description
collector_UID

corde

true

 ID de collecteur attribué au collecteur. Pour trouver la valeur UID, accédez à Configurer > les collecteurs MetricsView Modifier l’ID > du collecteur du collecteur>.

Réponse au succès

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
Envoyer les valeurs de compteur collectées

URL de la demande

POST https://api.dotcom-monitor.com/config_api_v1/ contre-info/tâches/poste/{collector_UID}

Paramètres de chemin d’accès

champ Type Obligatoire description
collector_UID

corde

true

 ID de collecteur attribué au collecteur. Pour trouver la valeur UID, accédez à Configurer > les collecteurs MetricsView Modifier l’ID > du collecteur du collecteur>.

Exemple de corps de publication

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