Skip to content

볼륨 목록 조회

HTTP 요청

http
GET https://<your-console-host>/api/v1/compute/storage/volumes

URI 매개변수

없습니다.

쿼리 매개변수

이름필수형식설명
sort선택string정렬 필드. 값: volumeName, volumeId, projectName, availabilityZone, volumeType, size, createdAt, attachedInstanceName, description
order선택string정렬 방향. 값: asc, desc
prioritizeAvailable선택booleanavailable 상태 볼륨 우선 정렬. 기본값 false
volumeName선택array (string)볼륨 이름 필터 (부분 일치, 다중 값 OR)
volumeId선택array (string)볼륨 ID 필터 (부분 일치, 다중 값 OR)
availabilityZone선택array (string)가용영역 필터 (부분 일치, 다중 값 OR)
description선택array (string)설명 필터 (부분 일치, 다중 값 OR)
volumeType선택array (string)볼륨 타입 필터 (부분 일치, 다중 값 OR)
attachedInstanceId선택array (string)연결된 인스턴스 ID 필터 (부분 일치, 다중 값 OR)
attachedInstanceName선택array (string)연결된 인스턴스 이름 필터 (부분 일치, 다중 값 OR)
status선택array (string)상태 필터 (전체 일치, 다중 값 OR)
diskTag선택array (string)디스크 태그 필터 (전체 일치, 다중 값 OR)
bootable선택boolean 또는 null부팅 가능 여부 필터 (true/false)
encrypted선택boolean 또는 null암호화 여부 필터 (true/false)
origin선택string 또는 null인스턴스 origin 필터 (compute|container, 미전송 시 전체). 값: compute, container
size선택array (integer)볼륨 크기 필터 GiB 단위 (정확 일치, 다중 값 OR)
createdAtRange선택array (string)생성일 범위 필터 (반복 가능). 형식 'YYYY-MM-DD..YYYY-MM-DD', 여러 개 지정 시 OR 결합.
page선택integer페이지 번호 (0이면 전체 조회). 기본값 1. 범위 0~
pageSize선택integer페이지 크기. 기본값 10. 범위 1~

요청 헤더

인증 헤더와 조직·파티션 헤더는 모든 API 가 같습니다. 공통 규약을 참고하십시오.

응답

상태 코드설명
200 OKSuccessful Response
422 Unprocessable EntityValidation Error

위 표는 정상 응답과 요청 검증 실패만 나열합니다. 이 API 는 그 밖에 401(인증 실패) · 403(권한 없음) · 404(리소스 없음) · 502(인프라 오류)를 반환할 수 있습니다. 조건은 오류 처리를 참고하십시오.

응답 본문 — 200

이름필수형식설명
message선택string 또는 null응답 메시지
timestamp선택string응답 생성 시간
requestId필수string요청 식별자
result필수object데이터 목록 + 페이지네이션
result.data선택array (object)데이터 목록
result.data[].basicInfo필수object기본 정보
result.data[].basicInfo.volumeId선택string 또는 null볼륨 ID
result.data[].basicInfo.volumeName선택string 또는 null볼륨 이름
result.data[].basicInfo.status선택string 또는 null볼륨 상태
result.data[].basicInfo.size선택integer 또는 null볼륨 크기(GiB)
result.data[].basicInfo.createdAt선택string 또는 null생성 일시
result.data[].basicInfo.availabilityZone선택string 또는 null가용 영역
result.data[].basicInfo.description선택string 또는 null설명
result.data[].basicInfo.errorDetail선택string 또는 null에러 상세 정보
result.data[].attachmentInfo선택object 또는 null연결 정보
result.data[].attachmentInfo.instanceId선택string 또는 null인스턴스 ID
result.data[].attachmentInfo.instanceName선택string 또는 null인스턴스 이름
result.data[].specInfo필수object스펙 정보
result.data[].specInfo.volumeType선택string 또는 null볼륨 타입
result.data[].specInfo.bootable선택boolean부팅 가능 여부. 기본값 false
result.data[].specInfo.encrypted선택boolean암호화 여부. 기본값 false
result.data[].diskTag선택string디스크 태그. 기본값 "DATA_DISK"
result.data[].origin선택string리소스 origin. 기본값 "compute"
result.data[].originName선택string 또는 nullorigin 리소스 이름
result.data[].originId선택string 또는 nullorigin 리소스 ID
result.data[].snapshots선택array (object)이 볼륨이 보유한 스냅샷 목록
result.data[].snapshots[].volumeSnapshotId필수string볼륨 스냅샷 ID
result.data[].snapshots[].volumeSnapshotName선택string 또는 null볼륨 스냅샷 이름
result.data[].snapshots[].status선택string 또는 null볼륨 스냅샷 상태
result.data[].snapshots[].size선택integer 또는 null볼륨 스냅샷 크기(GiB)
result.data[].snapshots[].createdAt선택string 또는 null생성 일시
result.dataCount필수integer데이터 개수. 범위 0~
result.pagination필수object페이지네이션 정보
result.pagination.page필수integer현재 페이지 번호 (0=전체 조회). 범위 0~
result.pagination.pageSize필수integer페이지 크기. 범위 1~
result.pagination.totalCount필수integer전체 데이터 개수. 범위 0~
result.pagination.totalPages필수integer전체 페이지 개수. 범위 0~
result.pagination.hasNext필수boolean다음 페이지 존재 여부
result.pagination.hasPrev필수boolean이전 페이지 존재 여부

Thaki Cloud Aegis — 연동 개발자용 API 문서