createNasVolumeInstance

Prev Next

Available in VPC

Create a NAS volume instance.

Requests

The following describes the request format for the endpoint. The request format is as follows.

Method URI
GET, POST /createNasVolumeInstance

Request headers

For headers common to all NAS APIs, see NAS common headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code where the NAS volume instance will be created
zoneCode String Optional Zone code where the NAS volume instance will be created
volumeAllotmentProtocolTypeCode String Required Volume allocation protocol type code
  • NFS | CIFS
    • NFS: It can be mounted on Linux servers such as CentOS and Ubuntu
    • CIFS: It can be mounted on Windows Servers
volumeSize Integer Required Volume size
  • 500 - 10,000
  • Enter in increments of 100 GB
volumeName String Optional NAS volume name
  • 3 to 20 characters; only English letter and numbers can be entered
  • It is granted automatically if not entered
  • Entered name is prefixed with "nMemberID_"for customer identification
accessControlRuleList.N.serverInstanceNo String Conditional Number of server instance to set with access control
accessControlRuleList.N.writeAccess Boolean Optional Set writing permissions
  • true (default) | false
    • true: set
    • false: not set
cifsUserName String Conditional CIFS username
  • Required when creating a CIFS-type volume for the first time
  • It can't be changed after setup
  • Enter 6 to 19 characters with a combination of English letters and numbers
cifsUserPassword String Conditional CIFS user password
  • Required when creating a CIFS-type volume for the first time
  • Enter 8 to 14 characters with a combination of letters, numbers, and special characters (!@^&*)
  • Passwords similar to the CIFS username are not allowed
isEncryptedVolume Boolean Optional Set NAS volume encryption
  • Apply encryption by NAS volume
  • Applicable only when creating a NAS volume for the first time
  • true | false (default)
    • true: set
    • false: not set
isReturnProtection Boolean Optional Set termination protection
  • true | false (default)
    • true: set
    • false: not set
nasVolumeDescription String Optional Description of the volume (bytes)
  • 0 - 1000
isAsync Boolean Optional Set async
  • true | false (default)
    • true: set
    • false: not set
responseFormatType String Optional Format type of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/createNasVolumeInstance?regionCode=KR&zoneCode=KR-2&volumeName=volume00&volumeAllotmentProtocolTypeCode=CIFS&volumeSize=500&accessControlRuleList.1.serverInstanceNo=23430000&accessControlRuleList.1.writeAccess=true&cifsUserName=user******&cifsUserPassword=************&isEncryptedVolume=true&isReturnProtection=true&nasVolumeDescription=test&isAsync=true&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Responses

The following describes the response format.

Response body

See NasVolumeInstanceList for the response body.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

{
    "createNasVolumeInstanceResponse": {
        "totalRows": 1,
        "nasVolumeInstanceList": [
            {
                "nasVolumeInstanceNo": "23490000",
                "nasVolumeInstanceStatus": {
                    "code": "INIT",
                    "codeName": "NAS INIT state"
                },
                "nasVolumeInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "NAS CREAT OP"
                },
                "nasVolumeInstanceStatusName": "creating",
                "createDate": "2024-04-08T09:04:28+0900",
                "nasVolumeDescription": "test",
                "mountInformation": "\\\\169.254.00.00\\n2768364_volume00",
                "volumeAllotmentProtocolType": {
                    "code": "CIFS",
                    "codeName": "CIFS"
                },
                "volumeName": "n2768364_volume00",
                "volumeTotalSize": 536870912000,
                "volumeSize": 536870912000,
                "snapshotVolumeConfigurationRatio": 0.0,
                "snapshotVolumeSize": 0,
                "isSnapshotConfiguration": false,
                "isEventConfiguration": false,
                "regionCode": "KR",
                "zoneCode": "KR-2",
                "nasVolumeServerInstanceNoList": [
                    "23430000"
                ],
                "isEncryptedVolume": true,
                "nasVolumeInstanceCustomIpList": [],
                "isReturnProtection": true
            }
        ],
        "requestId": "",
        "returnCode": "0",
        "returnMessage": "success"
    }
}