Cloud Log Analytics overview
    • PDF

    Cloud Log Analytics overview

    • PDF

    Article summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Overview

    NAVER Cloud Platform is a cloud service built with NAVER's latest computing technology and operational know-how.
    The application program interface (API) that supports the use of services and solutions provided by NAVER Cloud Platform is called NAVER Cloud Platform API.
    NAVER Cloud Platform API is provided in the RESTful format, and is run by GET/POS method calls in the HTTP method.

    Common settings

    API URL

    https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/
    

    Request headers

    Header nameDescription
    x-ncp-apigw-timestampIt indicates the time elapsed since January 1, 1970 00:00:00 UTC in milliseconds.
    Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
    x-ncp-apigw-api-keyKey issued by API Gateway
    x-ncp-iam-access-keyAPI key issued by NAVER Cloud Platform or access key issued by IAM
    x-ncp-apigw-signature-v2Signature signed by the secret key that matches the access key in the sample body above
    Use the HMAC-SHA256 encryption algorithm
    Content-TypeSpecify the request body content type as application/JSON

    To create the request header values, see NAVER Cloud Platform API.

    regionCode

    DomainRegionregionCode
    PrivateKRkr
    JPNjpn
    SGNsgn
    • The APIs of Cloud Log Analytics have separate endpoints for each Region.
    • If you call the API of another Region, you must call the endpoint of that Region.
    • If the regionCode is different from the Region endpoint, it won't be processed.

    Operations

    View server list

    API nameDescription
    getClassicServersView Classic server list
    getClassicServersMysqlView Classic CDB-MySQL server list
    getClassicServersMssqlView Classic CDB-MSSQL server list
    getClassicServersBaremetalView Classic Baremetal server list
    getVPCServersView VPC server list
    getVPCServersMysqlView VPC CDB-MySQL server list
    getVPCServersMssqlView VPC CDB-MSSQL server list
    getVPCServersMongoDBView VPC CDB-MongoDB server list
    getVPCServersPostgresqlView VPC CDB-PostgreSQL server list
    getVPCServersBaremetalView VPC Baremetal server list
    getVPCServersSESView VPC Search Engine Service server list
    getVPCServersCDSSView VPC Cloud Data Streaming Service server list
    getVPCServersKubernetesView VPC Ncloud Kubernetes Service server list

    Set server log collection

    API nameDescription
    postClassicServersCollectingInfosSet Classic server log collection information
    postVPCServersCollectingInfosSet VPC server log collection information
    setUpClassicClaInstall Classic Linux server agent
    setUpClaVPCInstall VPC Linux server agent
    setUpwinClaInstall Classic Windows Server agent
    setUpwinClaVPCInstall VPC Windows Server agent

    Disable server log collection

    API nameDescription
    deleteClassicServerColleectingInfosDisable Classic server log collection information
    deleteVPCServerCollectingInfosDisable VPC server log collection information
    removeClaRemove Classic Linux agent
    removewinClaRemove VPC Linux agent
    removewinClaRemove Classic Windows agent

    View log count

    API nameDescription
    getLogsCountTotalView total log volume
    getLogsCountRecentView recent log volume
    getLogsCountIntervalView log volume by period
    getLogsCountAggregationView log volume by type

    Search log

    API nameDescription
    getLogsSearchSearch log

    View bucket list

    API nameDescription
    getExportBucketsView bucket list

    View usage

    API nameDescription
    getCapacityView usage

    Export log

    API nameDescription
    postLogsSearchExportExport log search results

    View export history

    API nameDescription
    getExportHistoryView export history

    View automatic export settings

    API nameDescription
    getExportConfigView automatic export settings

    Set automatic export

    API nameDescription
    postExportConfigSet automatic export

    Disable automatic export

    API nameDescription
    deleteExportConfigDisable automatic export

    Error response format

    If a wrong API request is sent, or an error occurs during its processing, then the success/failure result is returned as an HTTP status code. The detailed message is then returned in the form of JSON.

    Response example

    {
      "error": {
        "errorCode": "integer",
        "message": "string"
      }
    }
    

    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.