getBlockStorageInstanceList

개요

블록 스토리지 인스턴스 리스트 조회

설명

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

요청 파라미터

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

응답 데이터 타입

BlockStorageInstanceList 타입

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

BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String serverName;
private CommonCode blockStorageType;
private String blockStorageName;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageInstanceDescription;
private CommonCode diskTypeCode;
private CommonCode diskType;
private CommonCode diskDetailType;
private Integer maxIopsThroughput;
private Region region;
private Zone zone;

예시

호출

ncloud server getBlockStorageInstanceList --diskTypeCode NET --diskDetailTypeCode SSD --blockStorageTypeCodeList BASIC --pageSize 2 --pageNo 1

응답

{
  "getBlockStorageInstanceListResponse": {
    "requestId": "28e08ca2-a988-4856-800f-daff05999ff1",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 56,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "324388",
        "serverInstanceNo": "324387",
        "serverName": "eco-test-2",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Basic BS"
        },
        "blockStorageName": "eco-test-2",
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED state"
        },
        "blockStorageInstanceOperation": {
          "code": "TERMT",
          "codeName": "Block Storage TERMINATE OP"
        },
        "blockStorageInstanceStatusName": "terminating",
        "createDate": "2017-05-19T11:04:03+0900",
        "blockStorageInstanceDescription": "compact-ssd\u0027s basic storage",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "diskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        }
      },
      {
        "blockStorageInstanceNo": "342436",
        "serverInstanceNo": "342435",
        "serverName": "x0811",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Basic BS"
        },
        "blockStorageName": "x0811",
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED state"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block Storage NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2017-08-11T15:44:28+0900",
        "blockStorageInstanceDescription": "x0811\u0027s basic storage",
        "diskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "diskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 4000,
        "zone": {
          "zoneNo": "2",
          "zoneName": "KR-1",
          "zoneCode": "KR-1",
          "zoneDescription": "KR-1 zone",
          "regionNo": "1"
        }
      }
    ]
  }
}

<?xml version="1.0" encoding="UTF-8" ?>
<getBlockStorageInstanceListResponse>
  <requestId>28e08ca2-a988-4856-800f-daff05999ff1</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>56</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstanceNo>324388</blockStorageInstanceNo>
    <serverInstanceNo>324387</serverInstanceNo>
    <serverName>eco-test-2</serverName>
    <blockStorageType>
      <code>BASIC</code>
      <codeName>Basic BS</codeName>
    </blockStorageType>
    <blockStorageName>eco-test-2</blockStorageName>
    <blockStorageSize>53687091200</blockStorageSize>
    <deviceName>/dev/xvda</deviceName>
    <blockStorageProductCode>SPBSTBSTBS000005</blockStorageProductCode>
    <blockStorageInstanceStatus>
      <code>ATTAC</code>
      <codeName>Block storage ATTACHED state</codeName>
    </blockStorageInstanceStatus>
    <blockStorageInstanceOperation>
      <code>TERMT</code>
      <codeName>Block Storage TERMINATE OP</codeName>
    </blockStorageInstanceOperation>
    <blockStorageInstanceStatusName>terminating</blockStorageInstanceStatusName>
    <createDate>2017-05-19T11:04:03+0900</createDate>
    <blockStorageInstanceDescription>compact-ssd&#x27;s basic storage</blockStorageInstanceDescription>
    <diskType>
      <code>NET</code>
      <codeName>Network Storage</codeName>
    </diskType>
    <diskDetailType>
      <code>SSD</code>
      <codeName>SSD</codeName>
    </diskDetailType>
    <zone>
      <zoneNo>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
  </blockStorageInstanceList>
  <blockStorageInstanceList>
    <blockStorageInstanceNo>342436</blockStorageInstanceNo>
    <serverInstanceNo>342435</serverInstanceNo>
    <serverName>x0811</serverName>
    <blockStorageType>
      <code>BASIC</code>
      <codeName>Basic BS</codeName>
    </blockStorageType>
    <blockStorageName>x0811</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 NULL OP</codeName>
    </blockStorageInstanceOperation>
    <blockStorageInstanceStatusName>attached</blockStorageInstanceStatusName>
    <createDate>2017-08-11T15:44:28+0900</createDate>
    <blockStorageInstanceDescription>x0811&#x27;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>2</zoneNo>
      <zoneName>KR-1</zoneName>
      <zoneCode>KR-1</zoneCode>
      <zoneDescription>KR-1 zone</zoneDescription>
      <regionNo>1</regionNo>
    </zone>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>