getBlockStorageInstanceList
- Print
- PDF
getBlockStorageInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Overview
Views the instance list of the Block Storage.
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code It can determine the Region for which the Block Storage instance list is to be viewed regionCode can be acquired through getRegionList action Default : Choose the first region shown through getRegionList | |
| zoneCode | No | String | - ZONE code It can determine the zone for which the Block Storage instance list is to be viewed zoneCode can be obtained through getZoneList action | |
| blockStorageInstanceNoList.N | No | List<String> | - List of Block Storage instance numbers Filters query by setting an instance number blockStorageInstanceNo can be obtained through getBlockStorageInstanceList action e.g., blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=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 | - Block storage disk type code You can search by filtering with a block storage disk type. Options : NET | |
| blockStorageDiskDetailTypeCode | No | String | - Detailed type code of block storage disk You can search by filtering with the detailed type of block storage disk. Options : HDD | SSD | |
| blockStorageSize | No | Integer | - Block storage size You can search by filtering the block storage that is less than the inputted GB unit size. | |
| blockStorageTypeCodeList.N | No | List<String> | - List of the block storage type code You can search by filtering with a block storage type. Options : BASIC (basic Block Storage of the server instance) | SVRBS (additional Block Storage of the server instance) ex) blockStorageTypeCodeList.1=BASIC&blockStorageTypeCodeList.2=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 acquired through getServerInstanceList action | |
| blockStorageName | No | String | - Block storage name You can search by filtering with 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 interface is assigned. 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 server in which a block storage is assigned and device connection information. 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.N | No | List<String> | - List of the block storage type code You can search by filtering with a block storage volume type code. Options : HDD | SSD | FB1 | CB1 ex) blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCode.2=CB1 | |
| hypervisorTypeCodeList.N | No | List<String> | - List of hypervisor type codes You can search by filtering with a hypervisor type code. Options : XEN | KVM ex) hypervisorTypeCodeList.1=XEN | |
| pageNo | No | Integer | - Page number of paged result The results can be paged using pageNo and pageSize | |
| pageSize | Conditional | Integer | - Size of each page to be shown during paging The results can be paged using pageNo and pageSize Must be entered when entering pageNo | |
| responseFormatType | No | String | - Format type of responses Options : xml | json Default : xml |
Responses
Response bodies
Examples
Request Examples
GET {API_URL}/getBlockStorageInstanceList
?regionCode=KR
&zoneCode=KR-1
&blockStorageInstanceNoList.1=***7746
&blockStorageInstanceStatusCode=ATTAC
&blockStorageDiskTypeCode=NET
&blockStorageDiskDetailTypeCode=SSD
&blockStorageSize=50
&blockStorageTypeCodeList.1=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>SSD</code>
<codeName>SSD</codeName>
</blockStorageVolumeType>
<hypervisorType>
<code>XEN</code>
<codeName>XEN</codeName>
</hypervisorType>
</blockStorageInstance>
</blockStorageInstanceList>
</getBlockStorageInstanceListResponse>
Was this article helpful?