getNasVolumeInstanceRatingList

VPC環境で利用できます。

特定の期間の NASボリュームインスタンスのサイズを、設定した測定間隔で照会します。getNasVolumeInstanceRatingListは韓国(KR)リージョンでのみ利用可能です。他リージョンから NASボリュームインスタンス測定リストを照会するには、Cloud Insight APIをご参照ください。

構文

getNasVolumeInstanceRatingList構文は次の通りです。

./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>]

オプション

getNasVolumeInstanceRatingListの実行時に指定できるオプションについて説明します。

必須オプション

getNasVolumeInstanceRatingListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--nasVolumeInstanceNo`	String	Required	NASボリュームインスタンス番号 getNasVolumeInstanceListを参照
`--startTime`	String	Required	測定開始日時 yyyy-MM-dd'T'HH:mm:ssZ形式 (例: `2026-04-01T00:00:00+0900`)
`--endTime`	String	Required	測定終了日時 yyyy-MM-dd'T'HH:mm:ssZ形式 (例: `2026-04-01T23:59:59+0900`)
`--interval`	String	Required	測定間隔 `5m` \| `6h` \| `1d` \| `1M` `5m`: 5分 `6h`: 6時間 `1d`: 1日 `1M`: 1か月測定間隔に応じて最大照会期間(`startTime`~`endTime`)が制限 `5m`: 最大3日 `6h`: 最大1か月 `1d`: 最大2年 `1M`: 最大5年

共通オプション

vnasコマンドで共通して使用するオプションについては、NAS (VPC)のオプションをご参照ください。

例

NASボリューム測定リストの照会リクエストが成功すると、各測定時点のボリューム使用量情報とスナップショット使用量情報が返されます。返される項目はinterval値によって異なります。

コマンド

5m間隔で照会するコマンドの例は次の通りです。

./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

6h間隔で照会するコマンドの例は次の通りです。

./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

出力

5m間隔で照会した出力の例は次の通りです。測定時点のボリューム使用量が返されます。

{
  "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"
  }
}

6h間隔で照会した出力の例は次の通りです。測定期間の平均、最大、最小使用量が返されます。

{
  "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"
  }
}