MENU
      createNasVolumeInstance

        createNasVolumeInstance


        Article summary

        Available in VPC

        Create a NAS volume instance.

        Requests

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

        MethodURI
        GET, POST/createNasVolumeInstance

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        regionCodeStringOptionalRegion code where the NAS volume instance will be created
        zoneCodeStringOptionalZone code where the NAS volume instance will be created
        volumeAllotmentProtocolTypeCodeStringRequiredVolume 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
        volumeSizeIntegerRequiredVolume size
        • 500 - 10,000
        • Enter in increments of 100 GB
        volumeNameStringOptionalNAS 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.serverInstanceNoStringConditionalNumber of server instance to set with access control
        accessControlRuleList.N.writeAccessBooleanOptionalSet writing permissions
        • true (default) | false
          • true: set
          • false: not set
        cifsUserNameStringConditionalCIFS 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
        cifsUserPasswordStringConditionalCIFS 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
        isEncryptedVolumeBooleanOptionalSet 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
        isReturnProtectionBooleanOptionalSet termination protection
        • true | false (default)
          • true: set
          • false: not set
        nasVolumeDescriptionStringOptionalDescription of the volume (bytes)
        • 0 - 1000
        isAsyncBooleanOptionalSet async
        • true | false (default)
          • true: set
          • false: not set
        responseFormatTypeStringOptionalFormat 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}'
        Curl

        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"
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.