createNasVolumeInstance
- Print
- PDF
createNasVolumeInstance
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Can be used in a VPC environment.
Overview
Creates NAS volume instances.
Request
Request parameter
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code Determines the region in which the NAS volume instance will be created. regionCode can be obtained through the getRegionList action. Default: Selects the first region of the getRegionList search results. | |
| zoneCode | No | String | - Zone code Determines the zone where the NAS volume instance will be created. zoneCode can be obtained through the getZoneList action. Default: Selects the first zone of the getZoneList search results. | |
| volumeName | No | String | Min : 3, Max : 20 Only English letters and numbers are allowed. | - Name of the NAS volume to be created Default: NAVER Cloud Platform automatically assigns it. "nmembernumber_" will automatically be added to the name as a prefix for customer identification. |
| volumeAllotmentProtocolTypeCode | Yes | String | - Volume assignment protocol type code Options: NFS (can be mounted on Linux servers such as CentOS and Ubuntu)| CIFS (can be mounted on Windows Servers) | |
| volumeSize | Yes | Integer | Min : 500, Max : 10000 GB Entered in 100 GB units. | Volume size |
| accessControlRuleList.N.serverInstanceNo | Conditional | String | - Instance number of server to be set with access control serverInstanceNo can be obtained through the getServerInstanceList action. | |
| accessControlRuleList.N.writeAccess | No | Boolean | - Whether writing permission is allowed Options : true | false Default : true | |
| cifsUserName | Conditional | String | Min : 6, Max : 19 Only English letters and numbers are allowed. | - CIFS user name When creating a volume with the volume assignment protocol type as CIFS for the first time, the authentication information must be set up. The authentication information can't be changed once configured. |
| cifsUserPassword | Conditional | String | Min : 8, Max : 14 Only English letters, numbers, and special characters (!@%^&*) are allowed. | - CIFS user password When creating a volume with the volume assignment protocol type as CIFS for the first time, the authentication information must be set up. |
| isEncryptedVolume | No | Boolean | - Volume encryption status Encryption is applied per volume, which can only be applied at the time of initial creation. Options : true | false Default : false | |
| isReturnProtection | No | Boolean | - Termination protection status Termination protection status can be set. Options : true | false Default : false | |
| nasVolumeDescription | No | String | Min : 0, Max : 1000 Bytes | Description of the NAS volume to be created |
| isAsync | No | Boolean | - Async status Options : true | false Default : false |
Response
Response data type
- NasVolumeInstanceList type
| NasVolumeInstanceList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<NasVolumeInstance> nasVolumeInstanceList = new ArrayList<>(); |
| NasVolumeInstance |
|---|
| private String nasVolumeInstanceNo; |
| private CommonCode nasVolumeInstanceStatus; |
| private CommonCode nasVolumeInstanceOperation; |
| private String nasVolumeInstanceStatusName; |
| private Date createDate; |
| private String nasVolumeDescription; |
| 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 String regionCode; |
| private String zoneCode; |
| private ServerInstanceNoList nasVolumeServerInstanceNoList; |
| private Boolean isEncryptedVolume; |
| private List<NasVolumeInstanceCustomIp> nasVolumeInstanceCustomIpList; |
| private Boolean isReturnProtection; |
| NasVolumeInstanceCustomIp |
|---|
| private String customIp; |
Examples
Request examples
ncloud vnas createNasVolumeInstance --regionCode KR --zoneCode KR-1 --volumeName test*** --volumeAllotmentProtocolTypeCode NFS --volumeSize 500 --isReturnProtection false
Response examples
<createNasVolumeInstanceResponse>
<requestId>0c607174-7674-419e-96f0-a5a0b15a4554</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>
<snapshotVolumeSize>0</snapshotVolumeSize>
<isSnapshotConfiguration>false</isSnapshotConfiguration>
<isEventConfiguration>false</isEventConfiguration>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<nasVolumeServerInstanceNoList/>
<isEncryptedVolume>false</isEncryptedVolume>
<nasVolumeInstanceCustomIpList>
<nasVolumeInstanceCustomIp>
<customIp>10.0.0.1</customIp>
</nasVolumeInstanceCustomIp>
</nasVolumeInstanceCustomIpList>
<isReturnProtection>false</isReturnProtection>
</nasVolumeInstance>
</nasVolumeInstanceList>
</createNasVolumeInstanceResponse>
Was this article helpful?