MENU
      Get usage

        Get usage


        Article summary

        Available in Classic and VPC

        Get the capacity being used by the Cloud Log Analytics service.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        GET/api/{regionCode}-v1/capacity

        Request headers

        For information about the headers common to all Cloud Log Analytics APIs, see Cloud Log Analytics request headers.

        Request path parameters

        You can use the following path parameters with your request:

        FieldTypeRequiredDescription
        regionCodeStringRequiredRegion code
        • kr | sgn | jpn | uswn | den
          • kr: Korea Region
          • sgn: Singapore Region
          • jpn: Japan Region
          • uswn: US West Region
          • den: Germany Region

        Request example

        The request example is as follows:

        curl --location --request GET 'https://cloudloganalytics.apigw.ntruss.com/api/{regionCode}-v1/capacity' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        codeInteger-Response status codes
        messageString-Response status message
        resultObject-Response result
        result.prodNoInteger-Product number
        result.prodNmString-Pricing plan name
        result.prodSubNmString-Sub pricing plan name
        result.prodNmDefaultYnBoolean-Whether it is a basic plan
        • true | false
          • true: basic pricing plan
          • false: not basic pricing plan
        result.saveTermString-Data retention period
        result.dataSizeString-Provided capacity
        result.dataLimitInteger-Capacity limit
        result.dataLimitDailyInteger-Daily available capacity limit
        result.alarmLimitCountInteger-Notification occurrence conditions
        result.prodYmdtString-Product usage start date
        result.usageSizeString-Capacity in use
        result.remainSizeString-Available capacity
        result.usagePercentNumber-Available capacity

        Response status codes

        For response status codes common to all Cloud Log Analytics APIs, see Cloud Log Analytics response status codes.

        Response example

        The response example is as follows:

        {
            "code": 0,
            "message": "The request has been successfully processed.",
            "result": {
                "prodNo": 1,
                "prodNm": "Standard",
                "prodSubNm": null,
                "prodNmDefaultYn": null,
                "saveTerm": "1m",
                "dataSize": "100.0G",
                "dataLimit": null,
                "dataLimitDaily": null,
                "alarmLimitCount": null,
                "prodYmdt": null,
                "usageSize": "52M",
                "remainSize": "102348.0M",
                "usagePercent": 0.05078125
            }
        }
        JSON

        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.