createNasVolumeInstance

Prev Next

Classic 환경에서 이용 가능합니다.

NAS 볼륨 인스턴스를 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET | POST /server/v2/createNasVolumeInstance
참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

NAS API에서 공통으로 사용하는 헤더에 대한 정보는 NAS 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
volumeName String Required NAS 볼륨 이름
  • 3~20자로 영문자, 숫자만 허용
  • 미입력 시 자동 부여
  • 고객 식별을 위해 입력한 이름 앞에 'n회원번호_'가 붙음
volumeSize Long Required 볼륨 크기볼륨 크기
  • 500~ 20,000
  • 100 GB 단위로 입력
volumeAllotmentProtocolTypeCode String Required 볼륨 할당 프로토콜 유형 코드
  • NFS | CIFS
    • NFS: CentOS, Ubuntu 등 리눅스 서버에서 마운트 가능
    • CIFS: Windows 서버에서 마운트 가능
accessControlRuleList.N.serverInstanceNo String Conditional 접근 제어로 설정할 서버 인스턴스 번호
  • getServerInstanceList 참조
  • 하나의 규칙에 serverInstanceNo 또는 customIp 중 하나만 입력 가능
  • accessControlRuleList.N.writeAccess 입력 시 serverInstanceNo 또는 customIp 필수 입력
accessControlRuleList.N.customIp String Conditional 접근 제어로 설정할 커스텀 IP
  • getServerInstanceList 참조
  • 공인 IP는 설정할 수 없으며, 사설 IP만 설정 가능
  • 하나의 규칙에 serverInstanceNo 또는 customIp 중 하나만 입력 가능
  • accessControlRuleList.N.writeAccess 입력 시 serverInstanceNo 또는 customIp 필수 입력
accessControlRuleList.N.writeAccess Boolean Optional 쓰기 권한 설정
  • true (기본값) | false
    • true: 설정
    • false: 설정 안 함
cifsUserName String Conditional CIFS 사용자 이름
  • CIFS 유형의 볼륨을 최초로 생성하는 경우 필수 입력
  • 설정 후 변경 불가
  • 영문자, 숫자를 조합하여 6~19자 이내로 입력
cifsUserPassword String Conditional CIFS 사용자 비밀번호
  • CIFS 유형의 볼륨을 최초로 생성하는 경우 필수 입력
  • 영문자, 숫자, 특수 문자 '!', '@', '^', '&', '*'를 조합하여 8~14자 이내로 입력
  • CIFS 사용자 이름과 유사한 비밀번호 사용 불가
nasVolumeDescription String Optional 볼륨에 대한 설명 (Byte)
  • 0~1000
regionNo String Optional NAS 볼륨 인스턴스가 생성될 리전 번호
zoneNo String Optional NAS 볼륨 인스턴스가 생성될 존 번호
isReturnProtection Boolean Optional 반납 보호 설정
  • true | false (기본값)
    • true: 설정
    • false: 설정 안 함
isAsync Boolean Optional Async 설정
  • true | false (기본값)
    • true: 설정
    • false: 설정 안 함

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/server/v2/createNasVolumeInstance
?volumeName=volume05
&volumeSize=500
&volumeAllotmentProtocolTypeCode=CIFS
&accessControlRuleList.1.serverInstanceNo=23500000
&accessControlRuleList.1.writeAccess=true
&cifsUserName=user******
&cifsUserPassword=*********
&nasVolumeDescription=test
&regionNo=1
&zoneNo=3
&isReturnProtection=false
&isAsync=true' \
--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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 NasVolumeInstance를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "createNasVolumeInstanceResponse": {
        "totalRows": 1,
        "nasVolumeInstanceList": [
            {
                "nasVolumeInstanceNo": "23500000",
                "nasVolumeInstanceStatus": {
                    "code": "INIT",
                    "codeName": "NAS INIT state"
                },
                "nasVolumeInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "NAS CREAT OP"
                },
                "nasVolumeInstanceStatusName": "creating",
                "createDate": "2024-04-08T11:40:50+0900",
                "nasVolumeDescription": "test",
                "mountInformation": "\\\\10.250.00.00\\n2768364_volume05",
                "volumeAllotmentProtocolType": {
                    "code": "CIFS",
                    "codeName": "CIFS"
                },
                "volumeName": "n2768364_volume05",
                "volumeTotalSize": 536870912000,
                "volumeSize": 536870912000,
                "snapshotVolumeConfigurationRatio": 0.0,
                "snapshotVolumeSize": 0,
                "isSnapshotConfiguration": false,
                "isEventConfiguration": false,
                "region": {
                    "regionNo": "1",
                    "regionCode": "KR",
                    "regionName": "Korea"
                },
                "zone": {
                    "zoneNo": "3",
                    "zoneName": "KR-2",
                    "zoneCode": "KR-2",
                    "zoneDescription": "평촌 zone",
                    "regionNo": "1"
                },
                "isReturnProtection": false,
                "nasVolumeInstanceCustomIpList": [],
                "nasVolumeServerInstanceList": []
            }
        ],
        "requestId": "",
        "returnCode": "0",
        "returnMessage": "success"
    }
}