getNasVolumeInstanceList
    • PDF

    getNasVolumeInstanceList

    • PDF

    Article Summary

    Can be used in a VPC environment.

    Overview

    It searches a list of NAS volume instances.

    Request

    Request parameters

    Parameter nameRequiredTypeRestrictionsDescription
    regionCodeNoStringRegion code
    You can decide the region in which the list of NAS volume instances will be queried.
    regionCode can be obtained through the getRegionList action.
    Default: Select the first region of the getRegionList search results
    zoneCodeNoStringZone code
    You can decide the zone in which the list of NAS volume instances will be queried.
    The zoneCode can be obtained through the getZoneList action.
    nasVolumeInstanceNoList.NNoList<String>List of NAS volume instance numbers
    You can search by filtering with a NAS volume instance number.
    nasVolumeInstanceNo can be obtained through the getNasVolumeInstanceList action.
    ex) nasVolumeInstanceNoList.1=1234&nasVolumeInstanceNoList.2=2345
    volumeNameNoStringVolume name
    You can search by filtering with a NAS volume name.
    volumeAllotmentProtocolTypeCodeNoStringVolume allotment protocol type code
    You can search by filtering with a volume allotment protocol type code.
    Options: NFS (It can be mounted in a Linux server such as CentOS and Ubuntu.) | CIFS (It can be mounted in a Windows server.)
    isEventConfigurationNoBooleanEvent setting status
    You can search by filtering with an event setting status.
    Options : true | false
    isSnapshotConfigurationNoBooleanSnapshot setting status
    You can search by filtering with a snapshot setting status.
    Options : true | false
    pageNoNoIntegerPage number of the paged results
    The results can be paged using pageNo and pageSize.
    pageSizeConditionalIntegerEach page size to be displayed when paging
    The results can be paged using pageNo and pageSize.
    It must be entered when entering pageNo.
    sortedByNoStringSort target
    The results can be sorted by NAS volume instance number, volume name, and total volume size.
    Options : nasVolumeInstanceNo | volumeName | volumeTotalSize
    sortingOrderNoStringSorting order
    When using sortedBy, sort in ascending/descending order.
    Options: ASC (ascending order) | DESC (descending order)
    Default : ASC
    responseFormatTypeNoStringFormat type of the response results
    Options : xml | json
    Default : xml

    Response

    Response body

    Example

    Request Example

    GET {API_URL}/vnas/v2/getNasVolumeInstanceList
    ?regionCode=KR
    &zoneCode=KR-1
    &nasVolumeInstanceNoList.1=***3901
    &volumeName=n***4567_test***
    &volumeAllotmentProtocolTypeCode=NFS
    &isEventConfiguration=false
    &isSnapshotConfiguration=false
    

    Response Example

    <getNasVolumeInstanceListResponse>
      <requestId>988048d6-30c6-4783-b2c9-bd2436d0db93</requestId>
      <returnCode>0</returnCode>
      <returnMessage>success</returnMessage>
      <totalRows>1</totalRows>
      <nasVolumeInstanceList>
        <nasVolumeInstance>
          <nasVolumeInstanceNo>***3901</nasVolumeInstanceNo>
          <nasVolumeInstanceStatus>
            <code>CREAT</code>
            <codeName>NAS create</codeName>
          </nasVolumeInstanceStatus>
          <nasVolumeInstanceOperation>
            <code>NULL</code>
            <codeName>NAS NULL OP</codeName>
          </nasVolumeInstanceOperation>
          <nasVolumeInstanceStatusName></nasVolumeInstanceStatusName>
          <createDate>1970-01-01T09:00:02+0900</createDate>
          <nasVolumeDescription></nasVolumeDescription>
          <mountInformation>***.***.0.20:/n***4567_test***</mountInformation>
          <volumeAllotmentProtocolType>
            <code>NFS</code>
            <codeName>NFS</codeName>
          </volumeAllotmentProtocolType>
          <volumeName>n***4567_test***</volumeName>
          <volumeTotalSize>536870912000</volumeTotalSize>
          <volumeSize>536870912000</volumeSize>
          <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
          <snapshotVolumeConfigTime>0</snapshotVolumeConfigTime>
          <snapshotVolumeSize>0</snapshotVolumeSize>
          <isSnapshotConfiguration>false</isSnapshotConfiguration>
          <isEventConfiguration>false</isEventConfiguration>
          <regionCode>KR</regionCode>
          <zoneCode>KR-1</zoneCode>
          <nasVolumeServerInstanceNoList/>
          <isEncryptedVolume>false</isEncryptedVolume>
          <nasVolumeInstanceCustomIpList/>
          <isReturnProtection>false</isReturnProtection>
        </nasVolumeInstance>
      </nasVolumeInstanceList>
    </getNasVolumeInstanceListResponse>
    

    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.