getBlockStorageInstanceList

Prev Next

Available in VPC

Overview

Views the list of block storage instances.

Requests

Request parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String - - Region code
Decides the Region for which the block storage instance list is to be viewed
regionCode can be obtained through the getRegionList action
Default: select the first Region shown in the getRegionList search results
zoneCode No String - - ZONE code
Decides the zone for which the block storage instance list is to be viewed
zoneCode can be obtained through the getZoneList action
blockStorageInstanceNoList No List<String> - - List of block storage instance numbers
You can search by filtering with the block storage instance number
blockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action
ex) --blockStorageInstanceNoList 1234 2345
blockStorageInstanceStatusCode No String - - Block storage instance status code
You can search by filtering with a block storage instance status code
Options : INIT | CREAT | ATTAC
blockStorageDiskTypeCode No String - - Type code of block storage disk
You can search by filtering with the block storage disk type
Options : NET
blockStorageDiskDetailTypeCode No String - - Detailed type code of the block storage disk
You can search by filtering with the detailed block storage disk type
Options : HDD | SSD
blockStorageSize No Integer - - Block storage size
Block storages of sizes equal or less than the GB-level size entered can be filtered and searched
blockStorageTypeCodeList No List<String> - - List of block storage type codes
You can search by filtering with the block storage type
Options: BASIC (basic block storage of the server instance) | SVRBS (additional block storage of the server instance)
ex) --blockStorageTypeCodeList BASIC SVRBS
serverInstanceNo No String - - Server instance number
You can search by filtering with the server instance number to which the block storage is allocated
serverInstanceNo can be obtained through the getServerInstanceList action
blockStorageName No String - - Name of block storage
You can search by filtering with the block storage name
Only one of blockStorageName, serverName and connectionInfo can be used as a search condition
serverName No String - - Server name
You can search by filtering with the server name to which the block storage is allocated
Only one of blockStorageName, serverName and connectionInfo can be used as a search condition
connectionInfo No String - - Connection information
You can search by filtering with the information on connection between the server to which the block storage is allocated and the devices
Can be used in the following two ways
Options: 'server name[empty space]device name' (s173dc67dc2e /dev/xvda) | 'server name:device name' (s173dc67dc2e:/dev/xvda)
Only one of blockStorageName, serverName and connectionInfo can be used as a search condition
blockStorageVolumeTypeCodeList No List<String> - - List of block storage volume type codes
You can search by filtering with the block storage volume type
Options : SSD | HDD | FB1 | CB1
ex) --blockStorageVolumeTypeCodeList HDD SSD
hypervisorTypeCodeList No List<String> - - List of hypervisor type codes
You can search by filtering by hypervisor type
Options : XEN | KVM
ex) --hypervisorTypeCodeList KVM XEN
pageNo No Integer - - Page number of paged result
The results can be paged using page No. and page size
pageSize Conditional Integer - - Size of each page to be shown during paging
The results can be paged using page No. and page size
Must be entered when entering pageNo
responseFormatType No String - - Format type of responses
Options : xml | json
Default : xml

Responses

Response data type

  • Type of BlockStorageInstanceList
BlockStorageInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageInstance> blockStorageInstanceList = new ArrayList<>();
BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String blockStorageName;
private CommonCode blockStorageType;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageDescription;
private CommonCode blockStorageDiskType;
private CommonCode blockStorageDiskDetailType;
private Integer maxIopsThroughput;
private Boolean isEncryptedVolume;
private String zoneCode;
private String regionCode;
private Boolean isReturnProtection;
private CommonCode blockStorageVolumeType;
private CommonCode hypervisorType;
private Long throughput;
private Long iops;
private Long blockStorageSnapshotInstanceNo;

Examples

Request examples

ncloud vserver getBlockStorageInstanceList --regionCode KR --zoneCode KR-1 --blockStorageInstanceNoList ***7746 --blockStorageInstanceStatusCode ATTAC --blockStorageDiskTypeCode NET --blockStorageDiskDetailTypeCode SSD --blockStorageSize 50 --blockStorageTypeCodeList BASIC --serverInstanceNo ***4299 --connectionInfo test-***:/dev/xvda

Response examples

<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>CB1</code>
        <codeName>Common BlockStorage 1</codeName>
      </blockStorageVolumeType>
      <hypervisorType>
        <code>KVM</code>
        <codeName>KVM</codeName>
      </hypervisorType>
      <throughput>10000</throughput>
      <iops>1000</iops>
      <blockStorageSnapshotInstnaceNo>1002120</blockStorageSnapshotInstnaceNo>
    </blockStorageInstance>
  </blockStorageInstanceList>
</getBlockStorageInstanceListResponse>