getNasVolumeInstanceRatingList

Prev Next

Available in VPC

Get the size of a NAS volume instance over a specific time period based on the set measurement interval.

Note

getNasVolumeInstanceRatingList is only available in the Korea (KR) Region. To view the NAS volume instance measurement list in other Regions, see Cloud Insight API.

Request

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

Method URI
GET, POST /getNasVolumeInstanceRatingList

Request headers

For information about the headers common to all NAS APIs, see Common NAS headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the NAS volume instance for which you want to view volume instance size
nasVolumeInstanceNo String Required NAS volume instance number for which you want to view volume instance size
startTime String Required Measurement start date and time
  • yyyy-MM-dd'T'HH:mm:ssZ format
    • <e.g.> 2024-04-01'T'00:00:00+0900
  • URL encoding is required when using the GET method
endTime String Required Measurement end date and time
  • yyyy-MM-dd'T'HH:mm:ssZ format
    • <e.g.> 2024-04-01'T'23:59:59+0900
  • URL encoding is required when using the GET method
interval String Required Measurement interval
  • 5m | 6h | 1d | 1M
    • 5m: 5 minutes
    • 6h: 6 hours
    • 1d: 1 day
    • 1M: 1 month
  • Limit maximum lookup duration (startTime - endTime) based on measurement interval
    • 5m: up to 3 days
    • 6h: up to 1 month
    • 1d: up to 2 years
    • 1M: up to 5 years
responseFormatType String Optional Response result format type
  • xml (default) | json

Request example

The request example is as follows:

curl --location 'https://ncloud.apigw.ntruss.com/vnas/v2/getNasVolumeInstanceRatingList?regionCode=KR&nasVolumeInstanceNo=23490000&startTime=2024-04-08T00%3A00%3A00%2B0000&endTime=2024-04-08T10%3A00%3A00%2B0000&interval=5m&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

See NasVolumeInstanceRatingList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The response example is as follows:

{
    "getNasVolumeInstanceRatingListResponse": {
        "totalRows": 1,
        "nasVolumeInstanceRatingList": [
            {
                "ratingTime": "20240407",
                "averageVolumeSize": 536870912000,
                "averageVolumeUseSize": 380928,
                "averageVolumeUseRatio": 0.0,
                "maxVolumeUseSize": 380928,
                "maxVolumeUseRatio": 0.0,
                "minVolumeUseSize": 380928,
                "minVolumeUseRatio": 0.0,
                "snapshotAverageVolumeSize": 0,
                "snapshotAverageVolumeUseSize": 0,
                "snapshotMaxVolumeUseSize": 0,
                "snapshotMaxVolumeUseRatio": 0.0,
                "snapshotMinVolumeUseSize": 0,
                "snapshotMinVolumeUseRatio": 0.0
            }
        ],
        "requestId": "0000bdf-ceaa-4f9f-b6a6-da1352110000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

When the interval is 5M, it looks like this:

{
    "getNasVolumeInstanceRatingListResponse": {
        "totalRows": 1,
        "nasVolumeInstanceRatingList": [
            {
                "ratingTime": "20240407",
                "volumeSize": 536870912000,
                "volumeUseSize": 380928,
                "volumeUseRatio": 0.0,
                "snapshotVolumeSize": 0,
                "snapshotVolumeUseSize": 0,
                "snapshotVolumeUseRatio": 0.0,
            }
        ],
        "requestId": "0000bdf-ceaa-4f9f-b6a6-da1352110000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}