Available in VPC
Overview
Get the list of block storage instances.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - | - Region code Determine the Region from which the list of block storage instances will be queried. regionCode can be obtained through the getRegionList action. Default: Select the first Region of the getRegionList search results. |
| zoneCode | No | String | - | - Zone code Determine the zone from which the list of block storage instances will be queried. zoneCode can be obtained through the getZoneList action. |
| blockStorageInstanceNoList | No | List<String> | - | - List of the block storage instance numbers Search by filtering with block storage instance number. blockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action. e.g., --blockStorageInstanceNoList 1234 2345 |
| blockStorageInstanceStatusCode | No | String | - | - Block storage instance status code Search by filtering with block storage instance status code. Options: INIT | CREAT | ATTAC |
| blockStorageDiskTypeCode | No | String | - | - Block storage disk type code Search by filtering with block storage disk type. Options: NET |
| blockStorageDiskDetailTypeCode | No | String | - | - Detailed type code of block storage disk Search by filtering with block storage disk detailed type. Options: HDD | SSD |
| blockStorageSize | No | Integer | - | - Block storage size Search by filtering block storage that are smaller than or equal to the entered GB size. |
| blockStorageTypeCodeList | No | List<String> | - | - List of the block storage type code Search by filtering with block storage type. Options: BASIC (basic block storage of the server instance) | SVRBS (additional block storage of the server instance) e.g, --blockStorageTypeCodeList BASIC SVRBS |
| serverInstanceNo | No | String | - | - Server instance number Search by filtering with the server instance number in which a block storage is assigned. serverInstanceNo can be obtained through the getServerInstanceList action. |
| blockStorageName | No | String | - | - Block storage name Search by filtering with block storage name. You can use only one of the search criteria among blockStorageName, serverName, and connectionInfo. |
| serverName | No | String | - | - Server name Search by filtering with the server instance name in which a block storage is assigned. You can use only one of the search criteria among blockStorageName, serverName, and connectionInfo. |
| connectionInfo | No | String | - | - Connection information Search by filtering with the server in which a block storage is assigned and device connection information. Available in the following two formats Options: 'Server name [blank] device name' (s173dc67dc2e /dev/xvda) | 'Server name: device name' (s173dc67dc2e:/dev/xvda) You can use only one of the search criteria among blockStorageName, serverName, and connectionInfo. |
| blockStorageVolumeTypeCodeList | No | List<String> | - | - Block storage volume type code list Search by filtering with block storage volume type. Options: SSD | HDD | FB1 | CB1 e.g., --blockStorageVolumeTypeCodeList HDD SSD |
| hypervisorTypeCodeList | No | List<String> | - | - Hypervisor type code list Search by filtering with hypervisor type. Options: XEN | KVM e.g., --hypervisorTypeCodeList KVM XEN |
| pageNo | No | Integer | - | - Page number of the paged results The results can be paged using pageNo and pageSize. |
| pageSize | Conditional | Integer | - | - Size of each page to be displayed when paging The results can be paged using pageNo and pageSize. Entering this information is required when pageNo is entered. |
| output | No | String | - | - Format type of the response result Options: xml | json Default: json |
Response
Response data type
- BlockStorageInstanceList type
| 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; |
| private List<String> eventList; |
Examples
Request example
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 example
<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>
<eventList>
<event>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</event>
</eventList>
</blockStorageInstance>
</blockStorageInstanceList>
</getBlockStorageInstanceListResponse>