getBlockStorageSnapshotInstanceList
- Print
- PDF
getBlockStorageSnapshotInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Overview
It searches a list of block storage snapshot instances.
Requests
Request Parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code You can decide the region in which the list of block storage snapshot instance will be queried. regionCode can be acquired through getRegionList action Default : Choose the first region shown through getRegionList | |
| blockStorageSnapshotInstanceNoList.N | No | List<String> | - List of the block storage snapshot instances numbers You can search by filtering with a block storage snapshot instance number. blockStorageSnapshotInstanceNo can be obtained through getBlockStorageSnapshotInstanceList action ex) blockStorageSnapshotInstanceNoList.1=1234&blockStorageSnapshotInstanceNoList.2=2345 | |
| blockStorageSnapshotName | No | String | - Block storage snapshot name Filters query by block storage snapshot name. | |
| blockStorageSnapshotInstanceStatusCode | No | String | - Status code of block storage snapshot instance Filters query by block storage snapshot instance status code. Options : INIT | CREAT | |
| originalBlockStorageInstanceNoList.N | No | List<String> | - List of the source block storage instance numbers You can search by filtering with a source block storage instance number. originalBlockStorageInstanceNo can be obtained through getBlockStorageInstanceList action ex) originalBlockStorageInstanceNoList.1=1234&originalBlockStorageInstanceNoList.2=2345 | |
| blockStorageSnapshotVolumeSize | No | Integer | - Block storage snapshot volume size You can search by filtering the block storage snapshot that is less than the inputted GB unit. | |
| isEncryptedOriginalBlockStorageVolume | No | Boolean | - Encryption status of the source block storage volume You can search by filtering with the encryption status of original block storage. Options : true | false | |
| 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=KVM | |
| isBootable | No | Boolean | - Whether an image for my server can be generated Filters query based on whether an image for my server can be created Options : true | false | |
| 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 | |
| sortedBy | No | String | - Items subject to sorting The results can be sorted with a block storage snapshot name. Options : blockStorageSnapshotName | |
| sortingOrder | No | String | - Sorting order When using sortedBy, set ascending/descending order Options : ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | - Format type of responses Options : xml | json Default : xml |
Responses
Response bodies
Examples
Request Examples
GET {API_URL}/getBlockStorageSnapshotInstanceList
?regionCode=KR
&blockStorageSnapshotInstanceNoList.1=***1951
&blockStorageSnapshotName=test-***
&blockStorageSnapshotInstanceStatusCode=CREAT
&originalBlockStorageInstanceNoList.1=***7746
&blockStorageSnapshotVolumeSize=50
&isEncryptedOriginalBlockStorageVolume=false
&hypervisorTypeCodeList.1=KVM
&isBootable=true
Response examples
<getBlockStorageSnapshotInstanceListResponse>
<requestId>08cacedf-cfd7-4a8d-a495-89aa0d72f7ca</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<blockStorageSnapshotInstanceList>
<blockStorageSnapshotInstance>
<blockStorageSnapshotInstanceNo>***1951</blockStorageSnapshotInstanceNo>
<blockStorageSnapshotName>test-***</blockStorageSnapshotName>
<blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
<originalBlockStorageInstanceNo>***7746</originalBlockStorageInstanceNo>
<blockStorageSnapshotInstanceStatus>
<code>CREAT</code>
<codeName>Block storage CREATED state</codeName>
</blockStorageSnapshotInstanceStatus>
<blockStorageSnapshotInstanceOperation>
<code>NULL</code>
<codeName>Block Storage NULLOP</codeName>
</blockStorageSnapshotInstanceOperation>
<blockStorageSnapshotInstanceStatusName>created</blockStorageSnapshotInstanceStatusName>
<createDate>2020-08-25T10:18:15+0900</createDate>
<isEncryptedOriginalBlockStorageVolume>false</isEncryptedOriginalBlockStorageVolume>
<blockStorageSnapshotDescription></blockStorageSnapshotDescription>
<snapshotType>
<code>FULL</code>
<codeName>Full Storage Snapshot</codeName>
</snapshotType>
<baseSnapshotInstanceNo/>
<snapshotChainDepth>0</snapshotChainDepth>
<isBootable>true</isBootable>
<hypervisorType>
<code>KVM</code>
<codeName>KVM</codeName>
</hypervisorType>
</blockStorageSnapshotInstance>
</blockStorageSnapshotInstanceList>
</getBlockStorageSnapshotInstanceListResponse>
Was this article helpful?