createNasVolumeInstance

Article Summary

Share feedback

Thanks for sharing your feedback!

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Can be used in a Classic environment.

Overview

Create NAS volume instances.

Request

Request parameter

Parameter name	Requirement status	Type	Restrictions	Description
volumeName	Yes	String		- Name of the NAS volume to be created Enter the NAS volume name of 3 - 20 characters at the end of the NAS identification code given by NAVER Cloud Platform for customer identification
volumeSize	Yes	Long	500 GB to 10,000 GB	- 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 allotment protocol type code Options : NFS \| CIFS NFS: It can be mounted on Linux servers such as CentOS and Ubuntu. CIFS: It can be mounted on Windows Server.
accessControlRuleList.N.serverInstanceNo	No	String	Not to 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	Not to 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 If volume allotment protocol type code (volumeAllotmentProtocolTypeCode) is CIFS, the user name and password are required. Enter the mount access ID, 6 to 19 characters in length, as a combination of English letters and numbers.
cifsUserPassword	Conditional	String		- CIFS user password If volume allotment protocol type code (volumeAllotmentProtocolTypeCode) is CIFS, the user name and password are required. Enter the mount access password, 8 to 14 characters in length, as a combination of two or more English letters, numbers, and special characters.
nasVolumeDescription	No	String	Min : 1, Max : 1000	NAS volume description
regionNo	No	String	Min : 1, Max : 5	- Region number If you search by getting the region number, filtering is only available with that region. You can obtain the region number through the getRegionList action. default : 1 (KR) ex) regionNo=10
zoneNo	No	String		- Zone number It determines the zone where the NAS volume will be created. You can obtain the status where input is possible through the getZoneList action. Default: Select the first zone of the region.
isReturnProtection	No	Boolean		- Termination protection status It sets termination protection status. Options : true \| false Default : false
isAsync	No	Boolean		- Async status Options : true \| false Default : false

Response

Response body

NasVolumeInstance

Examples

Request examples

GET {SERVER_API_URL}/createNasVolumeInstance
?volumeName=testnas&volumeSize=500
&volumeAllotmentProtocolTypeCode=NFS

Response examples

<createNasVolumeInstanceResponse>
  <requestId>270e693b-b265-4345-8f23-0476e82f141f</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <nasVolumeInstanceList>
    <nasVolumeInstance>
      <nasVolumeInstanceNo>***4361</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-11-26T19:40:14+0900</createDate>
      <nasVolumeDescription></nasVolumeDescription>
      <mountInformation>***.***.53.74:/n***2613_testnas</mountInformation>
      <volumeAllotmentProtocolType>
        <code>NFS</code>
        <codeName>NFS</codeName>
      </volumeAllotmentProtocolType>
      <volumeName>n***2613_testnas</volumeName>
      <volumeTotalSize>536870912000</volumeTotalSize>
      <volumeSize>536870912000</volumeSize>
      <snapshotVolumeConfigurationRatio>0.0</snapshotVolumeConfigurationRatio>
      <snapshotVolumeSize>0</snapshotVolumeSize>
      <isSnapshotConfiguration>false</isSnapshotConfiguration>
      <isEventConfiguration>false</isEventConfiguration>
      <region>
        <regionNo>1</regionNo>
        <regionCode>KR</regionCode>
        <regionName>Korea</regionName>
      </region>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>Pyeongchon zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
      <isReturnProtection>false</isReturnProtection>
      <nasVolumeInstanceCustomIpList/>
      <nasVolumeServerInstanceList/>
    </nasVolumeInstance>
  </nasVolumeInstanceList>
</createNasVolumeInstanceResponse>

Error codes

Errors that may occur while using this action are listed below. For more information about common errors, please refer to NAVER Cloud Platform API.

HTTP Response Code	Return code	Return message
400	24138	The server information for setting up NFS is invalid.
400	24139	The {0} account you entered is already a CIFS account that is in use elsewhere.
400	24140	Created CIFS account and entered CIFS account do not match.
400	24141	Password must consist of 8 to 14 characters, a combination of English letters, numbers, and special characters (allow only! @$ % % ^ & *).
400	24142	{0} volume name entered is already another name in use.
400	24143	CIFS account is already registered
400	24144	CIFS account does not exist
400	24145	ACL setup is not available for CIFS volumes.
400	24146	The snapshot setting percentage information is invalid.
400	24147	The snapshot setup time information is invalid.
400	24148	Snapshot settings are already turned off.
400	24149	Snapshot immediate creation is not available because snapshot is not set.
400	24150	Snapshot immediate creation is not available due to a 0 % snapshot setup.
400	24151	No snapshot found with {0} name.
400	24152	{0} IP is already entered.
400	24153	{0} IP is Loopback IP.
400	24154	{0} IP is public IP.
400	24155	Please check the IP {0}.

Was this article helpful?

What's Next

deleteNasVolumeInstance

Table of contents

Overview
Request
Response
Examples
Error codes