getBlockStorageInstanceList

Prev Next

Overview

Get the list of block storage instances.

Request

Request parameters

Parameter name Required Type Restrictions Description
serverInstanceNo No String - Server instance number
It is used to query the block storage attached to the server instance.
serverInstanceNo can be obtained through the getServerInstanceList action.
blockStorageInstanceNoList.N No List<String> - Block storage instance number list
Block storage can be queried for the block storage instance number list.
e.g., blockStorageInstanceNoList.1=1021004&blockStorageInstanceNoList.2=937508
searchFilterName No String - Name of filter to search
You can search by filtering by block storage name (blockStorageName) and attachment information (attachmentInformation).
Options: blockStorageName | attachmentInformation [case-insensitive]
For attachment information, enter block storage name[space]attachment information or in the format of block storage name: attachment information.
For the available status, see the device name (deviceName) value of the block storage instance data type (BlockStorageInstance).
searchFilterName is used by mapping with the searchFilterValue value shown below.
e.g., searchFilterName=blockStorageName&searchFilterValue=s1669aa4e78c
e.g., searchFilterName=attachmentInformation&searchFilterValue=s1669aa4e78c:/dev
searchFilterValue No String - Filter value to search for
Enter the value to be mapped to the searchFilterName value shown above.
blockStorageTypeCodeList.N No List<String> Min: 1,
Max: 5		 - Block storage classification code list
Only block storage corresponding to the block storage classification code list can be queried.
Options: BASIC (basic block storage) | SVRBS (additional block storage)
Default: BASIC
e.g., blockStorageTypeCodeList.1=SVRBS
blockStorageInstanceStatusCode No String Min: 1,
Max: 5		 - Block storage instance status code
You can query by block storage instance status.
For the status where input is possible, see the blockStorageInstanceStatus value of the blockStorageInstance data type.
diskTypeCode No String - Disk type classification code
Options: NET (network storage) | LOCAL (local storage)
diskDetailTypeCode No String - Disc type detailed classification code
Optinos : HDD | SSD
regionNo No String - Region number
You can filter the list of block storage instances by Region.
regionNo can be obtained through the getRegionList action.
zoneNo No String - Zone number
The list of block storage instances can be filtered using zones.
If no filter is set, all zones in the Region are selected.
pageNo No Integer Min: 0,
Max: 2147483647		 - Page number of the paged results
The results can be paged using pageNo.
pageSize No Integer Min: 0,
Max: 2147483647		 - Size of each page to be displayed when paging
The results can be paged using pageSize.
sortedBy No String - Sorted by
It can be sorted by block storage name and block storage instance number.
Options: blockStorageName (block storage name) | blockStorageInstanceNo (block storage instance number) [case-insensitive]
Default: blockStorageInstanceNo
sortedBy is used in combination with the sortingOrder shown below.
e.g., sortedBy=blockStorageName&sortingOrder=ascending
e.g., sortedBy=blockStorageInstanceNo&sortingOrder=descending
sortingOrder No String - Sorting order
Set the ascending/descending sort order of sortedBy set above.
ascending | descending [case-insensitive]
Default: ascending
responseFormatType No String - Format type of the response result
Options: xml | json
Default: xml

Response

Response body

Examples

Request example

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

Response example

<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>Pyeongchon zone</zoneDescription>
        <regionNo>1</regionNo>
      </zone>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>