Cloud Insightの概要
- 印刷する
- PDF
Cloud Insightの概要
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Cloud Insightは、NAVERクラウドプラットフォームが提供するサービスのパフォーマンス指標を統合管理し、障害発生時に担当者に障害情報を迅速に伝える NAVERクラウドプラットフォームのサービスです。Cloud Insightサービスは、Schema、Plugin、Event Rule、Planned Maintenanceなどの機能関連の APIを RESTful形式で提供します。
Cloud Insight指標
Cloud Insight APIを利用すると NAVERクラウドプラットフォームサービス(商品)のパフォーマンス/運用指標(Metric)を統合管理してさまざまなモニタリングに活用することができます。パフォーマンス/運用指標を提供する NAVERクラウドプラットフォームのサービス(商品)情報とパフォーマンス/運用指標に関する詳細は、次をご参照ください。
- Metric、Dimension、Aggregation、Schemaなどの概念の説明: Cloud Insightの概念
- NAVERクラウドプラットフォームのサービス(商品)別パフォーマンス/運用指標関連情報の確認: Cloud Insight指標
Cloud Insightの共通設定
Cloud Insight APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
リクエストヘッダ
ヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp | Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key | Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 | Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名 |
Content-type | Optional | リクエストデータの形式
|
x-ncp-region_code | Optional | NAVERクラウドプラットフォームのリージョンコード
|
x-ncp-dmn_cd | Optional | NAVERクラウドプラットフォームのドメイン情報
|
レスポンス
共通レスポンス形式を説明します。
レスポンスステータスコード
Cloud Insight APIは NAVERクラウドプラットフォームの共通レスポンスステータスコードを使用します。NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
Cloud Insight API
Cloud Insightサービスで提供する APIの説明は次の通りです。
Dashboard
Dashboard関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| GetDashboardList | ダッシュボードリストを照会 |
| GetDashboardWidgetImage | ダッシュボードウィジェットの画像ファイルをダウンロード |
| GetDashboardWidgetList | ダッシュボードウィジェットリストを照会 |
Event
Event関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| SearchEvent | Eventの検索と照会 |
| SearchEventById | Event IDと Rule IDで Eventを詳細照会 |
| SearchEventCountConsole | Event発生回数を照会 |
Event Rule
Event Rule関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| CopyRuleGroup | Event Ruleをコピー |
| CreateMetricsGrp | Rule Template(監視項目グループ)を作成 |
| CreateMonitorGrp | 監視対象グループを作成 |
| CreateRuleDirectly | 監視対象と監視項目を直接指定して Event Ruleを作成 |
| CreateRuleGroup | Event Ruleを作成 |
| DeleteMetricGroupForce | 特定の Rule Template(監視項目グループ)に関連するすべての Event Ruleを削除 |
| DeleteMetricsGrp | Rule Template(監視項目グループ)を削除 |
| DeleteMetricsGrpByProdKeyAndId | Rule Template IDで Rule Template(監視項目グループ)を削除 |
| DeleteMonitorGroupForce | 特定の監視対象グループに関連するすべての Event Ruleを削除 |
| DeleteMonitorGrp | 監視対象グループを削除 |
| DeleteRuleGroup | Event Ruleを削除 |
| DeleteRuleGroupByProdKeyAndId | Event Rule IDで Event Ruleを削除 |
| GetAllMonitorGrp | 監視対象グループリストを照会 |
| GetMetricsGroup | 特定の Rule Template(監視項目グループ)の詳細情報を照会 |
| GetMetricsGroupList | Rule Template(監視項目グループ)リストを照会 |
| GetMonitorGrp | 特定の監視対象グループの詳細情報を照会 |
| GetNotificationRecipientList | 通知対象を照会 |
| GetRuleGroup | 特定の Event Ruleの詳細情報を照会 |
| GetRuleGroupByMetricGroupIds | Rule Template(監視項目グループ)に関連した Event Ruleを照会 |
| GetRuleGroupByMonitorGroupIds | 監視対象グループに関連した Event Ruleを照会 |
| GetRuleGroupList | Event Ruleリストを照会 |
| RemoveResourceFromRules | Event Ruleの監視対象グループから特定の監視対象を削除 |
| SearchMetricList | 監視対象グループで照会可能な監視項目を照会 |
| UpdateMetricsGroup | Rule Template(監視項目グループ)を更新 |
| UpdateMonitorGrp | 監視対象グループを更新 |
| UpdateRuleGroup | Event Ruleを更新 |
Schema
Schema関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| CreateCustomSchema | ユーザー定義スキーマを作成 |
| DeleteProductSchema | ユーザー定義スキーマを削除 |
| GetExtendedStatus | インスタンスの Extended Metric設定を照会 |
| GetProductSchema | ユーザー定義スキーマを照会 |
| GetSystemSchemaKeyList | スキーマの商品キー(cw_key)を照会 |
| RegisterProductSchema | ユーザー定義スキーマを登録 |
| UpdateExtendedDisable | インスタンスの Extended Metric収集設定を解除 |
| UpdateExtendedEnable | インスタンスの Extended Metric収集を設定 |
| UpdateProductSchema | ユーザー定義スキーマを更新 |
Custom Resource
Custom Resource関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| CreateCustomResource | ユーザー定義リソースを作成 |
| DeleteCustomResource | ユーザー定義リソースを削除 |
| GetAllCustomResource | ユーザー定義リソースリストを照会 |
| GetCustomResource | 特定のユーザー定義リソースの詳細情報を照会 |
| UpdateCustomResource | ユーザー定義リソースを更新 |
Planned Maintenance
Planned Maintenance関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| CreatePlannedMaintenance | メンテナンススケジュールを作成 |
| DeletePlannedMaintenance | メンテナンススケジュールを削除 |
| GetPlannedMaintenanceDetailById | 特定のメンテナンススケジュールを詳細照会 |
| GetPlannedMaintenanceList | メンテナンススケジュールリストを照会 |
| UpdatePlannedMaintenance | メンテナンススケジュールを更新 |
Plugin
Plugin関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| AddFilePlugin | File Pluginを追加 |
| AddPortPlugin | Port Pluginを追加 |
| AddProcessPlugin | Process Pluginを追加 |
| GetAllFilePlugin | File Pluginリストを照会 |
| GetAllPortPlugin | Port Pluginリストを照会 |
| GetAllProcessPlugin | Process Pluginリストを照会 |
| GetFilePlugin | 特定のインスタンスに対する File Pluginを照会 |
| GetPortPlugin | 特定のインスタンスに対する Port Pluginを照会 |
| GetProcessPlugin | 特定のインスタンスに対する Process Pluginを照会 |
| RemoveFilePlugin | File Pluginを削除 |
| RemovePortPlugin | Port Pluginを削除 |
| RemoveProcessPlugin | Process Pluginを削除 |
| UpdateFilePlugin | File Plugin設定を変更 |
| UpdatePortPlugin | Port Plugin設定を変更 |
| UpdateProcessPlugin | Process Plugin設定を変更 |
Server
Server関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| GetServersTop | CPU、メモリ、ファイルシステムの使用率が高い上位5つのサーバを照会 |
Data
Data関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| SendData | Cloud Insightに JSONデータを送信 |
| QueryData | Cloud Insightに保存されている time-seriesデータを照会 |
| QueryDataMultiple | Cloud Insightに保存されている time-seriesデータをマルチ照会 |
| QueryWidgetDataPreview | Metricを指定してウィジェットプレビューデータを照会 |
Integration
Integration関連 APIの説明は次の通りです。
| API | 説明 |
|---|---|
| CreateIntegration | Integrationを作成 |
| DeleteIntegration | Integrationを削除 |
| GetIntegration | Integrationを照会 |
| GetIntegrationList | Integrationリストを照会 |
| UpdateIntegration | Integrationを更新 |
Cloud Insight関連リソース
Cloud Insight APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Cloud Insight APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Cloud Insightサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Cloud Insightサービスの使用方法
- Cloud Insightご利用ガイド: NAVERクラウドプラットフォームコンソールで Cloud Insightを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポート有無に関するガイド
- 料金の紹介、特徴、詳細機能: Cloud Insightの料金体系、特徴、詳細機能のサマリー
- サービス関連の最新のお知らせ: Cloud Insightサービス関連の最新共有ニュース
- よくある質問: Cloud Insightサービスユーザーからのよくある質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接問い合わせ
この記事は役に立ちましたか?
