GetDashboardWidgetImage

Prev Next

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

ダッシュボードのウィジェットデータを800x600サイズの PNGファイルでダウンロードします。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド タイプ 必須の有無 説明
startTime Integer Required 測定開始日時(ミリ秒)
  • Unix Timestamp形式
endTime Integer Required 測定終了日時(ミリ秒)
  • Unix Timestamp形式
widgetResolutionMode String Optional 照会周期
  • AUTO (デフォルト) | HIGH
    • AUTO: ダッシュボードと同じ周期で照会
    • HIGH: ダッシュボードより短い周期で詳細照会

リクエスト例

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

curl --location --request GET 'https://cw.apigw.ntruss.com/cw_fea/real/cw/api/chart/dashboard/**********/widgets/bucket_size__**********?startTime=1733097600000&endTime=1733148000000&widgetResolutionMode=AUTO' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

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

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

レスポンス例

レスポンス成功時、200 OKと表示され、ダッシュボードウィジェットの画像ファイルがダウンロードされます。

image.png