getNasVolumeInstanceList
    • PDF

    getNasVolumeInstanceList

    • PDF

    Article Summary

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

    NAS 볼륨 인스턴스 목록을 조회합니다.

    요청

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

    메서드URI
    GET, POST/getNasVolumeInstanceList

    요청 헤더

    NAS API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 NAS 공통 헤더를 참조해 주십시오.

    요청 쿼리 파라미터

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

    필드타입필수 여부설명
    regionCodeStringOptional리전 코드
    zoneCodeStringOptional존 코드
    nasVolumeInstanceNoList.NList<String>OptionalNAS 볼륨 인스턴스 번호 목록
    • 콘솔 또는 getNasVolumeInstanceList 액션을 통해 확인
    • <예시> nasVolumeInstanceNoList.1=1234&nasVolumeInstanceNoList.2=2345
    volumeNameStringOptionalNAS 볼륨 이름
    volumeAllotmentProtocolTypeCodeStringOptionalNAS 볼륨 할당 프로토콜 유형 코드
    • NFS | CIFS
      • NFS: CentOS, Ubuntu 등 리눅스 서버에서 마운트 가능
      • CIFS: Windows 서버에서 마운트 가능
    isEventConfigurationBooleanOptional이벤트 설정 여부
    • true | false
      • true: 설정
      • false: 설정 안 함
    isSnapshotConfigurationBooleanOptional스냅샷 설정 여부
    • true | false
      • true: 설정
      • false: 설정 안 함
    pageNoIntegerOptional페이징된 결과의 페이지 번호
    • pageNo, pageSize를 이용하여 결과 값을 페이징 처리
    pageSizeIntegerConditional페이징 시 보여줄 각 페이지 크기
    • pageNo 입력 시 필수
    • pageNo, pageSize를 이용하여 결과 값을 페이징 처리
    sortedByStringOptional정렬 대상
    • nasVolumeInstanceNo | volumeName | volumeTotalSize
      • nasVolumeInstanceNo: NAS 볼륨 인스턴스 번호
      • volumeName: 볼륨 이름
      • volumeTotalSize: 볼륨 총 크기
    sortingOrderStringOptional정렬 순서
    • ASC (기본값) | DESC
      • ASC: 오름차순
      • DESC: 내림차순
    responseFormatTypeStringOptional응답 결과의 포맷 유형
    • xml (기본값) | json

    요청 예시

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

    curl --location --request GET 'https://ncloud.apigw.ntruss.com/vnas/v2/getNasVolumeInstanceList?regionCode=KR&zoneCode=KR-2&isEventConfiguration=false&isSnapshotConfiguration=false&pageNo=1&pageSize=2&sortedBy=nasVolumeInstanceNo&sortingOrder=ASC&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}'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    응답 상태 코드

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

    응답 예시

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

    {
        "getNasVolumeInstanceListResponse": {
            "totalRows": 1,
            "nasVolumeInstanceList": [
                {
                    "nasVolumeInstanceNo": "23380000",
                    "nasVolumeInstanceStatus": {
                        "code": "CREAT",
                        "codeName": "NAS create"
                    },
                    "nasVolumeInstanceOperation": {
                        "code": "NULL",
                        "codeName": "NAS NULL OP"
                    },
                    "nasVolumeInstanceStatusName": "created",
                    "createDate": "2024-04-02T10:06:29+0900",
                    "nasVolumeDescription": "",
                    "mountInformation": "169.254.00.00:/n2768364_vn18e9c000000",
                    "volumeAllotmentProtocolType": {
                        "code": "NFS",
                        "codeName": "NFS"
                    },
                    "volumeName": "n2768364_vn18e9c000000",
                    "volumeTotalSize": 644245094400,
                    "volumeSize": 644245094400,
                    "snapshotVolumeConfigurationRatio": 0.0,
                    "snapshotVolumeSize": 0,
                    "isSnapshotConfiguration": false,
                    "isEventConfiguration": false,
                    "regionCode": "KR",
                    "zoneCode": "KR-2",
                    "nasVolumeServerInstanceNoList": [
                        "23320000"
                    ],
                    "isEncryptedVolume": false,
                    "nasVolumeInstanceCustomIpList": [],
                    "isReturnProtection": false
                }
            ],
            "requestId": "",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    

    이 문서가 도움이 되었습니까?

    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.