getBlockStorageInstanceList

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

개요

블록 스토리지 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

블록 스토리지 인스턴스 리스트 조회 시 요청 파라미터는 다음과 같습니다.

파라미터명	필수 여부	타입	설명
regionCode	No	String	리전 코드 블록 스토리지 인스턴스 리스트를 조회할 리전(Region)을 결정 가능 regionCode는 getRegionList 액션을 통해 획득 가능 Default: getRegionList 조회 결과의 첫 번째 리전을 선택
zoneCode	No	String	존 코드 블록 스토리지 인스턴스 리스트를 조회할 존(Zone) 결정 가능 zoneCode는 getZoneList 액션을 통해 획득 가능
blockStorageInstanceNoList.N	No	List<String>	블록 스토리지 인스턴스 번호 리스트 블록 스토리지 인스턴스 번호로 필터링하여 검색 가능 blockStorageInstanceNo는 getBlockStorageInstanceList 액션을 통해 획득 가능 <예시> blockStorageInstanceNoList 1234 2345
blockStorageInstanceStatusCode	No	String	블록 스토리지 인스턴스 상태 코드 블록 스토리지 인스턴스 상태 코드로 필터링하여 검색 가능 Options: INIT \| CREAT \| ATTAC
blockStorageDiskTypeCode	No	String	블록 스토리지 디스크 유형 코드 블록 스토리지 디스크 유형으로 필터링하여 검색 가능 Options: NET
blockStorageDiskDetailTypeCode	No	String	블록 스토리지 디스크 상세 유형 코드 블록 스토리지 디스크 상세 유형으로 필터링하여 검색 가능 Options: HDD \| SSD
blockStorageSize	No	Integer	블록 스토리지 사이즈 입력한 GB 단위 사이즈 이하의 블록 스토리지를 필터링하여 검색 가능
blockStorageTypeCodeList.N	No	List<String>	블록 스토리지 유형 코드 리스트 블록 스토리지 유형으로 필터링하여 검색 가능 Options BASIC (서버 인스턴스의 기본 블록 스토리지) SVRBS (서버 인스턴스의 추가 블록 스토리지) <예시> blockStorageTypeCodeList BASIC SVRBS
serverInstanceNo	No	String	서버 인스턴스 번호 블록 스토리지가 할당된 서버 인스턴스 번호로 필터링하여 검색 가능 serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능
blockStorageName	No	String	블록 스토리지 이름 블록 스토리지 이름으로 필터링하여 검색 가능 blockStorageName, serverName, connectionInfo 중 하나의 검색 조건만 사용 가능
serverName	No	String	서버 이름 블록 스토리지가 할당된 서버 이름으로 필터링하여 검색 가능 blockStorageName, serverName, connectionInfo 중 하나의 검색 조건만 사용 가능
connectionInfo	No	String	연결 정보 블록 스토리지가 할당된 서버와 디바이스 연결 정보로 필터링하여 검색 가능 다음 두 가지 형태로 사용 가능 Options '서버이름[공백]디바이스이름' (s173dc67dc2e /dev/xvda) '서버이름:디바이스이름' (s173dc67dc2e:/dev/xvda) blockStorageName, serverName, connectionInfo 중 하나의 검색 조건만 사용 가능
pageNo	No	Integer	페이징된 결과의 페이지 번호 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize	Conditional	Integer	페이징 시 보여줄 각 페이지 사이즈 결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능 pageNo 입력 시 반드시 입력
output	No	String	응답 결과의 포맷 타입 Options: xml \| json Default: json

응답

응답 데이터 타입

BlockStorageInstanceList의 응답 데이터 타입은 다음과 같습니다.

BlockStorageInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageInstance> blockStorageInstanceList = new ArrayList<>();

BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String blockStorageName;
private CommonCode blockStorageType;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageDescription;
private CommonCode blockStorageDiskType;
private CommonCode blockStorageDiskDetailType;
private Integer maxIopsThroughput;
private Boolean isEncryptedVolume;
private String zoneCode;
private String regionCode;
private Boolean isReturnProtection;
private List<String> eventList;

예시

요청 예시

ncloud vserver getBlockStorageInstanceList --regionCode KR --zoneCode KR-1 --blockStorageInstanceNoList ***7746 --blockStorageInstanceStatusCode ATTAC --blockStorageDiskTypeCode NET --blockStorageDiskDetailTypeCode SSD --blockStorageSize 50 --blockStorageTypeCodeList BASIC --serverInstanceNo ***4299 --connectionInfo test-***:/dev/xvda

응답 예시

<getBlockStorageInstanceListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>***7746</blockStorageInstanceNo>
      <serverInstanceNo>***4299</serverInstanceNo>
      <blockStorageName>test-***</blockStorageName>
      <blockStorageType>
        <code>BASIC</code>
        <codeName>Basic BS</codeName>
      </blockStorageType>
      <blockStorageSize>53687091200</blockStorageSize>
      <deviceName>/dev/xvda</deviceName>
      <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
      <blockStorageInstanceStatus>
        <code>ATTAC</code>
        <codeName>Block storage ATTACHED state</codeName>
      </blockStorageInstanceStatus>
      <blockStorageInstanceOperation>
        <code>NULL</code>
        <codeName>Block Storage NULLOP</codeName>
      </blockStorageInstanceOperation>
      <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
      <createDate>2020-08-19T15:05:07+0900</createDate>
      <blockStorageDescription>test-***'s basic storage</blockStorageDescription>
      <blockStorageDiskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </blockStorageDiskType>
      <blockStorageDiskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </blockStorageDiskDetailType>
      <maxIopsThroughput>4000</maxIopsThroughput>
      <isEncryptedVolume>false</isEncryptedVolume>
      <zoneCode>KR-1</zoneCode>
      <regionCode>KR</regionCode>
      <isReturnProtection>false</isReturnProtection>
      <eventList>
        <event>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</event>
      </eventList>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

Documentation Index

getBlockStorageInstanceList

개요

요청

요청 파라미터

응답

응답 데이터 타입

예시

요청 예시

응답 예시