getBlockStorageInstanceList

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

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

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

요청

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

메서드	URI
GET, POST	/getBlockStorageInstanceList

요청 쿼리 파라미터

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

응답

응답 바디

BlockStorageInstanceList

예시

요청 예시

GET {API_URL}/getBlockStorageInstanceList
?regionCode=KR
&zoneCode=KR-1
&blockStorageInstanceNoList.1=***7746
&blockStorageInstanceStatusCode=ATTAC
&blockStorageDiskTypeCode=NET
&blockStorageDiskDetailTypeCode=SSD
&blockStorageSize=50
&blockStorageTypeCodeList.1=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>
      <blockStorageVolumeType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </blockStorageVolumeType>
      <hypervisorType>
        <code>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

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

What's Next

getBlockStorageInstanceDetail

요청
응답
예시

태그