getBlockStorageInstanceList
    • PDF

    getBlockStorageInstanceList

    • PDF

    기사 요약

    개요

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

    요청

    요청 파라미터

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

    응답

    응답 바디

    예시

    요청 예시

    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>
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.