getNasVolumeInstanceRatingList
    • PDF

    getNasVolumeInstanceRatingList

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Overview

    Gets the list of NAS volume size measurements during a certain period.
    It is only available in the KR (Korea) region. Please use Cloud Insight API in other regions.

    Request

    Request parameter

    Parameter nameRequirement statusTypeRestrictionsDescription
    regionCodeNoString- Region code
    Determines the region of the NAS volume instance to get the size measurement list from.
    regionCode: It can be obtained through the getRegionList action.
    Default: Selects the first region of the getRegionList search results.
    nasVolumeInstanceNoYesString- Instance number of NAS volume to get the size measurement list from
    nasVolumeInstanceNo: It can be obtained through the getNasVolumeInstanceList action.
    startTimeYesStringFormat: yyyy-MM-dd'T'HH:mm:ssZ- Measurement start date and time
    URL encoding is required if the GET method is used.
    ex) 2021-09-16T00:00:00+0900
    endTimeYesStringFormat: yyyy-MM-dd'T'HH:mm:ssZ- Measurement end date and time
    URL encoding is required if the GET method is used.
    ex) 2021-09-18T23:59:59+0900
    intervalYesString- Measuring interval
    Options: 5m (5 minutes) | 6h (6 hours) | 1d (1 day) | 1M (1 month)
    The maximum period that can be searched (startTime to endTime) is limited, depending on the measuring interval.
    5m: up to 3 days
    6h: up to 1 month
    1d: up to 2 years
    1M: up to 5 years

    Response

    Response data type

    • NasVolumeInstanceRatingList type
    NasVolumeInstanceRatingList extends CommonResponse
    private Integer totalRows;
    private List<NasVolumeInstanceRating> nasVolumeInstanceRatingList = new ArrayList<>();
    NasVolumeInstanceRating
    private String ratingTime;
    private Long volumeSize;
    private Long volumeUseSize;
    private Float volumeUseRatio;
    private Long averageVolumeSize;
    private Long averageVolumeUseSize;
    private Float averageVolumeUseRatio;
    private Long maxVolumeUseSize;
    private Float maxVolumeUseRatio;
    private Long minVolumeUseSize;
    private Float minVolumeUseRatio;
    private Long snapshotVolumeSize;
    private Long snapshotVolumeUseSize;
    private Float snapshotVolumeUseRatio;
    private Long snapshotAverageVolumeSize;
    private Long snapshotAverageVolumeUseSize;
    private Float snapshotAverageVolumeUseRatio;
    private Long snapshotMaxVolumeUseSize;
    private Float snapshotMaxVolumeUseRatio;
    private Long snapshotMinVolumeUseSize;
    private Float snapshotMinVolumeUseRatio;

    Examples

    Request examples

    ncloud vnas getNasVolumeInstanceRatingList --regionCode KR --nasVolumeInstanceNo ***3901 --startTime "2021-09-16T00:00:00+0900" --endTime "2021-09-16T00:05:00+0900" --interval 5m
    

    Response examples

    <getNasVolumeInstanceRatingListResponse>
      <requestId>ae80e33f-1414-4e54-b087-bad054f25cf2</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <nasVolumeInstanceRatingList>
        <nasVolumeInstanceRating>
          <ratingTime>2021-09-16 00:00:18.535</ratingTime>
          <volumeSize>10737418240</volumeSize>
          <volumeUseSize>458752</volumeUseSize>
          <volumeUseRatio>0.0</volumeUseRatio>
          <snapshotVolumeSize>0</snapshotVolumeSize>
          <snapshotVolumeUseSize>0</snapshotVolumeUseSize>
          <snapshotVolumeUseRatio>0.0</snapshotVolumeUseRatio>
        </nasVolumeInstanceRating>
      </nasVolumeInstanceRatingList>
    </getNasVolumeInstanceRatingListResponse>
    

    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.