getBlockStorageInstanceList

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

개요

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

요청

요청 파라미터

파라미터 명	필수 여부	타입	제약사항	설명
serverInstanceNo	No	String		- 서버인스턴스 번호 서버 인스턴스에 attach된 블록 스토리지 조회시 사용됨 serverInstanceNo는 getServerInstanceList 액션을 통해 획득 가능
blockStorageInstanceNoList.N	No	List<String>		- 블록 스토리지인스턴스 번호 리스트 블록 스토리지 인스턴스 번호 리스트에 해당하는 블록 스토리지 조회 ex) blockStorageInstanceNoList.1=1021004&blockStorageInstanceNoList.2=937508
searchFilterName	No	String		- 검색할 필터명 블록 스토리지명(blockStorageName)과 연결 정보(attachmentInformation)로 필터링하여 검색 가능 Options : blockStorageName \| attachmentInformation `[대소문자 구분 없음]` 연결 정보의 경우 블록 스토리지명`[공백]`연결 정보 또는 블록 스토리지명: 연결 정보 형식으로 입력되어야 함 입력 가능한 상태는 블록 스토리지 인스턴스 데이터 타입(BlockStorageInstance)의 디바이스 명(deviceName을) 값 참고 바람 searchFilterName은 아래의 searchFilterValue 값과 mapping하여 사용 ex) searchFilterName=blockStorageName&searchFilterValue=s1669aa4e78c ex) searchFilterName=attachmentInformation&searchFilterValue=s1669aa4e78c:/dev
searchFilterValue	No	String		- 검색할 필터값 위의 searchFilterName 값과 mapping할 값 입력
blockStorageTypeCodeList.N	No	List<String>	Min : 1, Max : 5	- 블록 스토리지 구분코드 리스트 블록 스토리지 구분 코드 리스트에 해당하는 블록 스토리지만 조회 가능 Options : BASIC (기본블록 스토리지) \| SVRBS (추가블록 스토리지) Default : BASIC ex) blockStorageTypeCodeList.1=SVRBS
blockStorageInstanceStatusCode	No	String	Min : 1, Max : 5	- 블록 스토리지 인스턴스 상태코드 블록 스토리지 인스턴스 상태별로 조회 가능 입력 가능한 상태는 블록 스토리지 인스턴스 데이터 타입(BlockStorageInstance)의 블록 스토리지 인스턴스 상태(blockStorageInstanceStatus) 값 참고 바람
diskTypeCode	No	String		- 디스크 유형 구분 코드 Options : NET (네트워크 스토리지) \| LOCAL (로컬스토리지)
diskDetailTypeCode	No	String		- 디스크 유형 상세 구분 코드 Optinos : HDD \| SSD
regionNo	No	String		- 리전 번호 블록 스토리지 인스턴스 리스트를 리전(Region)을 이용해 필터링 가능 regionNo는 getRegionList 액션을 통해 획득 가능
zoneNo	No	String		- ZONE 번호 블록 스토리지 인스턴스 리스트를 존(zone)을 이용해 필터링 가능 필터를 설정하지 않으면 해당 리전의 ZONE 모두가 선택됨
pageNo	No	Integer	Min : 0, Max : 2147483647	- 페이징 된 결과의 페이지 번호 결과값을 pageNo를 이용하여 페이징 처리 가능
pageSize	No	Integer	Min : 0, Max : 2147483647	- 페이징시 보여줄 각 페이지 사이즈 결과값을 pageSize를 이용하여 페이징 처리 가능
sortedBy	No	String		- 정렬 대상 블록 스토리지명과 블록 스토리지 인스턴스 번호로 정렬 가능 Options : blockStorageName (블록 스토리지명) \| blockStorageInstanceNo (블록 스토리지 인스턴스 번호) `[대소문자 구분 없음]` Default : blockStorageInstanceNo sortedBy는 아래의 sortingOrder와 mapping하여 사용함 ex) sortedBy=blockStorageName&sortingOrder=ascending ex) sortedBy=blockStorageInstanceNo&sortingOrder=descending
sortingOrder	No	String		- 정렬 순서 위에서 설정한 sortedBy의 오름차순/내림차순 정렬을 설정함 ascending (오름차순) \| descending (내림차순) `[대소문자 구분 없음]` default : ascending

응답

응답 바디

BlockStorageInstanceList

예시

요청 예시

GET {SERVER_API_URL}/getBlockStorageInstanceList
?searchFilterName=blockStorageName
&searchFilterValue=s1669aa4e78c

응답 예시

<getBlockStorageInstanceListResponse>
  <requestId>c8172d4a-5486-4d34-9331-dfec6a747abf</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>1021004</blockStorageInstanceNo>
      <serverInstanceNo>1021003</serverInstanceNo>
      <serverName>s1669aa4e78c</serverName>
      <blockStorageType>
        <code>BASIC</code>
        <codeName>Basic BS</codeName>
      </blockStorageType>
      <blockStorageName>s1669aa4e78c</blockStorageName>
      <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>2018-10-22T16:19:51+0900</createDate>
      <blockStorageInstanceDescription>s1669aa4e78c&apos;s basic storage</blockStorageInstanceDescription>
      <diskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </diskType>
      <diskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </diskDetailType>
      <maxIopsThroughput>4000</maxIopsThroughput>
      <zone>
        <zoneNo>3</zoneNo>
        <zoneName>KR-2</zoneName>
        <zoneCode>KR-2</zoneCode>
        <zoneDescription>평촌 zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>

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

What's Next

createBlockStorageInstance

개요
요청
응답
예시

태그