ベース URL

ドキュメント内で参照されるすべての URI には、次の基本があります。

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

この記事では、カスタムコレクタとSNMPカウンタ、詳細なフィールドの説明、説明文を含むすべてのタイプの操作のJSON要求オブジェクトと応答オブジェクトを見つけることができます。

登録されたカウンター情報の取得

URL をリクエストする

GET https://api.dotcom-monitor.com/config_api_v1/ カウンター情報/取得/{collector_UID}

保存されたJSON(カテゴリに関するメタ…)を返します。

パスパラメータ

畑 種類 必須 形容
collector_UID

糸

true

 コレクターに割り当てられたコレクター ID。 UID 値を見つけるには、「MetricsView コレクターの構成 > >コレクター コレクター ID の編集>」に移動します。

成功の応答

{
    "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/ カウンター情報/投稿/{collector_UID}

パスパラメータ

畑 種類 必須 形容
collector_UID

糸

true

 コレクターに割り当てられたコレクター ID。 UID 値を見つけるには、「MetricsView コレクターの構成 > >コレクター コレクター ID の編集>」に移動します。
カスタムコレクターの投稿本文の例
{
    "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 をリクエストする

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

タスク リストと共に JSON を返します。

パスパラメータ

畑 種類 必須 形容
collector_UID

糸

true

 コレクターに割り当てられたコレクター ID。 UID 値を見つけるには、「MetricsView コレクターの構成 > >コレクター コレクター ID の編集>」に移動します。

成功の応答

{
    "Sample Task UID 1": "Sample Counter Path 1",
    "Sample Task UID 2": "Sample Counter Path 2"
}
収集されたカウンタ値の送信

URL をリクエストする

投稿 https://api.dotcom-monitor.com/config_api_v1/ カウンター情報/タスク/投稿/{collector_UID}

パスパラメータ

畑 種類 必須 形容
collector_UID

糸

true

 コレクターに割り当てられたコレクター ID。 UID 値を見つけるには、「MetricsView コレクターの構成 > >コレクター コレクター ID の編集>」に移動します。

投稿本文の例

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