getNasVolumeInstanceList

Prev Next

Overview

Searching NAS volume instance list

Description

Search NAS volume instance lists.

Request Parameters

Parameter Name Requiredness Type Limitation Description
volumeAllotmentProtocolTypeCode No String Min : 1, Max : 5 Volume assignment protocol type code
NFS | CIFS
All will be selected if you do not configure filters.
isEventConfiguration No Boolean Event configuration Y/N
true | false
All will be selected if you do not configure filters.
isSnapshotConfiguration No Boolean Sanapshot volume configuration Y/N
true | false
All will be selected if you do not configure filters.
nasVolumeInstanceNoList No List Nas Volume instance Vo. List
All will be selected if you do not configure filters.
regionNo No String You can reach a state in which inout is possible by calling getRegionList.
Default : KR region
zoneNo No String You can get Nas Volume instnace if you configure filters of Zone No.
All will be selected if you do not configure filters.

Response Data Type

  • NasVolumeInstanceList type
NasVolumeInstanceList extends CommonResponse
private int totalRows;
private List nasVolumeInstanceList = new ArrayList();
NasVolumeInstance
private String nasVolumeInstanceNo;
private CommonCode nasVolumeInstanceStatus;
private CommonCode nasVolumeInstanceOperation;
private String nasVolumeInstanceStatusName;
private Date createDate;
private String nasVolumeInstanceDescription;
private String mountInformation;
private CommonCode volumeAllotmentProtocolType;
private String volumeName;
private long volumeTotalSize;
private long volumeSize;
private float snapshotVolumeConfigurationRatio;
private CommonCode snapshotVolumeConfigPeriodType;
private CommonCode snapshotVolumeConfigDayOfWeekType;
private Integer snapshotVolumeConfigTime;
private long snapshotVolumeSize;
private boolean isSnapshotConfiguration;
private boolean isEventConfiguration;
private Region region;
private Zone zone;
private Boolean isReturnProtection;
private List nasVolumeInstanceCustomIpList = new ArrayList();
private List nasVolumeServerInstanceList = new ArrayList();

Examples

Request

ncloud server getNasVolumeInstanceList --nasVolumeInstanceNoList 397631

Response

{
  "getNasVolumeInstanceListResponse": {
    "requestId": "3f14f2a9-6d32-409f-9065-d6fb0332eb01",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "397631",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS create"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2018-02-26T09:13:01+0000",
        "nasVolumeInstanceDescription": "",
        "mountInformation": "10.105.84.81:/n000212_penguin",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n000212_penguin",
        "volumeTotalSize": 536870912000,
        "volumeSize": 536870912000,
        "snapshotVolumeConfigurationRatio": 0.0,
        "snapshotVolumeSize": 0,
        "isSnapshotConfiguration": false,
        "isEventConfiguration": false,
        "region": {
          "regionNo": "1",
          "regionCode": "KR",
          "regionName": "Korea"
        },
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo" : "1"
        },
        "isReturnProtection": false,
        "nasVolumeInstanceCustomIpList": [],
        "nasVolumeServerInstanceList": []
      }
    ]
  }
}
<?xml version="1.0" encoding="UTF-8" ?>
<getNasVolumeInstanceListResponse>
  <requestId>3f14f2a9-6d32-409f-9065-d6fb0332eb01</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstanceNo>397631</nasVolumeInstanceNo>
    <nasVolumeInstanceStatus>
      <code>CREAT</code>
      <codeName>NAS create</codeName>
    </nasVolumeInstanceStatus>
    <nasVolumeInstanceOperation>
      <code>NULL</code>
      <codeName>NAS NULL OP</codeName>
    </nasVolumeInstanceOperation>
    <nasVolumeInstanceStatusName>created</nasVolumeInstanceStatusName>
    <createDate>2018-02-26T09:13:01+0000</createDate>
    <nasVolumeInstanceDescription></nasVolumeInstanceDescription>
    <mountInformation>10.105.84.81:/n000212_penguin</mountInformation>
    <volumeAllotmentProtocolType>
      <code>NFS</code>
      <codeName>NFS</codeName>
    </volumeAllotmentProtocolType>
    <volumeName>n000212_penguin</volumeName>
    <volumeTotalSize>536870912000</volumeTotalSize>
    <volumeSize>536870912000</volumeSize>
    <snapshotVolumeConfigurationRatio>0</snapshotVolumeConfigurationRatio>
    <snapshotVolumeSize>0</snapshotVolumeSize>
    <isSnapshotConfiguration>false</isSnapshotConfiguration>
    <isEventConfiguration>false</isEventConfiguration>
    <region>
      <regionNo>1</regionNo>
      <regionCode>KR</regionCode>
      <regionName>Korea</regionName>
    </region>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
    <isReturnProtection>false</isReturnProtection>
    <nasVolumeInstanceCustomIpList/>
    <nasVolumeServerInstanceList/>
  </nasVolumeInstanceList>
</getNasVolumeInstanceListResponse>