API (v2) メトリクス

独立した API エンドポイント /v2/metrics では、CPU 使用率、メモリ使用量、ネットワークトラフィック、メモリ利用状況などのサーバーメトリクスデータにアクセスできます。

localhost からであれば、認証なしでアクセスできます。

メトリクスデータ（localhost アクセス）

curl -sk https://127.0.0.1:9092/v2/metrics \
  | jq

レスポンス（成功）:

{
    "aggnet": [
        {
            "labels": [],
            "name": "receive_bytes_total_vlan-br0.1",
            "value": 28239920801
        },
        {
            "labels": [],
            "name": "transmit_bytes_total_vlan-br0.1",
            "value": 7680607520
        }
    ],
    "shortdisk": [
        {
            "name": "disk_io_now_loop0p2",
            "value": 0
        },
        {
            "name": "disk_io_now_nbd0p2",
            "value": 0
        }
    ],
    "shortload": [
        {
            "labels": [],
            "name": "node_load1",
            "value": 0.1000000000000000055511151231257827021181583404541015625
        },
        {
            "labels": [],
            "name": "node_load5",
            "value": 0.190000000000000002220446049250313080847263336181640625
        },
        {
            "labels": [],
            "name": "node_load15",
            "value": 0.270000000000000017763568394002504646778106689453125
        }
    ],
    "shortmem": [
        {
            "labels": [],
            "name": "node_memory_MemTotal_bytes",
            "value": 66880827392
        },
        {
            "labels": [],
            "name": "node_memory_MemAvailable_bytes",
            "value": 50891743232
        },
        {
            "labels": [],
            "name": "node_memory_MemFree_bytes",
            "value": 2547236864
        },
        {
            "labels": [],
            "name": "node_memory_SwapTotal_bytes",
            "value": 33776726016
        },
        {
            "labels": [],
            "name": "node_memory_SwapFree_bytes",
            "value": 33776726016
        }
    ]
}

メトリクスデータ（リモートアクセス）

1.) まず LOGIN を使って TOKEN を取得します:

curl -sk \
  -X POST https://API_IP:9092/v2/cce \
  -H "Content-Type: application/json" \
  -H "X-Client-Secret: YOUR-CLIENT-SECRET" \
  -d '
        {
            "cmd": "LOGIN"
        }
      ' \
  | jq

2.) 取得した CLIENT-SECRET と TOKEN を使って API を呼び出します:

curl -sk https://API-IP:9092/v2/metrics \
  -H "X-Client-Secret: CLIENT-SECRET" \
  -H "X-Token: TOKEN" \
  | jq

レスポンス（成功）:

{
    "aggnet": [
        {
            "labels": [],
            "name": "receive_bytes_total_vlan-br0.1",
            "value": 28239920801
        },
        {
            "labels": [],
            "name": "transmit_bytes_total_vlan-br0.1",
            "value": 7680607520
        }
    ],
    "shortdisk": [
        {
            "name": "disk_io_now_loop0p2",
            "value": 0
        },
        {
            "name": "disk_io_now_nbd0p2",
            "value": 0
        }
    ],
    "shortload": [
        {
            "labels": [],
            "name": "node_load1",
            "value": 0.1000000000000000055511151231257827021181583404541015625
        },
        {
            "labels": [],
            "name": "node_load5",
            "value": 0.190000000000000002220446049250313080847263336181640625
        },
        {
            "labels": [],
            "name": "node_load15",
            "value": 0.270000000000000017763568394002504646778106689453125
        }
    ],
    "shortmem": [
        {
            "labels": [],
            "name": "node_memory_MemTotal_bytes",
            "value": 66880827392
        },
        {
            "labels": [],
            "name": "node_memory_MemAvailable_bytes",
            "value": 50891743232
        },
        {
            "labels": [],
            "name": "node_memory_MemFree_bytes",
            "value": 2547236864
        },
        {
            "labels": [],
            "name": "node_memory_SwapTotal_bytes",
            "value": 33776726016
        },
        {
            "labels": [],
            "name": "node_memory_SwapFree_bytes",
            "value": 33776726016
        }
    ]
}

ご注意:

返されるデータは、API 呼び出しを受けたその時点で CCEd-API が取得した最新値です。CCEd-API 自体は過去のメトリクス履歴を保持しておらず、常に現在値のみを返します。