GetServersTop

Prev Next

Classic/VPC環境で利用できます。

ユーザーアカウントが保有しているサーバのうち、CPU、メモリ、ファイルシステムの使用量が多い上位5つのサーバを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /cw_fea/real/cw/api/servers/top

リクエストヘッダ

Cloud Insight APIで共通して使用されるヘッダの詳細は、Cloud Insightのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
query String Required Metric名
  • avg_cpu_used_rto | mem_usert | avg_fs_usert
    • avg_cpu_used_rto: CPU使用率の平均
    • mem_usert: メモリ使用率
    • avg_fs_usert: ファイルシステム使用率の平均
prod String Optional サーバが属する環境
  • VPC (デフォルト)| Classic
    • VPC: VPC環境
    • Classic: Classic環境

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/servers/top?query=avg_cpu_used_rto&prod=vpc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
avg_cpu_user_rto String - CPUユーザーの割合の平均(%)
hostName String - ホスト名
instanceNo String - ホストインスタンス番号
avg_cpu_used_rto Number - CPU使用率の平均(%)
avg_fs_usert Number - ファイルシステム使用率の平均(%)
mem_usert Number - メモリ使用率(%)

レスポンスステータスコード

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Cloud Insight APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "avg_cpu_user_rto": "0.34282196",
        "hostName": "**********",
        "instanceNo": "**********",
        "avg_cpu_used_rto": 0.34282196,
        "avg_fs_usert": 8.1264,
        "mem_usert": 4.8596377
    },
    {
        "avg_cpu_user_rto": "0.3427846",
        "hostName": "**********",
        "instanceNo": "**********",
        "avg_cpu_used_rto": 0.3427846,
        "avg_fs_usert": 8.132111,
        "mem_usert": 4.678288
    },
    {
        "avg_cpu_user_rto": "0.34265983",
        "hostName": "**********",
        "instanceNo": "**********",
        "avg_cpu_used_rto": 0.34265983,
        "avg_fs_usert": 8.128385,
        "mem_usert": 4.7205358
    },
    {
        "avg_cpu_user_rto": "0.3425775",
        "hostName": "**********",
        "instanceNo": "**********",
        "avg_cpu_used_rto": 0.3425775,
        "avg_fs_usert": 8.1275215,
        "mem_usert": 4.7187376
    },
    {
        "avg_cpu_user_rto": "0.32602215",
        "hostName": "**********",
        "instanceNo": "**********",
        "avg_cpu_used_rto": 0.32602215,
        "avg_fs_usert": 8.127369,
        "mem_usert": 4.765153
    }
]