getNasVolumeInstanceList
- 인쇄
- PDF
getNasVolumeInstanceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
NAS 볼륨 인스턴스 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET, POST | /getNasVolumeInstanceList |
요청 헤더
NAS API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 NAS 공통 헤더를 참조해 주십시오.
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
regionCode | String | Optional | 리전 코드
|
zoneCode | String | Optional | 존 코드
|
nasVolumeInstanceNoList.N | List<String> | Optional | NAS 볼륨 인스턴스 번호 목록
|
volumeName | String | Optional | NAS 볼륨 이름 |
volumeAllotmentProtocolTypeCode | String | Optional | NAS 볼륨 할당 프로토콜 유형 코드
|
isEventConfiguration | Boolean | Optional | 이벤트 설정 여부
|
isSnapshotConfiguration | Boolean | Optional | 스냅샷 설정 여부
|
pageNo | Integer | Optional | 페이징된 결과의 페이지 번호
|
pageSize | Integer | Conditional | 페이징 시 보여줄 각 페이지 크기
|
sortedBy | String | Optional | 정렬 대상
|
sortingOrder | String | Optional | 정렬 순서
|
responseFormatType | String | Optional | 응답 결과의 포맷 유형
|
요청 예시
요청 예시는 다음과 같습니다.
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"
}
}
이 문서가 도움이 되었습니까?