MENU
      Cloud Insight overview

        Cloud Insight overview


        Article summary

        Available in Classic and VPC

        Cloud Insight is a NAVER Cloud Platform service that integrates and manages the performance indicators of services provided by NAVER Cloud Platform. When a failure occurs, it promptly alerts the person in charge with relevant information. The Cloud Insight service provides APIs for features such as schema, plugin, event rule, and planned maintenance in a RESTful form.

        Cloud Insight metrics

        Cloud Insight APIs allow you to centrally manage performance and operational metrics for NAVER Cloud Platform services (products) and use them for various monitoring purposes. For information on the services (products) of the NAVER Cloud Platform that provide performance/operational metrics and a detailed description of the performance/operational metrics, see the following.

        Common Cloud Insight settings

        The following describes commonly used request and response formats in Cloud Insight APIs.

        Request

        The following describes the common request format.

        API URL

        The request API URL is as follows.

        https://cw.apigw.ntruss.com
        HTTP

        Request headers

        The following describes the headers.

        FieldRequiredDescription
        x-ncp-apigw-timestampRequiredThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC
        • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
        • Unix timestamp format
        x-ncp-iam-access-keyRequiredAccess key issued on NAVER Cloud Platform
        x-ncp-apigw-signature-v2RequiredBase64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
        Content-typeOptionalRequest data format
        • application/json
        x-ncp-region_codeOptionalNAVER Cloud Platform Region code
        • KR | SGN | JPN | USWN | DEN
          • KR: Korea Region
          • SGN: Singapore Region
          • JPN: Japan Region
          • USWN: US West Region
          • DEN: Germany Region
        x-ncp-dmn_cdOptionalNAVER Cloud Platform domain information

        Response

        The following describes the common response format.

        Response status codes

        Cloud Insight APIs use NAVER Cloud Platform's common response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

        Cloud Insight API

        The following describes the APIs provided by the Cloud Insight service.

        Dashboard

        The following describes the dashboard-related APIs.

        APIDescription
        GetDashboardListGet dashboard list
        GetDashboardWidgetImageDownload dashboard widget image file
        GetDashboardWidgetListGet dashboard widget list

        Event

        The following describes the event-related APIs.

        APIDescription
        SearchEventSearch and get event
        SearchEventByIdGet event details with event ID and rule ID
        SearchEventCountConsoleGet the number of occurrences of an event

        Event Rule

        The following describes the event rule-related APIs.

        APIDescription
        CopyRuleGroupCopy event rule
        CreateMetricsGrpCreate rule template (monitoring item group)
        CreateMonitorGrpCreate monitoring target group
        CreateRuleDirectlyCreate an event rule by specifying the target and items to be monitored
        CreateRuleGroupCreate event rule
        DeleteMetricGroupForceDelete all event rules related to a specific rule template (monitoring item group)
        DeleteMetricsGrpDelete rule template (monitoring item group)
        DeleteMetricsGrpByProdKeyAndIdDelete rule template (monitoring item group) with the rule template ID
        DeleteMonitorGroupForceDelete all event rules related to a specific monitoring target group
        DeleteMonitorGrpDelete monitoring target group
        DeleteRuleGroupDelete event rule
        DeleteRuleGroupByProdKeyAndIdDelete event rule with event rule ID
        GetAllMonitorGrpGet the list of monitoring target groups
        GetMetricsGroupGet details of a specific rule template (monitoring item group)
        GetMetricsGroupListGet rule template (monitoring item group) list
        GetMonitorGrpGet details of a specific monitoring target group
        GetNotificationRecipientListGet notification recipients
        GetRuleGroupGet details of a specific event rule
        GetRuleGroupByMetricGroupIdsGet event rules related to the rule template (monitoring item group)
        GetRuleGroupByMonitorGroupIdsGet event rules related to the monitoring target group
        GetRuleGroupListGet event rule list
        RemoveResourceFromRulesDelete a specific monitoring target from the event rule's monitoring target group
        SearchMetricListGet monitoring items available to the monitoring target group
        UpdateMetricsGroupEdit rule template (monitoring item group)
        UpdateMonitorGrpEdit monitoring target group
        UpdateRuleGroupEdit event rule

        Schema

        The following describes the schema-related APIs.

        APIDescription
        CreateCustomSchemaCreate user-defined schema
        DeleteProductSchemaDelete user-defined schema
        GetExtendedStatusSet/get extended metrics of an instance
        GetProductSchemaGet user-defined schema
        GetSystemSchemaKeyListGet the product key (cw_key) of the schema
        RegisterProductSchemaRegister user-defined schema
        UpdateExtendedDisableDisable the collection of extended metrics for the instance
        UpdateExtendedEnableEnable the collection of extended metrics for the instance
        UpdateProductSchemaEdit user-defined schema

        Custom Resource

        The following describes the APIs related to custom resource.

        APIDescription
        CreateCustomResourceCreate user-defined resource
        DeleteCustomResourceDelete user-defined resource
        GetAllCustomResourceGet user-defined resource list
        GetCustomResourceGet a specific user-defined resource details
        UpdateCustomResourceEdit user-defined resource

        Planned Maintenance

        The following describes the APIs related to planned maintenance.

        APIDescription
        CreatePlannedMaintenanceCreate maintenance schedule
        DeletePlannedMaintenanceDelete maintenance schedule
        GetPlannedMaintenanceDetailByIdGet details of a specific maintenance schedule
        GetPlannedMaintenanceListGet maintenance schedule list
        UpdatePlannedMaintenanceEdit maintenance schedule

        Plugin

        The following describes the plugin-related APIs.

        APIDescription
        AddFilePluginAdd file plugin
        AddPortPluginAdd port plugin
        AddProcessPluginAdd process plugin
        GetAllFilePluginGet file plugin list
        GetAllPortPluginGet port plugin list
        GetAllProcessPluginGet process plugin list
        GetFilePluginGet file plugin for a specific instance
        GetPortPluginGet port plugin for a specific instance
        GetProcessPluginGet process plugin for a specific instance
        RemoveFilePluginDelete file plugin
        RemovePortPluginDelete port plugin
        RemoveProcessPluginDelete process plugin
        UpdateFilePluginChange file plugin settings
        UpdatePortPluginChange port plugin settings
        UpdateProcessPluginChange process plugin settings

        Server

        The following describes the server-related APIs.

        APIDescription
        GetServersTopGet the top five servers with the highest CPU, memory, and file system usage rates

        Data

        The following describes the data-related APIs.

        APIDescription
        SendDataSend JSON data to Cloud Insight
        QueryDataGet time-series data stored in Cloud Insight
        QueryDataMultipleGet multiple time-series data stored in Cloud Insight
        QueryWidgetDataPreviewGet widget preview data by specifying a metric

        Integration

        The following describes the integration-related APIs.

        APIDescription
        CreateIntegrationCreate integration
        DeleteIntegrationDelete integration
        GetIntegrationGet integration
        GetIntegrationListGet integration list
        UpdateIntegrationUpdate integration

        NAVER Cloud Platform provides a variety of related resources to help users better understand Cloud Insight APIs.


        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.