getNasVolumeInstanceRatingList

Available in VPC

Get the size of a NAS volume instance over a specific time period based on the set measurement interval. getNasVolumeInstanceRatingList is available only in the Korea (KR) Region. To view the NAS volume instance measurement list in other Regions, see Cloud Insight API.

Syntax

The getNasVolumeInstanceRatingList syntax is as follows:

./ncloud vnas getNasVolumeInstanceRatingList \
    --nasVolumeInstanceNo <nas-volume-instance-no> \
    --startTime <start-time> \
    --endTime <end-time> \
    --interval <5m|6h|1d|1M> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getNasVolumeInstanceRatingList.

Required options

The following options are required for getNasVolumeInstanceRatingList.

Options	Type	Required	Description
`--nasVolumeInstanceNo`	String	Required	NAS volume instance number See getNasVolumeInstanceList.
`--startTime`	String	Required	Measurement start date and time yyyy-MM-dd'T'HH:mm:ssZ format (e.g., `2026-04-01T00:00:00+0900`)
`--endTime`	String	Required	Measurement end date and time yyyy-MM-dd'T'HH:mm:ssZ format (e.g., `2026-04-01T23:59:59+0900`)
`--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

Common options

For information about the options common to all vnas subcommands, see NAS (VPC) options.

Examples

If the request to retrieve the NAS volume measurement list is successful, volume usage information and snapshot usage information for each measurement point are returned. The returned items vary depending on the interval value.

Command

The following is an example command for querying at 5m intervals.

./ncloud vnas getNasVolumeInstanceRatingList \
    --nasVolumeInstanceNo 10234567 \
    --startTime "2026-08-19T11:45:00+0900" \
    --endTime "2026-08-19T12:00:00+0900" \
    --interval 5m \
    --regionCode KR \
    --output json

The following is an example command for querying at 6h intervals.

./ncloud vnas getNasVolumeInstanceRatingList \
    --nasVolumeInstanceNo 10234567 \
    --startTime "2026-08-19T00:00:00+0900" \
    --endTime "2026-08-19T23:59:59+0900" \
    --interval 6h \
    --regionCode KR \
    --output json

Output

The following is an example output of queries made at 5m intervals. The volume usage at the time of measurement is returned.

{
  "getNasVolumeInstanceRatingListResponse": {
    "totalRows": 3,
    "nasVolumeInstanceRatingList": [
      {
        "ratingTime": "2026-08-19 11:46:29.549",
        "volumeSize": 483183820800,
        "volumeUseSize": 401408,
        "volumeUseRatio": 0.0,
        "snapshotVolumeSize": 53687091200,
        "snapshotVolumeUseSize": 0,
        "snapshotVolumeUseRatio": 0.0
      },
      {
        "ratingTime": "2026-08-19 11:51:17.455",
        "volumeSize": 483183820800,
        "volumeUseSize": 401408,
        "volumeUseRatio": 0.0,
        "snapshotVolumeSize": 53687091200,
        "snapshotVolumeUseSize": 0,
        "snapshotVolumeUseRatio": 0.0
      },
      {
        "ratingTime": "2026-08-19 11:56:02.254",
        "volumeSize": 483183820800,
        "volumeUseSize": 401408,
        "volumeUseRatio": 0.0,
        "snapshotVolumeSize": 53687091200,
        "snapshotVolumeUseSize": 0,
        "snapshotVolumeUseRatio": 0.0
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

The following is an example output of queries made at 6h intervals. The average, maximum, and minimum usage for the measurement period are returned.

{
  "getNasVolumeInstanceRatingListResponse": {
    "totalRows": 2,
    "nasVolumeInstanceRatingList": [
      {
        "ratingTime": "2026-08-19 06:00:00.000",
        "averageVolumeSize": 483183820800,
        "averageVolumeUseSize": 401408,
        "averageVolumeUseRatio": 0.0,
        "maxVolumeUseSize": 401408,
        "maxVolumeUseRatio": 0.0,
        "minVolumeUseSize": 401408,
        "minVolumeUseRatio": 0.0,
        "snapshotAverageVolumeSize": 53687091200,
        "snapshotAverageVolumeUseSize": 0,
        "snapshotMaxVolumeUseSize": 0,
        "snapshotMaxVolumeUseRatio": 0.0,
        "snapshotMinVolumeUseSize": 0,
        "snapshotMinVolumeUseRatio": 0.0
      },
      {
        "ratingTime": "2026-08-19 12:00:00.000",
        "averageVolumeSize": 483183820800,
        "averageVolumeUseSize": 481776,
        "averageVolumeUseRatio": 0.0,
        "maxVolumeUseSize": 499712,
        "maxVolumeUseRatio": 0.0,
        "minVolumeUseSize": 409600,
        "minVolumeUseRatio": 0.0,
        "snapshotAverageVolumeSize": 53687091200,
        "snapshotAverageVolumeUseSize": 0,
        "snapshotMaxVolumeUseSize": 0,
        "snapshotMaxVolumeUseRatio": 0.0,
        "snapshotMinVolumeUseSize": 0,
        "snapshotMinVolumeUseRatio": 0.0
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}