createNasVolumeInstance

Prev Next

Can be used in a Classic environment.

Overview

Creates a NAS volume instance.

Description

Creates a NAS volume instance.

Request parameter

Parameter name Requirement status Type Restrictions Description
volumeName Yes String - Name of the NAS volume to create
You can add additional NAS volume name behind the already entered NAS volume name for customer identification, from 3 to 20 characters.
volumeSize Yes String 500 GB or more, 10,000 GB or less - NAS volume size
The default capacity of a volume ranges from 500 GB to 10,000 GB. Additions can be made in units of 100 GB.
volumeAllotmentProtocolTypeCode Yes String Min: 1, Max: 5 - Volume assignment protocol type code
NFS | CIFS
NFS: can be mounted on Linux servers such as CentOS and Ubuntu
CIFS: can be mounted on Windows Servers
accessControlRuleList.N.serverInstanceNo No String It can't be duplicated. - Server instance number
You can obtain serverInstanceNo through the getServerInstanceList action.
Only instance numbers of the servers owned by the user can be entered.
Enter either serverInstanceNo or customIp, not both, for a single rule.
accessControlRuleList.N.customIp No String It can't be duplicated. - Custom IP
You can obtain customIp through the getServerInstanceList action.
Only private IPs can be set. Public IPs can't be set.
Enter either serverInstanceNo or customIp, not both, for a single rule.
accessControlRuleList.N.writeAccess No Boolean - Whether writing permission is allowed
Options: true | false
Default: true
cifsUserName Conditional String - CIFS user name
Enter the mount access ID, 6 to 19 characters in length, with a combination of English letters and numbers.
cifsUserPassword Conditional String - CIFS user password
Enter the mount access password, 8 to 14 characters in length, with a combination of two or more English letters, numbers, and special characters.
nasVolumeDescription No String Min: 1, Max: 1,000 NAS volume description
regionNo No String Min: 1, Max: 5 You can obtain the status where input is possible through the getRegionList action.
Default: KR region
zoneNo No String You can determine the zone in which the NAS volume is created.
You can obtain it through the getZoneList action
Default: Selects the first zone of the region.
isReturnProtection No Boolean - Termination protection status
You can set the server termination protection status.
Options: true | false
Default: false
isAsync No Boolean - Async status
Options: true | false
Default: false

Response data type

  • NasVolumeInstanceList type
NasVolumeInstanceList extends CommonResponse
private Integer totalRows;
private List<NasVolumeInstance> nasVolumeInstanceList = new ArrayList<NasVolumeInstance>();
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<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList = new ArrayList<NasVolumeInstanceCustomIp>();
private List<ServerInstance> nasVolumeServerInstanceList = new ArrayList<ServerInstance>();

Examples

Call 

ncloud server createNasVolumeInstance --volumeName penguin --volumeSize 500 --volumeAllotmentProtocolTypeCode NFS

Response 

{
  "createNasVolumeInstanceResponse": {
    "requestId": "015ac4b1-23b4-4cb2-beb1-b242027894fb",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "nasVolumeInstanceList": [
      {
        "nasVolumeInstanceNo": "***7631",
        "nasVolumeInstanceStatus": {
          "code": "CREAT",
          "codeName": "NAS create"
        },
        "nasVolumeInstanceOperation": {
          "code": "NULL",
          "codeName": "NAS NULL OP"
        },
        "nasVolumeInstanceStatusName": "created",
        "createDate": "2018-02-26T09:13:01+0000",
        "nasVolumeInstanceDescription": "",
        "mountInformation": "***.***.84.81:/n***212_penguin",
        "volumeAllotmentProtocolType": {
          "code": "NFS",
          "codeName": "NFS"
        },
        "volumeName": "n***212_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",
          "zoneDescription": "KR-1 zone"
        },
        "isReturnProtection": false,
        "nasVolumeInstanceCustomIpList": [],
        "nasVolumeServerInstanceList": []
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<createNasVolumeInstanceResponse>
  <requestId>015ac4b1-23b4-4cb2-beb1-b242027894fb</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstanceNo>***7631</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>***.***.84.81:/n***212_penguin</mountInformation>
    <volumeAllotmentProtocolType>
      <code>NFS</code>
      <codeName>NFS</codeName>
    </volumeAllotmentProtocolType>
    <volumeName>n***212_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>
      <zoneDescription>KR-1 zone</zoneDescription>
    </zone>
    <isReturnProtection>false</isReturnProtection>
    <nasVolumeInstanceCustomIpList/>
    <nasVolumeServerInstanceList/>
  </nasVolumeInstanceList>
</createNasVolumeInstanceResponse>