GetDashboardWidgetList

Prev Next

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

ダッシュボードのウィジェットリストを照会します。

リクエスト

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

メソッド URI
GET /cw_fea/real/cw/api/chart/dashboard/{dashboardId}/widgets

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
dashboardId String Required ダッシュボード ID

リクエスト例

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

curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/chart/dashboard/**********/widgets' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
dashboardId String - ダッシュボード ID
name String - ダッシュボード名
widgetId String - ウィジェット ID

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

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

レスポンス例

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

[
    {
        "dashboardId": "**********",
        "name": "Memory Utilization",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "CPU Utilization Average",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "File System Utilization Average",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Network Out Average",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Network In Average",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Total GPU Count",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Current GPU MEM Usage",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Current GPU MEM Usage",
        "widgetId": "**********"
    },
    {
        "dashboardId": "**********",
        "name": "Current GPU Usage",
        "widgetId": "**********"
    }
]